Docs
Instances

Open a port on an existing instance

POST
/v1/instances/{id}/ingress

Adds an ingress rule to an instance without recreating the VM or its disks, and without changing its address, its other endpoints or any open connection. Requires Idempotency-Key. The rule follows the rules of network.ingress at create: one TCP port, open to the internet, at most 16 rules at a time, and never the image's attestation port while the image exposes it as attest. A private attestation port, such as a c8s node's 8443, a rule may open.

Returns 202 with the instance while the location applies the rule. The response already lists the rule in network.ingress and its endpoint in endpoints: on a shared address the platform picks the external port, and on a dedicated address the endpoint uses the guest's own port. network.ingressUpdating is true until the location has applied the instance's latest rule change; connect once it is absent. A rule that already exists with the same name and port changes nothing and returns 200.

A name or a port that another rule of the instance uses returns 409 name_conflict, with details.conflictingNames naming that rule. A seventeenth rule, an instance that is failed, terminating or terminated, and an IPv4 transition in adding or removing return 409 invalid_state. A public attestation port returns 422 unsupported_combination with violation incompatible at /port. A shared address with no free port returns 409 insufficient_capacity.

A rule on port 443 also opens the instance's hostnames (network.hostnames) on their port 443.

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

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

Request Body

application/json
  1. body

A TCP port to expose.

name*IngressName

The endpoint's name. Unique within the request. attest is reserved.

Match^[a-z]([-a-z0-9]*[a-z0-9])?$
Length1 <= length <= 15
port*integer

The port the guest listens on. Unique within the request, and not the image's attestationPort.

Range1 <= value <= 65535

Response Body

The instance with its ingress rules as requested and their endpoints.

application/json
  1. response

A confidential virtual machine.

id*InstanceId

Opaque. Starts with i-, is a lowercase DNS label of at most 63 characters, and may change length or form within those rules.

Match^i-[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Lengthlength <= 63
name?string

The instance's name, from its create or its latest rename. Absent if neither gave one.

Lengthlength <= 63
project*ProjectName

The project the instance belongs to. Every org has one project, default, in this version.

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

Only when status is unknown, the status before the host stopped reporting.

statusReason?

Why the instance is in its status. Absent when there is nothing to add.

statusChangedAt*string

When status last changed.

Formatdate-time
lastKnownStatus?InstanceStatus

Only when status is unknown, the status before the host stopped reporting.

conditions*array<>

Signals about the instance, Kubernetes style. A new instance has none. No condition ever says whether the instance can be trusted: verify that yourself.

tee*Tee

The trusted execution environment. Open set; accept values not listed.

location*LocationId

A location id from GET /v1/locations, such as us-west-1.

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

A size id from GET /v1/sizes, such as s1.4x. Read ids from that list; do not build them.

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

The resolved size.

image*

The image version and artifact the instance boots.

container?

The OCI image the instance runs as its only workload, present when the create's image named one. The instance's image pulls it by digest at every boot and runs it on the instance's network.

disks*array<>

The writable disks, in the order the create listed them.

network*

How the instance is reached.

readiness?

The guest ports Reachable waits on, as the create named them or the image's default.

endpoints*array<>

Where to reach the instance: one entry per ingress rule and, when the image's attestationPublic is true, one named attest for its attestation service, on the public IPv4 address, and the same again on the instance's IPv6 address on the guest's own ports where the location routes IPv6. A rule on port 443 has one more for each of the instance's hostnames, on the name's port 443. An endpoint never changes while the instance holds its address: the platform's ports on the shared address and its names for the instance's life, and an address attached to it until it is detached. Those of the create are assigned when it is accepted, so the 202 response carries them. Empty once the instance is terminated.

privateAddress?string

The instance's address on its private network. Present only with network.privateNetwork, from the moment the create is accepted until the instance is terminated.

Formatipv4
boot*

Every boot is a fresh measured launch, and every disk whose encryption is guest starts it empty, under a new key. If you hold a session to an attested key, attest again when count moves.

access?

The SSH keys written to the launch disk, in order, each normalised as the create describes and without its line feed: the pubkey file is these strings, each followed by a line feed.

trust?

The launch key written to the launch disk, exactly as the create gave it, and the format of the launch document. The document itself is never returned.

attestation*

What you need to verify the instance yourself. The API never says whether an instance can be trusted.

reservation?ReservationId

The GPU reservation the instance draws on. Only for GPU sizes.

Match^r-[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Lengthlength <= 63
purchaseOption?PurchaseOption

How the instance was bought: on-demand, reservation or spot. A spot instance runs on GPUs that no active reservation holds, and is stopped, never deleted, when something of higher priority needs them (the Spot GPUs rules above).

maintenanceEventId?string

The instance's open maintenance event, if it has one: GET /v1/instances/{id}/maintenance returns it.

preemptAt?string

Only while the reason is preempting: when the platform will stop the instance, 60 seconds after its guest was asked to shut down.

Formatdate-time
terminationAt?string

When the platform will delete the instance: the end of its reservation. Only for instances in a reservation.

Formatdate-time
expiresAt?string

When the platform will delete the instance, as a delete request would, leaving a tombstone with reason expired. Absent when the instance does not expire; every instance an agent credential creates has one. POST /v1/instances/{id}/extend moves it later.

Formatdate-time
gpuMetrics?boolean

Whether Confidential Cloud reads the GPU metrics this instance's guest serves on TCP 9400, for your org's metrics and Instances dashboard. On for an image whose launch.gpuMetrics is true unless its create turned it off, and off for any other image; fixed for the instance's life, and in its measured pubkey file when on. Only for sizes with GPUs, and absent for the others.

placement?
role?string

Only on a node of a managed Kubernetes cluster, which the cluster's controller created and only the cluster replaces or deletes: worker for a node of a node pool, cds for a replica of the cluster's CDS. Open set; accept values not listed. The controller's create stated it and it never changes. No label says this: role is absent on an instance you created, whatever its labels.

cluster?ClusterId

The managed cluster the instance is a node of, which its controller's create recorded. Only with role. No label says this.

Match^cl-[0-9a-f]{16}$
nodePool?NodePoolName

The node pool the instance is a node of. Only with the role worker.

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

Which replica of its cluster's CDS the instance is, from 0. Only with the role cds.

Range0 <= value <= 99
labels*

Labels. May include keys with a reserved prefix, such as cloud.confidential.ai/, which the platform sets.

createdAt*string

When the create was accepted.

Formatdate-time
Example Request
curl -X POST 'https://api.cloud.confidential.ai/v1/instances/i-7k2m9q4x1bfa/ingress' \  -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 '{  "name": "web",  "port": 8080}'
Example Response
{  "id": "i-2h6c9w4m8tnb",  "name": "sandbox",  "project": "default",  "status": "running",  "statusChangedAt": "2026-10-22T09:16:02Z",  "conditions": [    {      "type": "Reachable",      "status": "True",      "reason": "TcpDialSucceeded",      "message": "The guest's wait ports accepted connections from inside our network.",      "lastTransitionTime": "2026-10-22T09:16:20Z"    }  ],  "tee": "tdx",  "location": "us-west-1",  "size": "s1.2x",  "compute": {    "vcpus": 2,    "memoryGiB": 8  },  "image": {    "family": "confos-cpu",    "version": "2026.10.2",    "launch": "general-purpose/1",    "digest": "sha256:8c780b3655fc55a663ed38174927e149157c6d2bedf81b9ce60a0a6d8ec33947"  },  "disks": [    {      "name": "user-data",      "type": "scratch",      "sizeGiB": 40,      "encryption": "none"    }  ],  "network": {    "publicIp": "shared",    "ingress": [      {        "name": "ssh",        "port": 22      },      {        "name": "web",        "port": 8080      }    ],    "ingressUpdating": true  },  "endpoints": [    {      "name": "ssh",      "host": "203.0.113.10",      "ipVersion": "ipv4",      "port": 20024    },    {      "name": "web",      "host": "203.0.113.10",      "ipVersion": "ipv4",      "port": 20025    },    {      "name": "attest",      "host": "203.0.113.10",      "ipVersion": "ipv4",      "port": 29842    }  ],  "boot": {    "count": 1,    "startedAt": "2026-10-22T09:16:02Z"  },  "access": {    "sshKeys": [      "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHwcz1ZWdpesQj0g1D1Cdceg8JdZMFFgKA+foafqkkUg alice@example.com"    ]  },  "attestation": {    "endpoint": "attest",    "referenceManifest": {      "uri": "https://measurements.example/confos-cpu/2026.10.2/tdx/manifest.json",      "digest": "sha256:472d2826575f5b45c0b463738780a3200de086f98737e7b5bf5298b02a475308",      "logEntry": "rekor:1293847"    },    "launchBinding": {      "file": "pubkey",      "sha256": "e52aa028552af775a3aa80566fcf1ef2f9210870656859d03111f2359e8cd5f7",      "sha384": "00cc08934f0fadc537830d00499abdec1da4271756307f822a8ee1cae83d30b0b3b8b4442bc7215e67e2d0751bd54ae5"    }  },  "expiresAt": "2026-10-24T09:15:00Z",  "labels": {    "purpose": "sandbox"  },  "createdAt": "2026-10-22T09:15:00Z"}

Remove an instance's dedicated IPv4 DELETE

Switches the instance back to shared IPv4 without recreating its VM or disks. Accepts an optional Idempotency-Key for response replay. Shared ingress ports and outbound capacity are reserved before the switch. Existing connections may need to reconnect; use the endpoints returned by this operation. Returns 202 while the location's network applies the shared configuration and withdraws the dedicated address's routing and its connections. network.ipv4Activating remains true until that cleanup is done. Only then is the dedicated address released into its reuse hold. Returns 200 when the instance already uses shared IPv4. A request waiting for dedicated stock is cancelled without allocating an IP. Another active network transition or a terminating or terminated instance returns 409 invalid_state. If shared network capacity is unavailable, returns 409 insufficient_capacity and keeps the dedicated address. The caller may add a dedicated IPv4 again later.

Close a port on an existing instance DELETE

Removes an ingress rule from an instance without recreating the VM or its disks. Connections on that rule's port end. The instance's address, its other rules, their connections and its outbound connections are unaffected. Accepts an optional Idempotency-Key for response replay. Returns 202 with the instance while the location closes the port. The rule and its endpoint are already gone from the response, and `network.ingressUpdating` is true until the location has applied the change: until then the port may still accept connections. An instance with no rule of that name returns `404 not_found`. An instance that is `failed`, `terminating` or `terminated`, and an IPv4 transition in `adding` or `removing`, return `409 invalid_state`. The attestation endpoint `attest`, where the image has one, is not a rule and cannot be removed: its name fails the path's schema with `400 invalid_request`. Removing the rule on port 443 stops routing the instance's hostnames; custom domain registrations stay, and are routed again once a rule opens port 443. On a shared address a rule added again later may get a different external port.