Create a new Certificate

Create a new certificate with the provided details. Use this endpoint to add a new certificate to the system. The request body must include the certificate data and other details required for creating a new 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
certstringrequired

PEM-encoded public certificate chain of the SSL key pair.

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

keystringrequired

PEM-encoded private key of the SSL key pair.

Example:-----BEGIN RSA PRIVATE KEY-----...

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair.

key_altstring

PEM-encoded private key of the alternate SSL key pair.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

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

Response

application/json

A certificate object represents a public certificate. These fields are referenceable.

dataarray[object]

An array containing certificate information.

Show Child Parameters
post/runtime-groups/{runtimeGroupId}/core-entities/certificates

Body

{ "cert": "-----BEGIN CERTIFICATE-----...,", "key": "-----BEGIN RSA PRIVATE KEY-----..." }
 
application/json

Delete a Certificate

Delete a Certificate

delete

Path Parameters

certificate_idstringrequired

ID of the Certificate to delete

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 Certificate or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_id}
 
204

Get a Certificate

Retrieve details about the specified certificate using the provided path parameter 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

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

Path Parameters

certificate_idstringrequired

The unique identifier of the Certificate to retrieve.

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

application/json

HTTP 200 OK

Certificate

A certificate object represents a public certificate. These fields are referenceable, and can be stored as secrets in a vault. References must follow a specific format.

certstring

PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault. References must follow a specific format.

Example:-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs.

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

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

The UUID representation of the certificate object.

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

keystring

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example: -----BEGIN RSA PRIVATE KEY-----...

key_altstring

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

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

Example:user-level

get/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_id}
 
application/json

Update a Certificate

Update details about the specified certificate using the provided path parameter certificate_id.

Inserts (or replaces) the certificate under the requested certificate_idwith the definition specified in the request body. When the id attribute has the structure of a UUID, the certificate being inserted/replaced will be identified by its id. Otherwise it will be identified by the name.

When creating a new Certificate without specifying id (neither in the path or the request body), then it will be auto-generated.

put

Path Parameters

certificate_idstringrequired

The unique identifier of the Certificate to retrieve.

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

Body

application/json
certstringrequired

PEM-encoded public certificate chain of the SSL key pair.

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

keystringrequired

PEM-encoded private key of the SSL key pair.

Example:-----BEGIN RSA PRIVATE KEY-----...

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair.

key_altstring

PEM-encoded private key of the alternate SSL key pair.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

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

Response

application/json

Successfully upserted Certificate

Certificate

A certificate object represents a public certificate. These fields are referenceable, and can be stored as secrets in a vault. References must follow a specific format.

certstring

PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault. References must follow a specific format.

Example:-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs.

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

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

The UUID representation of the certificate object.

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

keystring

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example: -----BEGIN RSA PRIVATE KEY-----...

key_altstring

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

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

Example:user-level

put/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_id}

Body

{ "cert": "-----BEGIN CERTIFICATE-----...,", "key": "-----BEGIN RSA PRIVATE KEY-----..." }
 
application/json

SNIs

SNIs