APIGatewayPolicyList

object
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
Example

APIGatewaySharedPolicyChain

object

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

Example

CreateAPIGatewaySharedPolicyChain

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

Example

APIGatewayDataPlaneCertificate

object

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
Example

APIGatewayCertificateMetadata

object

Metadata extracted from a certificate.

issuerstring

The issuer of the certificate.

subjectstring

The subject of the certificate.

key_usagesarray[string]

The key usages of the certificate.

expiryinteger(int64)

The expiry date of the certificate as a unix timestamp.

san_namesarray[string]

The Subject Alternative Names (SAN) of the certificate.

dns_namesarray[string]

The DNS names in the certificate SAN.

email_addressesarray[string]

The email addresses in the certificate SAN.

ip_addressesarray[string]

The IP addresses in the certificate SAN.

urisarray[string](uri)

The URIs in the certificate SAN.

sha256_fingerprintstring

The SHA-256 fingerprint of the certificate.

Example