ForwardToUpstreamPolicy

idstring(uuid)read-only
typestringrequired

The type identifier of the policy

Allowed values:forward_to_upstream

namestring

The name identifier of the policy

configobjectrequired

The configuration of the policy

* Additional properties are NOT allowed.
Show Child Parameters
conditionstring

A string containing the boolean expression that determines whether the policy is applied.

>= 1 characters<= 1000 characters

Example:context.introspect_token.claims.gold_tier == true

parent_policy_idstring(uuid)

The unique identifier of the parent policy, if any.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

HeaderProperty

object
* Additional properties are NOT allowed.
keystringrequired
valuestringrequired
Example

APIGatewayPolicyList

object
dataarray[object]required

A policy that can be applied to an API Gateway.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example

APIGatewaySharedPolicyChain

object

A reusable policy chain that can be applied to multiple routes or services.

idstring(uuid)read-only

The ID of the shared policy chain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

CreateAPIGatewaySharedPolicyChain

object
namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example