compute
POST /v1/compute/servers/{serverId}/console
Open an out-of-band console onto a server.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.restart; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/console \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
⭐⭐ **The control that works when SSH does not** — a bad firewall rule, a broken `sshd` config, a full disk, a kernel that will not boot. It is what turns "my server is unreachable, open a ticket" into something the customer fixes themselves. ⛔ **POST, not GET, because it MINTS a credential.** It is not idempotent, not cacheable, and must never end up in a browser history, a proxy log or a prefetch. The response carries a one-shot URL that reaches the machine's console as if sitting at its keyboard; it is returned once and stored nowhere. Every call is audit-logged — that one was opened and by whom, never the URL or the password. `503` on a range whose provider offers no console. Requires `sites.restart`.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
serverId (path) | Uuid | Bẹẹni | The server's id, as `listComputeServers` reports it. **Ours** (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
url | string | Bẹẹni | The console address, for `kind: url` (a page a browser opens) and `kind: wss` (a WebSocket endpoint a VNC client connects to). ⛔ **Blank on a `vnc` console, and that is not a fa… |
password | string | Bẹẹni | The password the console asks for, when the provider issues one alongside the URL. `""` when the URL alone authenticates. |
expires_at | string | Bẹẹni | When it stops working, ISO-8601, or `""` when the provider does not say. ⛔ Blank does **not** mean "never" — these last minutes by design. A `url` and a `wss` console are both o… |
kind | string<url, wss, vnc> | Bẹẹni | ⛔⛔ **THREE genuinely different consoles, not three spellings of one, and `wss` was missing** (W22-B, D10906). `url` is a page a browser opens. `wss` is a one-shot WebSocket endp… |
host | string | Bẹẹni | The VNC host, for `kind: vnc`. ⛔ **May be blank, and that is a refusal rather than a gap**: where the only hostname a supplier states is its own branded one, we do not pass it on. |
port | integer | Bẹẹni | The VNC port, `0` when the provider does not state one. |
allowed_ips | string[] | Bẹẹni | The addresses currently permitted to reach the console. ⛔⛔ **An empty list on an IP-restricted console means NOBODY may connect** — the exact opposite of the "no restriction" an… |
ip_restricted | boolean | Bẹẹni | Whether the caller's address must be allow-listed before anything can connect. `false` means the credential alone is enough. |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 422 · 429 · 503