Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong SNIs API

An SNI object represents a many-to-one mapping of hostnames to a certificate.A certificate object can have many hostnames associated with it. When Kong Gateway receives an SSL request, it uses the SNI field in the Client Hello to look up the certificate object based on the SNI associated with the certificate.

Kong SNIs API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include SNIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 14 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

14 operations 6 paths 6 schemas 3 DELETE5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong SNIs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 14

Across 6 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

SNIs 14

An SNI object represents a many-to-one mapping of hostnames to a certificate. A certificate object can have many hostnames associated with it. When Kong Gateway receives an SSL re…

POST
/{workspace}/snis
Create a new SNI
create-sni 1 param body → 201401
DELETE
/{workspace}/snis/{SNIIdOrName}
Delete an SNI
delete-sni 3 params → 204401
GET
/{workspace}/snis/{SNIIdOrName}
Get an SNI
get-sni 2 params → 200401404
PUT
/{workspace}/snis/{SNIIdOrName}
Upsert a SNI
upsert-sni 2 params body → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis
List all SNIs associated with a Certificate
list-sni-with-certificate 5 params → 200
POST
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis
Create a new SNI associated with a Certificate
create-sni-with-certificate 2 params body → 201
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis/{SNIId}
Delete a an SNI associated with a Certificate
delete-sni-with-certificate 3 params → 204
GET
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis/{SNIId}
Get an SNI associated with a Certificate
get-sni-with-certificate 3 params → 200404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis/{SNIId}
Upsert an SNI associated with a Certificate
upsert-sni-with-certificate 3 params body → 200
GET
/v2/control-planes/{controlPlaneId}/core-entities/snis
List all SNIs
list-sni 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/snis
Create a new SNI
create-sni 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/snis/{SNIId}
Delete an SNI
delete-sni 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/snis/{SNIId}
Get an SNI
get-sni 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/snis/{SNIId}
Upsert a SNI
upsert-sni 2 params body → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SNIWithoutParents (6 properties), SNI (6 properties), SNI_2 (6 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.

PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
GatewayUnauthorizedError
object
2 properties 2 required
PaginationNextResponse
string
URI to the next page (may be null)
SNI_2
object
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 Ko…
6 properties 2 required
SNI
object
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 Ko…
6 properties 2 required
SNIWithoutParents
object
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 Ko…
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-snis-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API