Sign in
AI Gateways

Patch an AI Gateway

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

Partially updates the configuration of an existing AI Gateway. Only the fields included in the request body are changed.

patch/v1/ai-gateways/{gatewayId}

Request body

display_namestring

The display name for this AI Gateway.

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

{
  "display_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 updated 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 1 of the 75 revisions of this API.1