Update a service shared policy chain policy

Update a service shared policy chain outbound policy

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

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

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}/shared-policies/services/{apiGatewaySharedPolicyChainId}/outbound-policies/{apiGatewayPolicyId}

Body

{}
 
application/json

Delete a service shared policy chain policy

Delete a service shared policy chain outbound policy

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

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

Response

Success

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

List API Gateway DataPlane Certificates

Returns a list of dataplane certificates that are associated to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this API gateway.

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

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

application/json

A paginated list response for a collection of certificates associated with an API Gateway.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

A dataplane certificate.

Show Child Parameters
get/api-gateways/{gatewayId}/data-plane-certificates
 
application/json

Create a New DataPlane Certificate

Create new dataplane certificate to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this API gateway.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

Request body for creating a certificate.

certificatestringrequired

JSON escaped string of the certificate.

namestring

The name to identify the certificate.

descriptionstring

A description of the certificate.

Response

application/json

Created

APIGatewayDataPlaneCertificate

A dataplane certificate.

idstring(uuid)required

The unique identifier of the certificate.

certificatestringrequired

JSON escaped string of the certificate.

namestring

The name to identify of the certificate.

>= 1 characters<= 255 characters

descriptionstring

A description of the certificate.

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

metadataobject

Metadata extracted from a certificate.

Show Child Parameters
post/api-gateways/{gatewayId}/data-plane-certificates

Body

{ "certificate": "-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n" }
 
application/json

Get DataPlane Certificate

Returns information about an individual dataplane certificate.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

certificateIdstring(uuid)required

The ID of the dataplane certificate.

Response

application/json

A single dataplane certificate.

APIGatewayDataPlaneCertificate

A dataplane certificate.

idstring(uuid)required

The unique identifier of the certificate.

certificatestringrequired

JSON escaped string of the certificate.

namestring

The name to identify of the certificate.

>= 1 characters<= 255 characters

descriptionstring

A description of the certificate.

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

metadataobject

Metadata extracted from a certificate.

Show Child Parameters
get/api-gateways/{gatewayId}/data-plane-certificates/{certificateId}
 
application/json