Kong · Schema

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.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
certificate object 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.
created_at integer Unix epoch when the resource was created.
id string A string representing a UUID (universally unique identifier).
name string The SNI name to associate with the given certificate.
tags array An optional set of strings associated with the SNIs for grouping and filtering.
updated_at integer Unix epoch when the resource was last updated.
View JSON Schema on GitHub

JSON Schema

kong-sni-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SNI",
  "title": "SNI",
  "x-speakeasy-entity": "SNI",
  "description": "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.",
  "type": "object",
  "properties": {
    "certificate": {
      "description": "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.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "x-foreign": true
    },
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "name": {
      "description": "The SNI name to associate with the given certificate.",
      "type": "string"
    },
    "tags": {
      "description": "An optional set of strings associated with the SNIs for grouping and filtering.",
      "type": "array",
      "items": {
        "description": "A string representing a tag.",
        "type": "string"
      },
      "nullable": true
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "integer",
      "nullable": true
    }
  },
  "example": {
    "certificate": {
      "id": "bd380f99-659d-415e-b0e7-72ea05df3218"
    },
    "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
    "name": "some.example.org"
  },
  "additionalProperties": false,
  "required": [
    "name",
    "certificate"
  ]
}