List all policies for an API Gateway service

List all outbound policies for an API Gateway service

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

parent_policy_idstring(uuid)

The ID of the parent policy.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Path Parameters

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

200 application/json

A paginated list response for a collection of API Gateway Outbound Policies.

APIGatewayPolicyList

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
get/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies
 
200 application/json

Create a new outbound policy for a service

Create a new outbound policy for a service

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

Body

application/json

The service outbound policy to be created

CreateAPIGatewayServiceOutboundPolicy

CreateAPIGatewayServiceOutboundPolicy
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}/services/{apiGatewayServiceId}/outbound-policies

Body

{}
 
application/json

Get an outbound policy for a service

Get an outbound policy for a service

get

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

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}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}
 
application/json

Update an outbound policy for a service

Update an outbound policy for a service

put

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The outbound policy to be updated

CreateAPIGatewayServiceOutboundPolicy

CreateAPIGatewayServiceOutboundPolicy
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}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}

Body

{}
 
application/json

Delete an outbound policy for a service

Delete an outbound policy for a service

delete

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

Success

delete/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}