CA Certificates

CA certificates

List all CA certificates

Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example /ca-certificates?size=50&tags=enterprise.

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

200 application/json

A successful response listing CA Certificates

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

get/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates
 
200 application/json

Create a new CA certificate

Create a new Certificate Authority (CA) certificate. The request body must include the cert property, the certificate data in PEM format; it can also include cert_digest, a digest of the certificate in hex format for verifying the certificates integrity, and tags, an optional list of tags to categorize the certificate.

post

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Body

application/json

This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate.

certstringrequired

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Response

application/json

The created certificate object.

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

post/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates

Body

{ "cert": "-----BEGIN CERTIFICATE-----..." }
 
application/json

Delete a CA Certificate

Delete the specified Certificate Authority (CA) certificate using the provided ca_certificate_id.

delete

Path Parameters

ca_certificate_idstringrequired

ID of the related certificate

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

204

Successfully deleted CA Certificate or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}
 
204

Get a CA certificate

Retrieve details about the specified Certificate Authority (CA) certificate using the provided path parameter ca_certificate_id.

get

Query Parameters

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

ca_certificate_idstringrequired

The unique identifier of the certificate to retrieve.

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

application/json

The specified CA certificate exists in the system, and the response includes details about the certificate.

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

get/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}
 
application/json