Skip to main content
POST
Disable 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.

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).