compute
GET /v1/compute/terminal
Whether the web terminal is turned on for an organisation.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
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 GET https://api.zinndigital.com/v1/compute/terminal \
-H "Authorization: Bearer zdk_live_…"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
enabled is true only when BOTH halves exist — the organisation's terminal key is registered as one of its SSH keys, and its private half is in our secret store. public_key is the one line to add to authorized_keys on a machine built before the terminal was turned on. ?org_id= is required only of a caller in more than one organisation. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | — |
public_key | string | Yes | The one line to add to authorized_keys on a machine built before the terminal was turned on. Public by definition — not a secret. "" when the terminal was never on. |
fingerprint | string | Yes | — |
Errors this endpoint can return
401 · 403 · 429