Kong · Schema

Custom Domain

Object containing information about a custom domain for a control-plane.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	object
control_plane_id	object
control_plane_geo	object
domain	object
certificate_id	string	Certificate ID for the certificate representing this domain and stored on data-planes for this control-plane. Can be retrieved via the control-planes API for this custom domain's control-plane.
sni_id	string	Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved via the control-planes API for this custom domain's control-plane.
state	object
state_metadata	object	Metadata describing the backing state of the custom domain and why it may be in an erroneous state.
entity_version	integer	Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom domain.
created_at	string	An RFC-3339 timestamp representation of custom domain creation date.
updated_at	string	An RFC-3339 timestamp representation of custom domain update date.
kind	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomDomain",
  "title": "Custom Domain",
  "x-speakeasy-entity": "CloudGatewayCustomDomain",
  "description": "Object containing information about a custom domain for a control-plane.",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/CustomDomainId"
    },
    "control_plane_id": {
      "$ref": "#/components/schemas/ControlPlaneId"
    },
    "control_plane_geo": {
      "$ref": "#/components/schemas/ControlPlaneGeo"
    },
    "domain": {
      "$ref": "#/components/schemas/CustomDomainName"
    },
    "certificate_id": {
      "description": "Certificate ID for the certificate representing this domain and stored on data-planes for this\ncontrol-plane. Can be retrieved via the control-planes API for this custom domain's control-plane.\n",
      "type": "string",
      "format": "uuid",
      "example": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
      "nullable": true,
      "readOnly": true
    },
    "sni_id": {
      "description": "Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved\nvia the control-planes API for this custom domain's control-plane.\n",
      "type": "string",
      "format": "uuid",
      "example": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
      "nullable": true,
      "readOnly": true
    },
    "state": {
      "$ref": "#/components/schemas/CustomDomainState"
    },
    "state_metadata": {
      "description": "Metadata describing the backing state of the custom domain and why it may be in an erroneous state.\n",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "reported_status": {
          "description": "Reported status of the custom domain from backing infrastructure.",
          "type": "string",
          "example": "INVALID"
        },
        "reason": {
          "description": "Reason why the custom domain may be in an erroneous state, reported from backing infrastructure.\n",
          "type": "string",
          "example": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
        }
      },
      "readOnly": true,
      "title": "CustomDomainStateMetadata"
    },
    "entity_version": {
      "description": "Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom\ndomain.\n",
      "type": "integer",
      "example": 1,
      "readOnly": true
    },
    "created_at": {
      "description": "An RFC-3339 timestamp representation of custom domain creation date.",
      "type": "string",
      "format": "date-time",
      "example": "2022-11-04T20:10:06.927Z",
      "readOnly": true
    },
    "updated_at": {
      "description": "An RFC-3339 timestamp representation of custom domain update date.",
      "type": "string",
      "format": "date-time",
      "example": "2022-11-04T20:10:06.927Z",
      "readOnly": true
    },
    "kind": {
      "$ref": "#/components/schemas/CustomDomainKind"
    }
  },
  "required": [
    "id",
    "control_plane_id",
    "control_plane_geo",
    "domain",
    "state",
    "state_metadata",
    "entity_version",
    "created_at",
    "updated_at"
  ]
}