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.

put

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

Body

application/json

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.

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

Response

application/json

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.

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

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

Body

{ "certificate": { "id": "bd380f99-659d-415e-b0e7-72ea05df3218" }, "id": "36c4566c-14cc-4132-9011-4139fcbbe50a", "name": "some.example.org" }
 
application/json

List all SNIs

List all SNIs

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

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/snis
 
200 application/json

Create a new SNI

Create a new SNI

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

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

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

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

Body

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

Delete an SNI

Delete an SNI

delete

Path Parameters

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/snis/{sni_id}
 
204

Get an SNI

Get an SNI using ID or name.

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

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

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/snis/{sni_id}
 
application/json