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

Update API Gateway DataPlane Certificate

Updates an existing dataplane certificate associated with the specified API Gateway.

put

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.

Body

application/json

The request schema for updating a dataplane certificate.

certificatestringrequired

JSON escaped string of the certificate.

namestring

The name to identify of the certificate.

descriptionstring

A description of the certificate.

Response

application/json

Updated API gateway dataplane certificate object.

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
put/api-gateways/{gatewayId}/data-plane-certificates/{certificateId}

Body

{ "certificate": "certificate" }
 
application/json

Delete API Gateway DataPlane Certificate

Deletes a specific dataplane certificate associated with the API Gateway.

delete

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

No Content

delete/api-gateways/{gatewayId}/data-plane-certificates/{certificateId}