Register a custom domain
Creates a pending ownership challenge for an exact lowercase hostname. Publish the returned TXT record, then call verifyInstanceDomain. A CNAME alone never activates shared ingress. The instance must have a managed hostname and port 443 open. At most 14 current registrations per instance. Repeated registration of the same current hostname returns its challenge. Pending challenges do not reserve a hostname against another tenant. Wildcards, IP addresses and names under platform-managed domains are refused.
AuthorizationBearer <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
id*stringThe instance id.
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$1 <= length <= 63Idempotency-Key*stringA 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.
^[!-~]+$1 <= length <= 255Api-Version*stringThe 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?stringAn 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.
^[A-Za-z0-9._:-]+$1 <= length <= 128Org-Context?stringAdmin 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.
^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$5 <= length <= 63Access-Reason?stringAdmin 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.
^[^\x00-\x1F\x7F]+$10 <= length <= 500application/json- body
hostname*stringExact lowercase ASCII hostname; use punycode for internationalized names. Each label is at most 63 characters.
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)+$3 <= length <= 233The current custom domain registration; routing converges asynchronously.
application/json- response
id*stringinstanceId*stringhostname*stringstatus*stringVerification records authorization, not dataplane readiness. Removed names cannot be reactivated.
verification*createdAt*stringdate-timeverifiedAt?stringdate-timeremovedAt?stringdate-timecurl -X POST 'https://api.cloud.confidential.ai/v1/instances/i-7k2m9q4x1bfa/domains' \ -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' \ -H 'Content-Type: application/json' \ -d '{ "hostname": "shop.example.com"}'{ "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"}List custom domains GET
Lists this instance's custom domain registrations, including removed registrations. Requires instances:read. Results are paginated, newest first.
Remove a custom domain DELETE
Cancels a pending challenge or withdraws a verified hostname from shared TLS routing. Deletion is durable and cannot be undone by a delayed DNS check. Gateway convergence is asynchronous. Verified hostname reservations remain held by the org after removal or instance deletion. A fresh registration and TXT proof can move the name within that org after removal; during convergence it may still reach the prior instance. Transfer to another org requires operator-assisted withdrawal/recovery. Retrying returns the removed registration. Requires instances:write.