Create a new inbound policy for a route

Create a new route policy

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

apiGatewayRouteIdstring(uuid)required

The ID of the API Gateway Route.

Body

application/json

The route inbound policy to be created

CreateAPIGatewayRouteInboundPolicy

CreateAPIGatewayRouteInboundPolicy
One Of
idstring(uuid)read-only
typestringrequired

The type identifier of the policy

Allowed values:policy_chain_reference

namestring

The name identifier of the policy

configOne Of
required
PolicyChainReferenceByIdobject

Reference a policy chain by its unique identifier.

* 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 | null(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"}

Response

application/json

An API Gateway policy

APIGatewayPolicy

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 | null(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"}

post/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies

Body

{}
 
application/json

Get an inbound policy for a route

Get an inbound policy for a route

get

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayRouteIdstring(uuid)required

The ID of the API Gateway Route.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

An API Gateway policy

APIGatewayPolicy

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 | null(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"}

get/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}
 
application/json

Update an inbound policy for a route

Update an inbound policy for a route

put

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayRouteIdstring(uuid)required

The ID of the API Gateway Route.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The inbound policy to be updated

CreateAPIGatewayRouteInboundPolicy

CreateAPIGatewayRouteInboundPolicy
One Of
idstring(uuid)read-only
typestringrequired

The type identifier of the policy

Allowed values:policy_chain_reference

namestring

The name identifier of the policy

configOne Of
required
PolicyChainReferenceByIdobject

Reference a policy chain by its unique identifier.

* 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 | null(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"}

Response

application/json

An API Gateway policy

APIGatewayPolicy

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 | null(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"}

put/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}

Body

{}
 
application/json

Delete an inbound policy for a route

Delete an inbound policy for a route

delete

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayRouteIdstring(uuid)required

The ID of the API Gateway Route.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Success

delete/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}
 

Move an inbound policy

Moves the position of a specific policy relative to the chain associated with the API Gateway route.

post

Query Parameters

indexintegerrequired

The index position of the policy.

>= 0

Example:10

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayRouteIdstring(uuid)required

The ID of the API Gateway Route.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Position Updated

post/api-gateways/{gatewayId}/routes/{apiGatewayRouteId}/inbound-policies/{apiGatewayPolicyId}/move