Custom Domains

Get Custom Domain Online Status

Changed on

Checks whether the primary domain CNAME and ACME challenge CNAME records are correctly configured at your DNS registrar. Returns verified or unverified for each.

get/v2/cloud-gateways/custom-domains/{customDomainId}/online-status

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/cloud-gateways/custom-domains/{customDomainId}/online-status
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

customDomainIdstring uuid required
Example:39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Response

Response format for retrieving the CNAME and SSL status of a custom domain.

cname'verified' | 'unverified' required

Set of available statuses for the online properties of a custom domain.

ssl'verified' | 'unverified' required

Set of available statuses for the online properties of a custom domain.

Changes

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status