Get a shared policy chain
Get a shared policy chain
Path Parameters
The ID of the API Gateway Shared Policy Chain.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A shared policy chain for a gateway
APIGatewaySharedPolicyChain
A reusable policy chain that can be applied to multiple routes or services.
The ID of the shared policy chain
The unique name of the shared policy chain
The title of the shared policy chain.
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
Update a shared policy chain
Update a shared policy chain
Path Parameters
The ID of the API Gateway Shared Policy Chain.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The shared policy to be updated
CreateAPIGatewaySharedPolicyChain
The unique name of the shared policy chain
The title of the shared policy chain
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
A shared policy chain for a gateway
APIGatewaySharedPolicyChain
A reusable policy chain that can be applied to multiple routes or services.
The ID of the shared policy chain
The unique name of the shared policy chain
The title of the shared policy chain.
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 a shared policy chain
Delete a shared policy chain
Path Parameters
The ID of the API Gateway Shared Policy Chain.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Success
Authentication
Path Parameters
List routes policy chains inbound policies
List routes policy chains inbound policies
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 UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the API Gateway Shared Policy Chain.
Response
200 application/json
Response
A paginated list response for a collection of API Gateway Inbound 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 route shared policy chain policy
Create a route shared policy chain inbound policy
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the API Gateway Shared Policy Chain.
Body
application/json
Body
The route inbound policy to be created
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"}