compute
POST /v1/compute/clusters
Create a k3s cluster, optionally with Argo CD.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/compute/clusters \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "zone": <string>, "plan_code": <string>, "image": <string>, "worker_count": <integer> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
202. One control-plane machine and worker_count workers, each an ordinary pay-by-the-hour server, built into a private network. Kubernetes comes from the k3s stable channel and Argo CD from its stable manifests; the versions actually installed are read back from the cluster. ⛔ The balance must cover every machine's runway before anything is built. Quote it first with quoteComputeCluster. Requires billing.payment.manage.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
zone | string | Yes | — |
plan_code | string | Yes | — |
image | string | Yes | — |
worker_count | integer | Yes | — |
install_argocd | boolean | No | — |
deploy_sample_app | boolean | No | Deploy Argo CD's example application through Argo CD. Needs Argo CD. |
ssh_keys | string[] | No | The ids of the authorised keys every node gets, from listComputeSshKeys. Every id must be one of the ordering organisation's own registered keys (listComputeSshKeys for that… |
org_id | Uuid | null | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
deploy_target | string | Yes | — |
zone | string | Yes | — |
plan_code | string | Yes | — |
image | string | Yes | — |
worker_count | integer | Yes | — |
install_argocd | boolean | Yes | — |
deploy_sample_app | boolean | Yes | — |
status | string<pending, provisioning, bootstrapping, ready, failed, terminating, terminated> | Yes | — |
message | string | Yes | — |
kubernetes_version | string | Yes | — |
argocd_version | string | Yes | — |
ready_nodes | integer | Yes | — |
sample_app_health | string | Yes | Argo CD's sync/health for the sample application, e.g. Synced/Healthy. |
api_address | string | Yes | The Kubernetes API's public address (port 6443). |
network_id | string | Yes | — |
nodes | ComputeServer[] | Yes | — |
created_at | string | Yes | — |
ready_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503