Skip to main content
POST
Verify a custom resolver hostname

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Organization UUID.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json
hostname
string
required

The registered hostname to verify ownership for.

Response

OK

hostname
string
required

The customer-owned hostname, normalized lowercase.

status
enum<string>
required

Ownership-verification state.

Available options:
PENDING,
VERIFIED,
DISABLED
tls_status
enum<string>
required

Edge-certificate state (read-only; driven by the cert pipeline).

Available options:
NOT_REQUESTED,
PENDING,
ACTIVE,
FAILED
is_qr_ready
boolean
required

True when this hostname is VERIFIED and its edge cert is ACTIVE — QRs may print against it.

fallback_mode
enum<string>
required

Unresolved-scan fallback policy (C-4755). hosted_404 (default) or redirect.

Available options:
hosted_404,
redirect
setup
CustomHostnameSetupOut · object
required

DNS records to publish for this hostname.

Example:
verified_at
string | null

ISO-8601 timestamp of the last successful verification, or null.

last_checked_at
string | null

ISO-8601 timestamp of the last verification attempt, or null.

last_error
string
default:""

Reason the last verification attempt failed (empty on success).

tls_last_error
string
default:""

Reason the last certificate issuance or renewal check failed (empty on success).

tls_retry_after
string | null

ISO-8601 time before which certificate issuance will not be retried, or null when not in cooldown.

tls_expires_at
string | null

ISO-8601 expiry of the certificate seen at the last successful probe, or null.

fallback_redirect_url
string
default:""

Redirect-mode destination. Empty unless fallback_mode is redirect.

Maximum string length: 2048
fallback_utm_source
string
default:""

UTM source override for redirect-mode fallback. Empty = platform default.

Maximum string length: 255
fallback_utm_medium
string
default:""

UTM medium override for redirect-mode fallback. Empty = platform default.

Maximum string length: 255
fallback_utm_campaign
string
default:""

UTM campaign override for redirect-mode fallback. Empty = platform default.

Maximum string length: 255
fallback_utm_term
string
default:""

UTM term override for redirect-mode fallback. Empty = platform default.

Maximum string length: 255
fallback_utm_content
string
default:""

UTM content override for redirect-mode fallback. Empty = platform default.

Maximum string length: 255