0.0.0OAS 3.0

Internal API for managing Kong AI Gateway policies.

API Base URL
  • Server 1:https://us.api.konghq.com/v1

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v1

    Europe Production region

  • Server 3:https://au.api.konghq.com/v1

    Australia Production region

  • Server 4:https://me.api.konghq.com/v1

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v1

    India Production region

  • Server 6:https://sg.api.konghq.com/v1

    Singapore Production region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

Additional Information
Contact Kong

AI Gateways

API related to the management of Konnect AI Gateway resources.

List AI Gateways

Returns a list of AI Gateways in the organization.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list of AI Gateways.

ListAIGatewaysResponse

* Additional properties are NOT allowed.
dataarray[object]required
* Additional properties are allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/ai-gateways
 
application/json

Create an AI Gateway

Creates a new AI Gateway in the organization.

post

Body

application/json

CreateAIGatewayRequest

* 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"}

Response

application/json

AI Gateway created successfully.

AIGateway

* 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

post/ai-gateways

Body

{ "name": "My AI Gateway", "description": "An AI Gateway for my organization.", "labels": { "env": "production" } }
 
application/json

Get an AI Gateway

Returns the details of a specific AI Gateway.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

A successful response returning an AI Gateway.

AIGateway

* 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

get/ai-gateways/{gatewayId}
 
application/json