compute
POST /v1/compute/servers/{serverId}/console/allow
Let one address reach an IP-gated console.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.restart; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/console/allow \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "ip": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
⭐⭐ Without this, the console on an IP-gated range is a password for a bolted door. Such a range starts with an empty allow-list, meaning nobody may connect — the credential is real and useless until an address is added. ⛔ The response is the console session re-read from the provider, never an echo of the request: a 200 is not evidence on every provider, and the allow-list coming back containing the address is the only proof it landed. Requires sites.restart — granting an address console access is granting console access. Audited with the address, unlike opening a console, because an allow-list entry is a lasting change to who may reach the machine rather than a credential. 503 on a range whose console is not restricted by address.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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. |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
ip | string | Да | The public address that should be allowed to connect. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429 · 503