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

Update an SNI

Create or Update SNI using ID or name.

put

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

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

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

Body

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

CA Certificates

CA certificates

List all CA certificates

Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example /ca-certificates?size=50&tags=enterprise.

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

A successful response listing CA Certificates

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

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

Example:[user-level, low-priority]

get/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates
 
200 application/json