AI Gateways

Patch an AI Gateway

Changed on

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

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

Request body

display_namestring

The display name for this AI Gateway.

descriptionstring

The description of the AI Gateway.

min_runtime_versionstring

The minimum AI Gateway runtime version supported by this AI Gateway. This is the lowest data plane version that may receive configuration from it, and it controls which features the API accepts.

It may be lowered only when no configuration already stored uses a feature that requires a runtime version above the requested one. Otherwise the request is rejected, naming the entities and fields that stand in the way so that they can be removed or downgraded first.

When not specified, the minimum runtime version is left unchanged.

When runtime_auto_upgrade is enabled (the default), this value is raised automatically to track the minimum runtime version reported across connected data planes, so any value set here may be superseded as the fleet upgrades.

runtime_auto_upgradeboolean

Whether the control plane should automatically raise min_runtime_version to match the DP fleet's minimum runtime version (the lowest AI Gateway runtime version reported across all connected data planes) as that value increases.

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"
    }
  ],
  "min_runtime_version": "2.0",
  "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.

min_runtime_versionstring

The minimum AI Gateway runtime version supported by this AI Gateway. This is the lowest data plane version that may receive configuration from it, and it controls which features the API accepts.

Data planes older than this version still connect for topology visibility.

When not specified, the latest generally available runtime version is used.

When runtime_auto_upgrade is enabled (the default), this value is raised automatically to track the minimum runtime version reported across connected data planes, so any value set here may be superseded as the fleet upgrades.

runtime_auto_upgradeboolean

Whether the control plane should automatically raise min_runtime_version to match the DP fleet's minimum runtime version (the lowest AI Gateway runtime version reported across all connected data planes) as that value increases.

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",
  "min_runtime_version": "2.0",
  "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

  • 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 404.00 enum value to the response property for the response status