compute
POST /v1/compute/servers/{serverId}/console
Open an out-of-band console onto a server.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.restart; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/console \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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. 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