AI Gateway Consumers

Create an AI Gateway Consumer

Changed on

Creates a new consumer for the AI Gateway.

post/v1/ai-gateways/{gatewayId}/consumers

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/ai-gateways/{gatewayId}/consumers
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

display_namestring required

The display name for this consumer instance.

namestring required

Identifier for an AI Gateway entity. In some cases, this may be the entity name or ID.

type'api-key' | 'oauth' required

The type of the consumer.

custom_idstring

Identifier for mapping the consumer when using OAuth authentication.

policiesstring[]

List of policy references.

labelsPublicLabels

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 "_".

managed_byManagedBy

Stores information about what manages this entity, such as the tool or system responsible for its lifecycle (for example, terraform).

Keys must be 1–63 characters long and start with an alphanumeric character.

Example request

{
  "display_name": "Greg's Dev Consumer",
  "name": "my-entity-name",
  "custom_id": "dev-users",
  "labels": {
    "category": "finance"
  },
  "managed_by": {
    "owner": "terraform"
  }
}

Response

AI Gateway Consumer created successfully.

display_namestring required

The display name for this consumer instance.

namestring required

Identifier for an AI Gateway entity. In some cases, this may be the entity name or ID.

type'api-key' | 'oauth' required

The type of the consumer.

custom_idstring

Identifier for mapping the consumer when using OAuth authentication.

policiesstring[]

List of policy references.

labelsPublicLabels

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 "_".

managed_byManagedBy

Stores information about what manages this entity, such as the tool or system responsible for its lifecycle (for example, terraform).

Keys must be 1–63 characters long and start with an alphanumeric character.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "display_name": "Greg's Dev Consumer",
  "name": "my-entity-name",
  "custom_id": "dev-users",
  "labels": {
    "category": "finance"
  },
  "managed_by": {
    "owner": "terraform"
  },
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status