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.
Path Parameters
The unique identifier of the Certificate to retrieve.
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
PEM-encoded public certificate chain of the SSL key pair.
Example:-----BEGIN CERTIFICATE-----...,
PEM-encoded private key of the SSL key pair.
Example:-----BEGIN RSA PRIVATE KEY-----...
PEM-encoded public certificate chain of the alternate SSL key pair.
PEM-encoded private key of the alternate SSL key pair.
Example:-----BEGIN EC PRIVATE KEY-----...
An optional set of strings associated with the Certificate for grouping and filtering.
Response
application/json
Response
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.
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-----
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-----...
Unix epoch when the resource was created.
Example:1422386534
Unix epoch when the resouce was updated.
Example:1422386534
The UUID representation of the certificate object.
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
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-----...
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-----...
An optional set of strings associated with the Certificate for grouping and filtering.
Example:user-level
Authentication
Path Parameters
Body
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.
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
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
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
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
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
SNI response object
Array of SNIs
Show Child Parameters
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
Authentication
Path Parameters
Query Parameters
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.
Path Parameters
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
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
A JSON object containing the details of the new SNI, including the name, certificate, and tags.
The SNI name to associate with the given certificate.
Example:my-sni
An optional set of strings associated with the SNIs for grouping and filtering.
Example:[user-level, low-priority]
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
Response
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.
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.
Show Child Parameters
Unix epoch when the resource was created.
Example:1422386534
Example:b87eb55d-69a1-41d2-8653-8d706eecefc0
The SNI name to associate with the given certificate.
Example:my-sni
An optional set of strings associated with the SNIs for grouping and filtering.
Example:user-level, enterprise
Authentication
Path Parameters
Body
Delete a an SNI associated with a Certificate
Delete a an SNI associated with a a Certificate using an ID.
Path Parameters
The unique identifier of the Certificate to retrieve.
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The unique identifier or the name of the SNI to retrieve.
Example:my-sni
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted SNI or the resource didn’t exist