CreateAIGatewayPolicyRequest

object
* Additional properties are NOT allowed.
display_namestringrequired

The display name for this policy instance.

Example:My Cool AI PII Sanitizer Policy

refstringrequired

A user-defined unique identifier for this policy instance, used as a stable human-readable reference.

Example:ai-pii-sanitizer-1234

typestringrequired

The type of the policy. Some examples are: ‘ai-sanitizer’, ‘ai-prompt-guard’,
and ‘openid-connect’.

Example:ai-sanitizer

enabledbooleanrequired

Whether the policy is enabled.

Example:true

configobjectrequired

Configuration for the policy. The structure varies depending on the policy type.

Example:{"anonymize":["phone","creditcard"],"stop_on_error":true}

* Additional properties are allowed.
labelsobject

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:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

Example

UpdateAIGatewayPolicyRequest

object
* Additional properties are NOT allowed.
display_namestringrequired

The display name for this policy instance.

Example:My Cool AI PII Sanitizer Policy

refstringrequired

A user-defined unique identifier for this policy instance, used as a stable human-readable reference.

Example:ai-pii-sanitizer-1234

typestringrequired

The type of the policy. Some examples are: ‘ai-sanitizer’, ‘ai-prompt-guard’,
and ‘openid-connect’.

Example:ai-sanitizer

enabledbooleanrequired

Whether the policy is enabled.

Example:true

configobjectrequired

Configuration for the policy. The structure varies depending on the policy type.

Example:{"anonymize":["phone","creditcard"],"stop_on_error":true}

* Additional properties are allowed.
labelsobject

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:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

Example

AIGatewayPolicy

object
* Additional properties are NOT allowed.
display_namestringrequired

The display name for this policy instance.

Example:My Cool AI PII Sanitizer Policy

refstringrequired

A user-defined unique identifier for this policy instance, used as a stable human-readable reference.

Example:ai-pii-sanitizer-1234

typestringrequired

The type of the policy. Some examples are: ‘ai-sanitizer’, ‘ai-prompt-guard’,
and ‘openid-connect’.

Example:ai-sanitizer

enabledbooleanrequired

Whether the policy is enabled.

Example:true

configobjectrequired

Configuration for the policy. The structure varies depending on the policy type.

Example:{"anonymize":["phone","creditcard"],"stop_on_error":true}

* Additional properties are allowed.
labelsobject

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:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

CreateAIGatewayAgentRequest

object
* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

A user-defined unique identifier for this agent, used as a stable human-readable reference.

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

Access control rules for allowing or denying consumer groups access to this agent.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

Example

UpdateAIGatewayAgentRequest

object
* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

A user-defined unique identifier for this agent, used as a stable human-readable reference.

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

Access control rules for allowing or denying consumer groups access to this agent.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

Example