APIGatewayServiceReference

object

A reference to an existing service by ID.

idstring(uuid)required

The ID of the service

namestringrequired

The name identifier of the service

>= 1 characters<= 255 characters

Example

APIGatewayServiceReferenceModify

A reference to an existing service, either by ID or by name.

Any Of
idstring(uuid)required

The ID of the service

Example

APIGatewayServiceReferenceById

object

A reference to an existing service by ID.

idstring(uuid)required

The ID of the service

Example

APIGatewayServiceReferenceByName

object

A reference to an existing service by name.

namestringrequired

The name identifier of the service

>= 1 characters<= 255 characters

Example

APIGatewayPolicy

object

A policy that can be applied to an API Gateway.

* Additional properties are NOT allowed.
idstring(uuid)required

The ID of the policy

typestringrequired

The type identifier of the policy

namestring

The name of the policy

configobjectrequired

The configuration of the policy

parent_policy_idstring(uuid)

The unique identifier of the parent policy, if any.

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

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

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