compute
POST /v1/compute/servers/{serverId}/console
Open an out-of-band console onto a server.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу sites.restart; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/console \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
⭐⭐ 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. ⛔⛔ A wss address is ours and is SINGLE-USE (W43-49). It is relayed by Zinn®'s own gateway, so the session's url names api.zinndigital.com and never the machine's supplier; a client that needs a second connection calls this again rather than reconnecting with the first address. 503 on a range whose provider offers no console. Requires sites.restart.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
serverId (path) | Uuid | Да | 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. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
url | string | Да | The console address, for kind: url (a page a browser opens) and kind: wss (a WebSocket endpoint a VNC client connects to). ⛔… |
password | string | Да | The password the console asks for, when the provider issues one alongside the URL. "" when the URL alone authenticates. |
expires_at | string | Да | 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… |
kind | string<url, wss, vnc> | Да | ⛔⛔ 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… |
host | string | Да | 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 | Да | The VNC port, 0 when the provider does not state one. |
allowed_ips | string[] | Да | 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 | Да | Whether the caller's address must be allow-listed before anything can connect. false means the credential alone is enough. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429 · 503