Docs
Instances

Verify custom domain ownership

POST
/v1/instances/{id}/domains/{domainId}/verify

Checks the exact TXT challenge and atomically reserves the hostname. Only verified names appear in network.hostnames and shared TLS routing. The guest must provide its own TLS certificate; verification does not issue one or prove gateway readiness. Point the hostname at the instance managed name with a CNAME (or the regional gateway address for an apex). DNS lookup failures leave the registration pending. Removed registrations and terminating instances cannot be verified. A hostname previously verified for an org remains reserved to that org even after removal. The same org can verify a fresh registration on another instance once its prior registration is removed. Pending registrations may prepare for this move while the old registration is still active. To switch desired routing atomically, send replaceDomainId naming the exact active registration. Fresh DNS proof must succeed first; then both instance intents change in one transaction. A stale registration id, different hostname/org or deletion of either instance rejects the move without removing the old route. Gateway convergence remains asynchronous. A successful retry with the same Idempotency-Key returns current state without performing another DNS query.

Authorization

headerAuthorizationBearer <cc_...>

An API key of your org, sent as Authorization: Bearer cc_.... Keys start with cc_ and are otherwise opaque. Treat a key as a password: anyone holding it can act with its scopes until it expires or is revoked. Each operation's security requirement lists the scopes it needs; an empty list means any valid key. The MCP server at /mcp accepts agent keys and no other kind.

Scope: instances:write

Path Parameters

id*string

The instance id.

Match^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Length1 <= length <= 63
domainId*string

The custom domain registration id.

Match^d-[a-z2-7]{26}$

Query Parameters

replaceDomainId?string

Atomically replace this exact active registration of the same hostname and org, after fresh DNS proof. Fails if it changed or was removed.

Match^d-[a-z2-7]{26}$

Header Parameters

Idempotency-Key*string

A unique key for this intent, such as a UUID. Reuse it for every retry of the same request. A missing key returns 400 idempotency_key_required. See Idempotency above.

Match^[!-~]+$
Length1 <= length <= 255
Api-Version*string

The API version the request is written against. This document describes 2026-10-15. A missing header returns 400 api_version_required, and a version the API does not serve returns 400 unsupported_api_version.

X-Correlation-ID?string

An id of your own for this request, or for a group of requests, to find them in our logs and yours. Logged with the request and returned unchanged in X-Correlation-ID. The request id itself is always the API's own, in X-Request-ID.

Match^[A-Za-z0-9._:-]+$
Length1 <= length <= 128
Org-Context?string

Admin keys only: the id of the org to act in. Required with an admin key, together with Access-Reason; with any other credential it returns 400 invalid_request. Every request that carries it is recorded in that org's operator-access log.

Match^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Length5 <= length <= 63
Access-Reason?string

Admin keys only: why the operator is acting in the org, such as a support ticket. Required with Org-Context. Recorded, verbatim, in the org's operator-access log.

Match^[^\x00-\x1F\x7F]+$
Length10 <= length <= 500

Response Body

The current custom domain registration; routing converges asynchronously.

application/json
  1. response
id*string
instanceId*string
hostname*string
status*string

Verification records authorization, not dataplane readiness. Removed names cannot be reactivated.

verification*
createdAt*string
Formatdate-time
verifiedAt?string
Formatdate-time
removedAt?string
Formatdate-time
Example Request
curl -X POST 'https://api.cloud.confidential.ai/v1/instances/i-7k2m9q4x1bfa/domains/d-abcdefghijklmnopqrstuvwxyz/verify?replaceDomainId=d-abcdefghijklmnopqrstuvwxyz' \  -H 'Idempotency-Key: 0b9d6c1e-5f8a-4c2e-9a51-2f7e0c3d4b18' \  -H 'Api-Version: 2026-10-15' \  -H 'X-Correlation-ID: rollout-2026-10-22' \  -H 'Access-Reason: Support ticket 4821: customer asked why i-6d3f9h2k8mzr failed'
Example Response
{  "id": "d-abcdefghijklmnopqrstuvwxyz",  "instanceId": "i-7k2m9q4x1bfa",  "hostname": "shop.example.com",  "status": "pending",  "verification": {    "type": "TXT",    "name": "_confidential-cloud.shop.example.com",    "value": "cloud-domain-verification=example"  },  "createdAt": "2026-10-22T17:02:11Z"}