Docs
Instances

List custom domains

GET
/v1/instances/{id}/domains

Lists this instance's custom domain registrations, including removed registrations. Requires instances:read. Results are paginated, newest first.

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:read

Path Parameters

id*string

The instance id.

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

Query Parameters

pageSize?integer

The most items to return.

Range1 <= value <= 100
Default50
pageToken?string

The nextPageToken of the previous page, unchanged. Send the same filters with it.

Length1 <= length <= 2048

Header Parameters

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 instance's registrations, including removed registrations.

application/json
  1. response
items*array<>
nextPageToken?string

Present when another page follows. Send it unchanged as pageToken.

Example Request
curl -X GET 'https://api.cloud.confidential.ai/v1/instances/i-7k2m9q4x1bfa/domains?pageSize=50&pageToken=eyJjIjoiMjAyNi0xMC0yMlQxNzowMjoxMVoiLCJpIjoiaS03azJtOXE0eDFiZmEifQ' \  -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
{  "items": []}

Delete an instance DELETE

Stops the instance and destroys its disks. This cannot be undone. Returns `202` with the instance `terminating` while its guest and disks are removed, and `200` with the `terminated` tombstone once they are gone; a repeat returns whichever applies, for 90 days. Once the instance is `terminated`, its name is free and, in a reservation, its GPUs go back to the reservation. A delete wins over `unknown`. While its host is not reporting, the instance stays `terminating`, with reason `host_unreachable`, until the host reports and removes it or our operators retire the host. Deleting an instance that is `failed` with `host_lost` returns `200` with its tombstone at once. A node of a managed cluster is deleted by its cluster's controllers alone, as it is changed by them alone: this call, and every other that changes an instance, returns `409 invalid_state` for one, with the cluster in `detail`. Replace a node from inside its cluster, or change its pool.

Register a custom domain POST

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.