Docs
Clusters

Create a cluster

POST
/v1/clusters

Creates a managed Kubernetes cluster, and the node pools the request lists, and returns it provisioning. Requires Idempotency-Key. Managed Kubernetes is enabled per org: without it, the call returns 403 feature_not_enabled.

The control plane runs in our management cluster, as API server pods whose state is the cluster's own etcd, and is reached at endpoint.hostname on 443. Nodes are instances that join it. Every pool in the request is checked before the create is accepted, so a bad pool refuses the whole create. Wait on observedGeneration and the conditions, as on any Kubernetes object.

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: clusters:write

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 managed Kubernetes cluster, and the pools to create with it. Each field maps to one field of an upstream object: Cluster API's Cluster and Kamaji's KamajiControlPlane for the cluster, and a MachineDeployment for each pool.

name*ClusterNameSpec

A name unique among the clusters of the project, a deleted one's included until it is gone: a lowercase DNS label of at most 40 characters that does not begin with cl-, so that no name looks like a cluster id. It names the cluster's objects in management.

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

The project to create the cluster in. default without it.

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

The cluster's location and its pools' default, from GET /v1/locations. Without it, the default location of tee; without either, 400 invalid_request.

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

The TEE of every node. Without it, the TEE whose default location location is.

kubernetesVersion*KubernetesVersion

A supported Kubernetes version, v and its major, minor and patch numbers.

Match^v[0-9]+\.[0-9]+\.[0-9]+$
Lengthlength <= 32
controlPlane?

The cluster's API servers, which run as pods in our management cluster, not as instances.

auditLogs?boolean

Ship the API server's audit log to you, as component audit of the cluster's logs. Set only at create; a PATCH that changes it is 400 invalid_request with the violation not_allowed.

Defaultfalse
paused?boolean

Stop Cluster API from changing the cluster, as spec.paused does: machines being created finish, and nothing new starts.

Defaultfalse
nodePools?array<>

Pools to create with the cluster, as POST /v1/clusters/{id}/node-pools takes them. Optional; pools can be added later.

Itemsitems <= 16
Default[]
labels?

Up to 64 labels, as in Kubernetes. A key is an optional prefix and /, then a name of up to 63 letters, digits, -, _ and ., starting and ending with a letter or digit. The prefix is a DNS subdomain of at most 253 characters, and prefixes in the domains confidential.ai, kubernetes.io and k8s.io are reserved for the platform. A value is empty or follows the same rule as the name. Labels are not secret: never put a secret in one.

Propertiesproperties <= 64

Response Body

Accepted, with the cluster's new generation. Management converges on it from here; observedGeneration reaches it once it has. A replay returns the cluster's current state.

application/json
  1. response

A managed Kubernetes cluster. It never holds a credential.

id*ClusterId

cl- and 16 lowercase hex digits, a DNS label that names the cluster in management.

Match^cl-[0-9a-f]{16}$
name*string
Lengthlength <= 63
project*ProjectName

A project name. default is the only project in this version.

Match^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Length1 <= length <= 63
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
tee*Tee

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

kubernetesVersion*KubernetesVersion

The version the cluster asks for. The control plane reports the one it runs in the conditions.

Match^v[0-9]+\.[0-9]+\.[0-9]+$
Lengthlength <= 32
c8sRelease*C8sRelease

The c8s release the cluster runs, until an upgrade to another is done.

Match^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9]+-g[0-9a-f]{7,40})?$
Lengthlength <= 63
upgrade?

The cluster's upgrade, absent when it has none. kubernetesVersion stays what the cluster runs until the upgrade is done.

controlPlane*
auditLogs*boolean
paused*boolean
status*ClusterStatus

Open set; accept values not listed. provisioning until the control plane first becomes available; running; updating while Cluster API rolls out or scales; unknown while Cluster API cannot reach the cluster's API server (RemoteConnectionProbe is False) or cannot tell whether it is available (Available is Unknown): its workloads probably still run; terminating after a delete, until Cluster API has torn it down. A cluster that answers but is not available stays running, with Available False and its reason.

statusChangedAt*string

When status last changed.

Formatdate-time
conditions*array<>

The Cluster's conditions. A new cluster has none.

generation*integer

The Cluster's metadata.generation, which every accepted change to the cluster or its pools raises.

Range1 <= value
observedGeneration*integer

The last generation Cluster API has reconciled, which its topology has rendered. 0 until it has reconciled the first.

Range0 <= value
endpoint*

Where the cluster's API server is reached. Workers join and kubelets connect at the same hostname.

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
curl -X POST 'https://api.cloud.confidential.ai/v1/clusters' \  -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": "inference",  "location": "us-west-1",  "tee": "tdx",  "kubernetesVersion": "v1.36.4",  "controlPlane": {    "replicas": 3  },  "auditLogs": true,  "nodePools": [    {      "name": "web",      "size": "c1.4x",      "replicas": 2    },    {      "name": "gpu",      "size": "g1-b300.2x",      "autoscaling": {        "min": 0,        "max": 2      },      "reservation": "r-5mf2k9x3qp"    }  ],  "labels": {    "team": "inference"  }}'
Example Response
{  "id": "cl-0123456789abcdef",  "name": "inference",  "project": "default",  "location": "us-west-1",  "tee": "tdx",  "kubernetesVersion": "v1.36.4",  "c8sRelease": "v0.99.35-4-ga8ecf448d",  "controlPlane": {    "replicas": 3,    "size": "small"  },  "auditLogs": true,  "paused": false,  "status": "provisioning",  "statusChangedAt": "2026-10-24T22:00:00Z",  "conditions": [],  "generation": 1,  "observedGeneration": 0,  "endpoint": {    "hostname": "cl-0123456789abcdef.us-west-1.k8s.confidential.ai"  },  "labels": {    "team": "inference"  },  "createdAt": "2026-10-24T22:00:00Z"}