List AI Gateway Consumers

Returns a list of all consumers for the AI Gateway.

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

A paginated list of AI Gateway Consumers.

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

Pagination metadata.

Show Child Parameters
get/ai-gateways/{gatewayId}/consumers
 
application/json

Create an AI Gateway Consumer

Creates a new consumer for the AI Gateway.

post

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

CreateAIGatewayConsumerRequest

* Additional properties are allowed.
display_namestringrequired

The display name for this consumer instance.

Example:Greg's Dev Key

refstringrequired

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

Example:gregs-dev-key

typestringrequired

The type of the consumer.

Allowed values:apikeyoauth

consumer_groupsarray[object]required

Lightweight object used to reference a consumer group, identified by its ref.

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

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the consumer.

* Additional properties are NOT allowed.
Show Child Parameters
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"}

Response

application/json

AI Gateway Consumer created successfully.

AIGatewayConsumer

* Additional properties are allowed.
display_namestringrequired

The display name for this consumer instance.

Example:Greg's Dev Key

refstringrequired

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

Example:gregs-dev-key

typestringrequired

The type of the consumer.

Allowed values:apikeyoauth

consumer_groupsarray[object]required

Lightweight object used to reference a consumer group, identified by its ref.

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

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the consumer.

* Additional properties are NOT allowed.
Show Child Parameters
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"}

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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/{gatewayId}/consumers

Body

{ "display_name": "Greg's Dev Key", "ref": "gregs-dev-key", "type": "apikey", "consumer_groups": [ { "ref": "dev-users" } ], "policies": [ { "ref": "ai-pii-sanitizer-1234" } ], "config": {} }
 
application/json

Get an AI Gateway Consumer

Returns the details of a specific AI Gateway consumer.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

consumerIdstring(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 Consumer.

AIGatewayConsumer

* Additional properties are allowed.
display_namestringrequired

The display name for this consumer instance.

Example:Greg's Dev Key

refstringrequired

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

Example:gregs-dev-key

typestringrequired

The type of the consumer.

Allowed values:apikeyoauth

consumer_groupsarray[object]required

Lightweight object used to reference a consumer group, identified by its ref.

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

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the consumer.

* Additional properties are NOT allowed.
Show Child Parameters
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"}

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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}/consumers/{consumerId}
 
application/json

Update an AI Gateway Consumer

Updates the configuration of an existing AI Gateway consumer.

put

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

consumerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

UpdateAIGatewayConsumerRequest

* Additional properties are allowed.
display_namestringrequired

The display name for this consumer instance.

Example:Greg's Dev Key

refstringrequired

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

Example:gregs-dev-key

typestringrequired

The type of the consumer.

Allowed values:apikeyoauth

consumer_groupsarray[object]required

Lightweight object used to reference a consumer group, identified by its ref.

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

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the consumer.

* Additional properties are NOT allowed.
Show Child Parameters
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"}

Response

application/json

Consumer updated successfully.

AIGatewayConsumer

* Additional properties are allowed.
display_namestringrequired

The display name for this consumer instance.

Example:Greg's Dev Key

refstringrequired

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

Example:gregs-dev-key

typestringrequired

The type of the consumer.

Allowed values:apikeyoauth

consumer_groupsarray[object]required

Lightweight object used to reference a consumer group, identified by its ref.

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

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the consumer.

* Additional properties are NOT allowed.
Show Child Parameters
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"}

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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

put/ai-gateways/{gatewayId}/consumers/{consumerId}

Body

{ "display_name": "Greg's Dev Key", "ref": "gregs-dev-key", "type": "apikey", "consumer_groups": [ { "ref": "dev-users" } ], "policies": [ { "ref": "ai-pii-sanitizer-1234" } ], "config": {} }
 
application/json

Delete an AI Gateway Consumer

Removes a specific AI Gateway consumer.

delete

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

consumerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

Consumer deleted successfully.

delete/ai-gateways/{gatewayId}/consumers/{consumerId}