List all SNIs in a workspace
List all SNIs in a workspace
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 name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A successful response listing SNIs
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.
Example:{"certificate":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"},"id":"36c4566c-14cc-4132-9011-4139fcbbe50a","name":"some.example.org"}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new SNI in a workspace
Create a new SNI in a workspace
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the new SNI for creation
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The SNI name to associate with the given certificate.
A string representing a tag.
Unix epoch when the resource was last updated.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The SNI name to associate with the given certificate.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Delete an SNI in a workspace
Delete an SNI in a workspace
Path Parameters
ID of the SNI to lookup
Example:64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted SNI or the resource didn’t exist
Authentication
Path Parameters
Get an SNI in a workspace
Get an SNI using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the SNI to lookup
Example:64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f
The UUID of your control plane. 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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The SNI name to associate with the given certificate.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Upsert a SNI in a workspace
Create or Update SNI using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the SNI to lookup
Example:64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f
The UUID of your control plane. 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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The SNI name to associate with the given certificate.
A string representing a tag.
Unix epoch when the resource was last updated.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The SNI name to associate with the given certificate.
A string representing a tag.
Unix epoch when the resource was last updated.