CA Certificates

A CA certificate object represents a trusted certificate authority.
These objects are used by Kong Gateway to verify the validity of a client or server certificate.

List all CA Certificates

List all CA Certificates

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

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

A successful response listing CA Certificates

dataarray[object]

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.

Example:{"cert":"-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----","cert_digest":"9b8aaf19a276885f6c8a6bc48a30700fdb3a351d8b05374d153bfb7b178e2a9f","created_at":1706598432,"id":"b2f34145-0343-41a4-9602-4c69dec2f260","tags":["trusted","api"]}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/ca_certificates
 
application/json

Create a new CA Certificate

Create a new CA Certificate

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

Description of the new CA Certificate for creation

CACertificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.

* Additional properties are NOT allowed.
certstringrequired

PEM-encoded public certificate of the CA.

cert_digeststring

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully created CA Certificate

CACertificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.

* Additional properties are NOT allowed.
certstringrequired

PEM-encoded public certificate of the CA.

cert_digeststring

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/ca_certificates

Body

{ "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----", "cert_digest": "9b8aaf19a276885f6c8a6bc48a30700fdb3a351d8b05374d153bfb7b178e2a9f", "created_at": 1706598432, "id": "b2f34145-0343-41a4-9602-4c69dec2f260", "tags": [ "trusted", "api" ] }
 
application/json

Delete a CA Certificate

Delete a CA Certificate

delete

Path Parameters

CACertificateIdstringrequired

ID of the CA Certificate to lookup

Example:3c31f18a-f27a-4f9b-8cd4-bf841554612f

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

Successfully deleted CA Certificate or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/ca_certificates/{CACertificateId}
 

Get a CA Certificate

Get a CA Certificate using ID.

get

Path Parameters

CACertificateIdstringrequired

ID of the CA Certificate to lookup

Example:3c31f18a-f27a-4f9b-8cd4-bf841554612f

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

Successfully fetched CA Certificate

CACertificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.

* Additional properties are NOT allowed.
certstringrequired

PEM-encoded public certificate of the CA.

cert_digeststring

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

get/control-planes/{controlPlaneId}/core-entities/ca_certificates/{CACertificateId}
 
application/json