Update an AI Gateway Provider

Updates the configuration of an existing AI Gateway provider.

put

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

providerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Body

application/json

UpdateAIGatewayProviderRequest

UpdateAIGatewayProviderRequest
One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

A user-defined unique identifier for this provider instance, used as a stable human-readable reference.

Example:azure-ai-se

labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

managed_byobject | null

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Provider updated successfully.

AIGatewayProvider

One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

A user-defined unique identifier for this provider instance, used as a stable human-readable reference.

Example:azure-ai-se

labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

managed_byobject | null

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters
put/ai-gateways/{gatewayId}/providers/{providerId}

Body

{}
 
application/json

Delete an AI Gateway Provider

Removes a specific AI Gateway provider.

delete

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

providerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

Provider deleted successfully.

delete/ai-gateways/{gatewayId}/providers/{providerId}
 

CreateAIGatewayRequest

object
* Additional properties are allowed.
namestringrequired

The name of the AI Gateway.

Example:My AI Gateway

descriptionstring

The description of the AI Gateway.

Example:An AI Gateway for my organization.

labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

Example

UpdateAIGatewayRequest

object
* Additional properties are allowed.
namestringrequired

The name of the AI Gateway.

Example:My AI Gateway

descriptionstring

The description of the AI Gateway.

Example:An AI Gateway for my organization.

labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

Example

AIGateway

object
* Additional properties are allowed.
namestringrequired

The name of the AI Gateway.

Example:My AI Gateway

descriptionstring

The description of the AI Gateway.

Example:An AI Gateway for my organization.

labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

endpointsobjectrequired

Object containing AI Gateway access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
config_hashstringrequiredread-only

The hash of the latest configuration for the gateway. Every change to an entity
under this gateway will result in a new config_hash being generated.
The config hash can be used to verify if the config hash of an AI Gateway
node is up to date with the AI Gateway. The config hash will be the same if they are in sync.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example