Update an inbound policy for a route
Update an inbound policy for a route
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The inbound policy to be updated
CreateAPIGatewayRouteInboundPolicy
One OfThe type identifier of the policy
Allowed values:policy_chain_reference
The name identifier of the policy
One OfReference a policy chain by its unique identifier.
Show Child Parameters
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
The unique identifier of the parent policy, if any.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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
Response
An API Gateway policy
APIGatewayPolicy
A policy that can be applied to an API Gateway.
The ID of the policy
The type identifier of the policy
The name of the policy
The configuration of the policy
The unique identifier of the parent policy, if any.
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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"}
Authentication
Path Parameters
Body
Delete an inbound policy for a route
Delete an inbound policy for a route
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Success
Authentication
Path Parameters
Move an inbound policy
Moves the position of a specific policy relative to the chain associated with the API Gateway route.
Query Parameters
The index position of the policy.
>= 0
Example:10
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Position Updated
Authentication
Path Parameters
Query Parameters
List all policies for an API Gateway route
List all outbound policies for an API Gateway route
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
The ID of the parent policy.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Path Parameters
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A paginated list response for a collection of API Gateway Outbound Policies.
APIGatewayPolicyList
A policy that can be applied to an API Gateway.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a new outbound policy for a route
Create a new route policy
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the API Gateway Route.
Body
application/json
Body
The route outbound policy to be created
CreateAPIGatewayRouteOutboundPolicy
One OfThe type identifier of the policy
Allowed values:policy_chain_reference
The name identifier of the policy
One OfReference a policy chain by its unique identifier.
Show Child Parameters
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
The unique identifier of the parent policy, if any.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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
Response
An API Gateway policy
APIGatewayPolicy
A policy that can be applied to an API Gateway.
The ID of the policy
The type identifier of the policy
The name of the policy
The configuration of the policy
The unique identifier of the parent policy, if any.
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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"}