Create a service shared policy chain

Create a service shared policy chain

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The shared policy to be created

CreateAPIGatewaySharedPolicyChain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain

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

A shared policy chain for a gateway

APIGatewaySharedPolicyChain

A reusable policy chain that can be applied to multiple routes or services.

idstring(uuid)read-only

The ID of the shared policy chain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain.

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

post/api-gateways/{gatewayId}/shared-policies/services

Body

{ "name": "name" }
 
application/json

Get a service shared policy chain

Get a service shared policy chain

get

Path Parameters

apiGatewaySharedPolicyChainIdstring(uuid)required

The ID of the API Gateway Shared Policy Chain.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

application/json

A shared policy chain for a gateway

APIGatewaySharedPolicyChain

A reusable policy chain that can be applied to multiple routes or services.

idstring(uuid)read-only

The ID of the shared policy chain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain.

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

get/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}
 
application/json

Update a service shared policy chain

Update a service shared policy chain

put

Path Parameters

apiGatewaySharedPolicyChainIdstring(uuid)required

The ID of the API Gateway Shared Policy Chain.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The shared policy to be updated

CreateAPIGatewaySharedPolicyChain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain

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

A shared policy chain for a gateway

APIGatewaySharedPolicyChain

A reusable policy chain that can be applied to multiple routes or services.

idstring(uuid)read-only

The ID of the shared policy chain

namestringrequired

The unique name of the shared policy chain

titlestring

The title of the shared policy chain.

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

put/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}

Body

{ "name": "name" }
 
application/json

Delete a service shared policy chain

Delete a service shared policy chain

delete

Path Parameters

apiGatewaySharedPolicyChainIdstring(uuid)required

The ID of the API Gateway Shared Policy Chain.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

Success

delete/api-gateways/{gatewayId}/shared-policies/services/{apiGatewaySharedPolicyChainId}
 

List all service shared policy chain policies

List all service shared policy chain inbound policies

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

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

apiGatewaySharedPolicyChainIdstring(uuid)required

The ID of the API Gateway Shared Policy Chain.

Response

200 application/json

A paginated list response for a collection of API Gateway Inbound 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}/shared-policies/services/{apiGatewaySharedPolicyChainId}/inbound-policies
 
200 application/json