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
Authentication
Path Parameters
Get an SNI associated with a certificate
Get an SNI associated with a Certificate using ID or name.
Query Parameters
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
Number of resources to be returned.
Default:100
>= 1<= 1000
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 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
application/json
Response
Successfully fetched 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
Query Parameters
Upsert an SNI associated with a certificate
Create or Update an SNI associated with a Certificate using ID or name.
Inserts (or replaces) the SNI under the requested resource with the definition specified in the body. The SNI will be identified by the id attribute.
When the name or id attribute has the structure of a UUID, the SNI being inserted/replaced will be identified by its id. Otherwise it will be identified by its name.
When creating a new SNI without specifying id (neither in the URL nor in the body), then it will be auto-generated.
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
Body
application/json
Body
Description of the 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
Response
application/json
Response
Successfully upserted 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
List all SNIs
List all SNIs
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 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