Get an AI Gateway
Returns the details of a specific AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
A successful response returning an AI Gateway.
AIGateway
The name of the AI Gateway.
Example:My AI Gateway
The description of the AI Gateway.
Example:An AI Gateway for my organization.
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Object containing AI Gateway access endpoints.
Show Child Parameters
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.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update an AI Gateway
Updates the configuration of an existing AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
UpdateAIGatewayRequest
The name of the AI Gateway.
Example:My AI Gateway
The description of the AI Gateway.
Example:An AI Gateway for my organization.
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"}
Response
application/json
Response
AI Gateway updated successfully.
AIGateway
The name of the AI Gateway.
Example:My AI Gateway
The description of the AI Gateway.
Example:An AI Gateway for my organization.
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Object containing AI Gateway access endpoints.
Show Child Parameters
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.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete an AI Gateway
Deletes an existing AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
Response
AI Gateway deleted successfully.
Authentication
Path Parameters
AI Gateway DataPlane Certificates
API related to the management of AI Gateway DataPlane Certificates.
List AI Gateway DataPlane Certificates
Returns a list of DataPlane certificates that are associated to this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
Example response
Show Child Parameters
Pagination metadata.