ACLs3

Add-Ons4

AI Gateway Agents4

AI Gateway Auth Strategies4

AI Gateway CA Certificates4

AI Gateway Certificates4

AI Gateway Config Stores8

AI Gateway Consumer Groups6

AI Gateway Consumers7

AI Gateway Custom Policies4

AI Gateway DataPlane Certificates3

AI Gateway MCP Servers4

AI Gateway Model Providers4

AI Gateway Models4

AI Gateway Policies4

AI Gateway SNIs4

AI Gateway Vaults4

AI Gateways4

API4

API Documentation4

API Implementation3

API Product Documentation4

API Product Version Specification4

API Product Versions4

API Products4

API Publication3

API Specification4

API Version4

API-keys3

App Auth Strategies4

Application Registrations4

Applications4

Assets4

Audit Logs7

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Settings10

Basic-auth credentials3

CA Certificates4

Catalog AI Model Implementations3

Catalog AI Model Specs3

Catalog AI Model Versions4

Catalog AI Models4

Catalog MCP Implementations3

Catalog MCP Versions4

Catalog MCPs4

Catalog Services4

Centrally Managed Consumers4

Centrally Managed Keys3

Certificates4

Cloned Plugins4

CMEK3

Config Store Secrets4

Config Stores4

Consumer Groups6

Consumers4

Control Plane Groups2

Control Planes6

Custom Domains3

Custom Plugin Schemas4

CustomPlugins4

Data-Plane Group Configurations2

DCR Providers4

DP Certificates4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

GraphQL Cost Decorations1

HMAC-auth credentials3

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances4

JWTs3

Keys4

KeySets4

Mesh5

MTLS-auth credentials3

Networks5

Pages4

Partials4

Personal Access Tokens2

Platform IPs1

Platform Regions1

Plugins453

Portal Appearance2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Product Versions3

Portal Team Membership2

Portal Team Roles2

Portal Teams4

Portals10

Portals IP Allow List4

Private DNS3

Provider Accounts1

Realms4

Roles6

Routes8

Serverless Cloud Gateways3

Services4

Snippets4

SNIs4

System Accounts5

System Accounts - Access Tokens4

System Accounts - Roles3

System Accounts - Team Membership2

Targets3

Team Membership2

Teams5

Transit Gateways4

Upstreams4

Vaults4

patchReset Auth Settings

AI Gateways

Update an AI Gateway

Updates the configuration of an existing AI Gateway.

put/v1/ai-gateways/{gatewayId}

Request body

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.

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

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

runtime_auto_upgradeboolean

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

Changed in 3 of the 55 revisions of this API.4335

Sep 30, 2026f530bf4001983See the full diff
- ●
  added the new 400.00 enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new 403.00 enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 20264a02153f2e60434See the full diff
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 18, 20265ca78660b97c1See the full diff
- ○
  endpoint added
  endpoint-added

Full history