compute

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

Let one address reach an IP-gated console.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.restart; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

⭐⭐ 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.

Parametry

Název	Typ	Požadováno	Co to je
`serverId (path)`	`Uuid`	Ano	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ělo požadavku

Název	Typ	Požadováno	Co to je
`ip`	`string`	Ano	The public address that should be allowed to connect.

Odpověď

Název	Typ	Požadováno	Co to je
`url`	`string`	Ano	The console address, for `kind: url` (a page a browser opens) and `kind: wss` (a WebSocket endpoint a VNC client connects to). ⛔…
`password`	`string`	Ano	The password the console asks for, when the provider issues one alongside the URL. `""` when the URL alone authenticates.
`expires_at`	`string`	Ano	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>`	Ano	⛔⛔ 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`	Ano	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`	Ano	The VNC port, `0` when the provider does not state one.
`allowed_ips`	`string[]`	Ano	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`	Ano	Whether the caller's address must be allow-listed before anything can connect. `false` means the credential alone is enough.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429 · 503

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