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

List SNIs associated with a certificate

Retrieve a paginated list of all SNIs associated with a certificate. Use this endpoint to retrieve a list of SNIs that are linked to a specific certificate. You can use the optional query parameters to filter the results based on specific criteria. The response will include the list of SNIs and pagination information. See the response schema for details on the expected format of the response body.

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

certificate_name_or_idstringrequired

The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.

Allowed values:a3ad71a8-6685-4b03-a101-980a953544f6name

Example:name

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

SNI response object

dataarray[object]

Array of SNIs

Show Child Parameters
nextstring

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

Example:http://localhost:8001/snis?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

get/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_name_or_id}/snis
 
200 application/json

Create a new SNI associated with a Certificate

Create a new SNI and associate it with a certificate in the system. Use this endpoint to add a new SNI to the system and link it to a specific certificate.

post

Path Parameters

certificate_name_or_idstringrequired

The unique identifier or the name attribute of the Certificate whose SNIs are to be retrieved. When using this endpoint, only SNIs associated to the specified Certificate will be listed.

Allowed values:a3ad71a8-6685-4b03-a101-980a953544f6name

Example:name

runtimeGroupIdstringrequired

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

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

Body

application/json

A JSON object containing the details of the new SNI, including the name, certificate, and tags.

namestringrequired

The SNI name to associate with the given certificate.

Example:my-sni

tagsarray[string]

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

Example:[user-level, low-priority]

certificateobjectrequired

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object. With form-encoded, the notation is certificate.id=<certificate id>. With JSON, use “certificate:{id:<certificate id>”}.

Show Child Parameters

Response

application/json

Successfully created SNI

SNI

An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.

certificateobject

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

* Additional properties are NOT allowed.
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

Example:1422386534

idstring

Example:b87eb55d-69a1-41d2-8653-8d706eecefc0

namestring

The SNI name to associate with the given certificate.

Example:my-sni

tagsarray[string]

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

Example:user-level, enterprise

post/runtime-groups/{runtimeGroupId}/core-entities/certificates/{certificate_name_or_id}/snis

Body

{ "name": "my-sni", "certificate": { "id": "91020192-062d-416f-a275-9addeeaffaf2" } }
 
application/json

Delete a an SNI associated with a Certificate

Delete a an SNI associated with a a Certificate using an ID.

delete

Path Parameters

certificate_idstringrequired

The unique identifier of the Certificate to retrieve.

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

sni_idstringrequired

The unique identifier or the name of the SNI to retrieve.

Example:my-sni

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

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