AI Gateway Consumers
Individual consumers with credentials and group memberships for AI Gateway access control.
List AI Gateway Consumers
Returns a list of all consumers for the 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
A paginated list of AI Gateway Consumers.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create an AI Gateway Consumer
Creates a new consumer for the AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
CreateAIGatewayConsumerRequest
The display name for this consumer instance.
Example:Greg's Dev Key
A user-defined unique identifier for this consumer, used as a stable human-readable reference.
Example:gregs-dev-key
The type of the consumer.
Allowed values:apikeyoauth
Lightweight object used to reference a consumer group, identified by its ref.
Show Child Parameters
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Configuration for the consumer.
Show Child Parameters
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"}
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"}
Response
application/json
Response
AI Gateway Consumer created successfully.
AIGatewayConsumer
The display name for this consumer instance.
Example:Greg's Dev Key
A user-defined unique identifier for this consumer, used as a stable human-readable reference.
Example:gregs-dev-key
The type of the consumer.
Allowed values:apikeyoauth
Lightweight object used to reference a consumer group, identified by its ref.
Show Child Parameters
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Configuration for the consumer.
Show Child Parameters
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"}
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
Get an AI Gateway Consumer
Returns the details of a specific AI Gateway consumer.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
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 Consumer.
AIGatewayConsumer
The display name for this consumer instance.
Example:Greg's Dev Key
A user-defined unique identifier for this consumer, used as a stable human-readable reference.
Example:gregs-dev-key
The type of the consumer.
Allowed values:apikeyoauth
Lightweight object used to reference a consumer group, identified by its ref.
Show Child Parameters
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Configuration for the consumer.
Show Child Parameters
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"}
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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 Consumer
Updates the configuration of an existing AI Gateway consumer.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
UpdateAIGatewayConsumerRequest
The display name for this consumer instance.
Example:Greg's Dev Key
A user-defined unique identifier for this consumer, used as a stable human-readable reference.
Example:gregs-dev-key
The type of the consumer.
Allowed values:apikeyoauth
Lightweight object used to reference a consumer group, identified by its ref.
Show Child Parameters
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Configuration for the consumer.
Show Child Parameters
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"}
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"}
Response
application/json
Response
Consumer updated successfully.
AIGatewayConsumer
The display name for this consumer instance.
Example:Greg's Dev Key
A user-defined unique identifier for this consumer, used as a stable human-readable reference.
Example:gregs-dev-key
The type of the consumer.
Allowed values:apikeyoauth
Lightweight object used to reference a consumer group, identified by its ref.
Show Child Parameters
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Configuration for the consumer.
Show Child Parameters
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"}
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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