Skip to main content
POST
Verify a domain

Authorizations

Authorization
string
header
required

A personal access token (POST /v1/auth/tokens) or a machine identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens), both prefixed qumo_pat_. A token's scopes cap what it can do; see Scopes and permissions. A personal token names no organization: on a route whose path names no project or organization, pass ?organization_id=.

Path Parameters

id
string<uuid>
required

The organization's id.

domainID
string<uuid>
required

The domain's id.

Response

The record was found; the domain is verified.

id
string<uuid>
required
Example:

"6e2a8c4f-1b3d-4a5e-9f7c-2d4b6a8e0c1f"

organization_id
string<uuid>
required
Example:

"3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c"

domain
string
required

The normalized name, lowercase ASCII with no trailing dot.

Example:

"acme.example"

status
enum<string>
required

pending until the record is found. verified once it is: the domain belongs to this organization alone. lapsed when a re-check found the record gone: everything keeps working until grace_ends_at, 14 days on, while Organization Admins are alerted. frozen after that: logins are not routed by the domain and no new users are provisioned under it, and no other organization can claim it. Verifying again restores a lapsed or frozen domain.

Available options:
pending,
verified,
lapsed,
frozen
verification
object
required

The DNS record that proves control of the domain. Keep it published while the domain is claimed; every re-check looks for it.

created_by
string<uuid>
required
created_at
string<date-time>
required
verified_at
string<date-time> | null
required

The last time the record was found.

last_checked_at
string<date-time> | null
required
lapsed_at
string<date-time> | null
required
grace_ends_at
string<date-time> | null
required

When a lapsed domain is frozen unless the record is back.

frozen_at
string<date-time> | null
required
last_check_error
string

Why the last check did not find the record; absent when it did.

Example:

"TXT record not found"