Get an instance's maintenance
Returns the instance's open maintenance event, which the instance's
maintenanceEventId names: maintenance the platform needs the
instance to take. Restart the instance before the event's deadline
to take it when it suits you. An instance with no open event returns
404 not_found.
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:read
id*stringThe instance id.
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$1 <= length <= 63Api-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 <= 500The instance's open maintenance event.
application/json- response
Maintenance the platform needs an instance to take. Restart the
instance (POST /v1/instances/{id}/restart) before deadline to
take it when it suits you; at deadline the platform restarts it,
as that restart would, if it is still running with no reason
(one whose host is silent then restarts once it runs again). A
host's instances restart one at a time, at least two minutes
apart, so one may restart some minutes after its deadline. The
event is over once a later boot runs, or the instance is deleted.
An instance has at most one open event, and its
maintenanceEventId names it.
id*stringOpaque. Starts with mnt-.
length <= 63instanceId*InstanceIdOpaque. Starts with i-, is a lowercase DNS label of at most 63
characters, and may change length or form within those rules.
^i-[a-z0-9]([-a-z0-9]*[a-z0-9])?$length <= 63reason*MaintenanceReasonOpen set; accept values not listed. host_software_update: the
host's virtualization software, or its settings for the instance,
were updated, and the instance's boot still runs as it started. A
restart runs it on the update. gpu_failure: the host found a GPU
the instance's boot holds faulty: fallen off its bus, or a fatal
PCIe error. A restart resets the instance's GPUs.
description*stringWhat the reason means for the instance, in a sentence.
createdAt*stringdate-timedeadline*stringBy when to restart the instance onto the maintenance: seven days
after createdAt. The platform restarts it then.
date-timecurl -X GET 'https://api.cloud.confidential.ai/v1/instances/i-7k2m9q4x1bfa/maintenance' \ -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'{ "id": "mnt-6ak4v2rqz7b3nxw5hc9dmf8tpe", "instanceId": "i-2h6c9w4m8tnb", "reason": "host_software_update", "description": "The host's virtualization software or its settings for this instance were updated. Restart the instance to run it on the update.", "createdAt": "2026-11-07T10:00:00Z", "deadline": "2026-11-14T10:00:00Z"}Restart a running instance POST
Shuts down the guest of a `running` instance and starts it again on the same host, and returns it `running` with reason `restarting` until the next boot runs. Requires `Idempotency-Key`. The guest gets an ACPI power-button press and up to five minutes to shut down before it is stopped. The next boot has the same disks, addresses, endpoints and SSH or launch keys, on a new launcher, so a change to the host's side of the guest takes effect; as after any boot, disks whose `encryption` is `guest` read as empty. The boot the platform last saw is the one restarted: a boot that began since, such as one after a reboot inside the guest, counts as the restart. A restart is not one of the guest's own exits. An instance in any other status, or being stopped, returns `409 invalid_state`; a retry with the same `Idempotency-Key` returns the first answer.
List open maintenance events GET
Lists the open maintenance events of the org's instances, newest first: the instances the platform needs restarted, and by when.