Sign in
Frontends

Get frontend custom domain status

Changed on
get/projects/{id}/frontends/{frontendId}/domain

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/frontends/{frontendId}/domain
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

frontendIdstring uuid required

Frontend ID

Response

Frontend custom domain status, or null when the frontend has no custom domain configured (the common empty state).

domainstring required
tls_mode'managed' | 'byoc' required
domain_status'pending_verification' | 'provisioning' | 'active' | 'detaching' | 'failed' | 'deleted' required
verification_status'pending' | 'verified' | 'failed' required

verified: the domain is served by a validated certificate. pending: it is not served yet, is being re-validated after its certificate material was withdrawn, or Volcano is retrying after a failure. failed: a failure left the domain unserved, alongside domain_status: failed; managed domains report the cause in failure_reason.

failure_reasonstring

Failure category, present only when managed TLS setup has failed. Current values are provider, certificate, ownership, and internal; ownership means another account has already claimed the hostname through ownership verification. Treat unrecognized values as internal.

routing_target_hostnamestring

DNS routing target hostname for this frontend. The DNS record type depends on whether the custom domain is a zone apex.

effective_urlsstring[] required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • f0670c84c817Revision changes
    • ▲

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

    • ▲

      removed the required property ///// from the response with the status

    • ▲

      removed the required property ///// from the response with the status

    • ▲

      removed the required property ///// from the response with the status

    • ●

      added the new failed enum value to the //// response property for the response status

    • ○

      added the optional property //// to the response with the status

    • ○

      added the optional property //// to the response with the status

    • ○

      added to the //// response property allOf list for the response status

    • ○

      response property allOf[FrontendCustomDomainResponse]/required_routing_record deprecated