Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
AI Gateway Policies

Update an AI Gateway Policy

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

Updates the configuration of an existing AI Gateway policy.

put/v1/ai-gateways/{gatewayId}/policies/{policyIdOrName}

Request body

display_namestring required

The display name for this policy instance.

namestring required

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

typestring required

The type of the Policy. This is equivalent to the Kong 3 plugin name. Some examples are: 'ai-sanitizer', 'ai-prompt-guard', and 'rate-limiting'. Note: Plugins have been renamed to Policies in Kong AI Gateway. Policy types and configuration documentation can be found in the Developer Docs.

enabledboolean

Whether the policy is enabled.

globalboolean

Whether the policy is globally applied to all resources.

configobject required

Configuration for the policy. This is equivalent to the Kong 3 plugin configuration. Note: Plugins have been renamed to Policies in Kong AI Gateway. Policy types and configuration documentation can be found in the Developer Docs.

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": "My Cool AI PII Sanitizer Policy",
  "name": "my-entity-name",
  "type": "ai-sanitizer",
  "enabled": true,
  "config": {
    "anonymize": [
      "phone",
      "creditcard"
    ],
    "stop_on_error": true
  },
  "labels": {
    "category": "finance"
  },
  "managed_by": {
    "owner": "terraform"
  }
}

Response

Policy updated successfully.

display_namestring required

The display name for this policy instance.

namestring required

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

typestring required

The type of the Policy. This is equivalent to the Kong 3 plugin name. Some examples are: 'ai-sanitizer', 'ai-prompt-guard', and 'rate-limiting'. Note: Plugins have been renamed to Policies in Kong AI Gateway. Policy types and configuration documentation can be found in the Developer Docs.

enabledboolean

Whether the policy is enabled.

globalboolean

Whether the policy is globally applied to all resources.

configobject required

Configuration for the policy. This is equivalent to the Kong 3 plugin configuration. Note: Plugins have been renamed to Policies in Kong AI Gateway. Policy types and configuration documentation can be found in the Developer Docs.

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": "My Cool AI PII Sanitizer Policy",
  "name": "my-entity-name",
  "type": "ai-sanitizer",
  "enabled": true,
  "config": {
    "anonymize": [
      "phone",
      "creditcard"
    ],
    "stop_on_error": true
  },
  "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"
}