Create an API key
Creates a standard or agent key with only scopes the caller holds. The secret is returned once; an idempotent replay returns metadata without the secret. If the original response is lost, revoke the key and create another. Agent keys expire after 30 days by default and within 90 days at most.
oauth2 keys:writeAuthorizationBearer <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: keys:write
Idempotency-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
name*string\S1 <= length <= 100kind*string^(standard|agent)$scopes*array<>1 <= itemsexpiresInDays?integerAgent default is 30 days; standard keys without this field do not expire.
1 <= value <= 90Create an API key.
application/json- response
key*secret?stringShown only in the original response, never on replay or in a list.
curl -X POST 'https://api.cloud.confidential.ai/v1/api-keys' \ -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": "CI deploys", "kind": "standard", "scopes": [ "instances:read" ], "expiresInDays": 30}'{ "key": { "id": "k-7k2m9q4x1bfa", "name": "CI deploys", "kind": "standard", "scopes": [ "instances:read" ], "createdAt": "2026-10-10T09:00:00Z", "issuedBy": "user_alice", "expiresAt": "2026-11-09T09:00:00Z" }, "secret": "cc_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}