---
title: "Dedicated Custom Domain"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/fec2814b-b34b-4614-bacd-b3f0b84c6195/schemas/DedicatedCustomDomain"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/fec2814b-b34b-4614-bacd-b3f0b84c6195.md

# Dedicated Custom Domain

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 3.0.0
servers:
  - url: https://global.api.konghq.com/v3
    description: Base URL for the global region
components:
  schemas:
    BaseCustomDomain:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/CustomDomainId"
        kind:
          type: string
          enum:
            - dedicated.v0
            - serverless.v0
            - serverless.v1
        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

            control-plane. Can be retrieved via the control-planes API for this
            custom domain's control-plane.
          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

            via the control-planes API for this custom domain's control-plane.
          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.
          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.
              type: string
              example: >
                CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.'
                instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'
          readOnly: true
          title: CustomDomainStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the custom domain, to
            indicate the order of updates to the custom

            domain.
          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
      discriminator:
        propertyName: kind
        mapping:
          serverless.v0: "#/components/schemas/ServerlessCustomDomain"
          dedicated.v0: "#/components/schemas/DedicatedCustomDomain"
          serverless.v1: "#/components/schemas/ServerlessV1CustomDomain"
      required:
        - id
        - kind
        - control_plane_id
        - control_plane_geo
        - domain
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
      title: Base Configuration
    CustomDomainId:
      type: string
      format: uuid
      example: 39ed3790-085d-4605-9627-f96d86aaf425
      readOnly: true
    ControlPlaneId:
      type: string
      format: uuid
      example: 0949471e-b759-45ba-87ab-ee63fb781388
    ControlPlaneGeo:
      description: Set of control-plane geos supported for deploying cloud-gateways
        configurations.
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
        - sg
      title: Control-Plane Geo
    CustomDomainName:
      description: Domain name of the custom domain.
      type: string
      example: example.com
      title: Custom Domain Name
    CustomDomainState:
      description: State of the custom domain.
      type: string
      enum:
        - created
        - initializing
        - ready
        - terminating
        - terminated
        - error
      readOnly: true
      title: Custom Domain State
    DedicatedCustomDomain:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseCustomDomain"
        - properties:
            kind:
              type: string
              enum:
                - dedicated.v0
          required:
            - kind
      title: Dedicated Custom Domain
```
