compute

POST `/v1/compute/servers/{serverId}/console/allow`

Let one address reach an IP-gated console.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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). ⛔ **Blank on a `vnc` console, and that is not a fa…
`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 o…
`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 endp…
`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

POST /v1/compute/servers/{serverId}/console/allow