CreateAIGatewayConsumerRequest

object
* 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

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

Example

UpdateAIGatewayConsumerRequest

object
* 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

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

Example

AIGatewayConsumer

object
* 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

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

Example

CreateAIGatewayConsumerGroupRequest

object
* Additional properties are allowed.
display_namestringrequired

The display name for this consumer group instance.

Example:Dev Users Group

refstringrequired

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

Example:dev-users

policiesarray[object]required

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

* 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

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

Example

UpdateAIGatewayConsumerGroupRequest

object
* Additional properties are allowed.
display_namestringrequired

The display name for this consumer group instance.

Example:Dev Users Group

refstringrequired

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

Example:dev-users

policiesarray[object]required

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

* 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

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

Example