Docs
Organization

List the org's audit events

GET
/v1/audit-events

Lists who changed what in the org, newest first: one event for each change an API call made, with the credential it came with, kept for as long as the org exists. A change's event is written in the same transaction as the change. resource lists the events of one resource, such as an instance's or a cluster's, including those from before it was deleted; its create is its oldest.

Authorization

oauth2 audit:read
headerAuthorizationBearer <token>

A person's access token, sent as Authorization: Bearer <token>, from the authorization code flow with PKCE (S256). A CLI on a machine without a browser can use the device flow (RFC 8628) at https://auth.confidential.ai/oauth2/device_authorization instead. Ask for the resource https://api.cloud.confidential.ai (RFC 8707): a token issued for any other resource, the MCP server's included, is refused. A token acts for one person in one org, with the scopes of the person's role there whatever the client asks for, so ask the authorization server for none of the scopes below; they are listed so that each operation can name the ones it needs. Access tokens last minutes, and a refresh token is replaced at every use.

Scope: audit:read

Query Parameters

resource?string

Only the events that name this resource, by its id.

Length1 <= length <= 128
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

A page of the org's audit events, newest first.

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

Pass it back as pageToken for the next page. Absent on the last page.

Example Request
curl -X GET 'https://api.cloud.confidential.ai/v1/audit-events?resource=i-2h6c9w4m8tnb&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": [    {      "id": "ae-1042",      "at": "2026-10-23T08:00:00Z",      "action": "deleteInstance",      "resources": [        "i-2h6c9w4m8tnb"      ],      "actor": {        "userId": "user_01JABCDEF",        "agent": false      },      "status": 202,      "requestId": "req_7Kq2"    },    {      "id": "ae-1017",      "at": "2026-10-22T09:15:00Z",      "action": "createInstances",      "resources": [        "i-2h6c9w4m8tnb"      ],      "actor": {        "apiKey": {          "id": "k-7k2m9q4x1bfa",          "name": "training-agent"        },        "agent": true      },      "mcpTool": "create_instances",      "status": 202,      "requestId": "req_3Hx9",      "correlationId": "task-42"    }  ]}

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.

List your organizations GET

Lists every organization the signed-in person is a member of, with their role in each, for the console's organization picker. Each token acts in one of them, marked `current`; to act in another, sign in again and pick it. Only people signed in to the console can list them, and nothing but each org's ids, its name and the person's role is returned.