Upsert a SNI

Create or Update SNI using ID or name.

put

Path Parameters

SNIIdstringrequired

ID of the SNI to lookup

Example:64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

controlPlaneIdstring(uuid)required

The UUID of your control plane. 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.

* Additional properties are NOT allowed.
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.

Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The SNI name to associate with the given certificate.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

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.

* Additional properties are NOT allowed.
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.

Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The SNI name to associate with the given certificate.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

put/control-planes/{controlPlaneId}/core-entities/snis/{SNIId}

Body

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

Schemas

Validate entity schema

Validate schema for an entity

post

Path Parameters

entityNamestringrequired

The name of the entity

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Request body of a Koko entity to validate against its schema

object
* Additional properties are allowed.

Response

200 application/json

Validation result of the request against a schema

messagestring
post/control-planes/{controlPlaneId}/core-entities/schemas/{entityName}/validate

Body

{}
 
200 application/json

Get partial schema

Get the schema for a partial

get

Path Parameters

partialTypestringrequired

The type of a partial

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

The schema for a partial

fieldsarray[object]
* Additional properties are allowed.
get/control-planes/{controlPlaneId}/core-entities/schemas/partials/{partialType}
 
200 application/json

Services

Service entities are abstractions of your microservice interfaces or formal APIs. For example, a service could be a data transformation microservice or a billing API.



The main attribute of a service is the destination URL for proxying traffic. This URL can be set as a single string or by specifying its protocol, host, port and path individually.



Services are associated to routes, and a single service can have many routes associated with it. Routes are entrypoints in Kong Gateway which define rules to match client requests. Once a route is matched, Kong Gateway proxies the request to its associated service. See the Route documentation for a detailed explanation of how Kong proxies traffic.



Services can be both tagged and filtered by tags.