compute
POST /v1/compute/servers/{serverId}/console/allow
Let one address reach an IP-gated console.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте sites.restart рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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 арқылы орындайды. Бұл соңғы нүктені 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
ip | string | Иә | The public address that should be allowed to connect. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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