Sign in
AI Gateways

Create an AI Gateway

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates a new AI Gateway in the organization.

post/v1/ai-gateways

Request body

deployment_type'hybrid' | 'managed' | 'serverless'

How this AI Gateway's control plane is deployed. Set at creation time and cannot be changed afterward.

display_namestring required

The display name for this AI Gateway.

namestring required

The name for this AI Gateway. This value is immutable after creation.

descriptionstring

The description of the AI Gateway.

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

Example request

{
  "deployment_type": "hybrid",
  "display_name": "My AI Gateway",
  "name": "my-ai-gateway",
  "description": "An AI Gateway for my organization.",
  "proxy_urls": [
    {
      "host": "example.com",
      "port": 443,
      "protocol": "https"
    }
  ],
  "labels": {
    "category": "finance"
  }
}

Response

AI Gateway created successfully.

display_namestring required

The display name for this AI Gateway.

namestring required

The name for this AI Gateway. This value is immutable after creation.

descriptionstring

The description of the AI Gateway.

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

idstring uuid required

Contains a unique identifier used for this resource.

deployment_type'hybrid' | 'managed' | 'serverless' required

How this AI Gateway's control plane is deployed.

config_versionstring

The version identification of the latest configuration of the gateway. Any change to an entity under this gateway can result in a new version. The config_version is generated in the control plane and used to verify if an AI Gateway node configuration is up to date.

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": "My AI Gateway",
  "name": "my-ai-gateway",
  "description": "An AI Gateway for my organization.",
  "proxy_urls": [
    {
      "host": "example.com",
      "port": 443,
      "protocol": "https"
    }
  ],
  "labels": {
    "category": "finance"
  },
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "deployment_type": "hybrid",
  "endpoints": {
    "configuration": "https://acfe5f253f.cp.konghq.com",
    "telemetry": "https://acfe5f253f.tp0.konghq.com"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 4 of the 75 revisions of this API.436

  • 46dabd88efd32See the full diff
    • ○

      added the new optional request property deployment_type

      new-optional-request-property

    • ○

      added the required property deployment_type to the response with the 201 status

      response-required-property-added

  • 0261aef4b1e2422See the full diff
    • ▲

      the name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      added the pattern ^[0-9a-z-]+$ to the request property name

      request-property-pattern-added

    • ▲

      the name request property type/format changed from / to string/

      request-property-type-changed

    • ▲

      the name response's property type/format changed from / to string/ for status 201

      response-property-type-changed

    • ●

      removed AIGatewayEntityIdentifier from the name request property allOf list

      request-property-all-of-removed

    • ●

      the name request property's maxLength was set to 256

      request-property-max-length-set

    • ○

      removed AIGatewayEntityIdentifier from the name response property allOf list for the response status 201

      response-property-all-of-removed

    • ○

      the name response's property pattern ^[0-9a-z-]+$ was added for the status 201

      response-property-pattern-added

  • 231c616fc23b11See the full diff
    • ●

      removed the optional property config_hash from the response with the 201 status

      response-optional-property-removed

    • ○

      added the optional property config_version to the response with the 201 status

      response-optional-property-added

  • a2e95e9f6c801See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog