compute

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

Let one address reach an IP-gated console.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya sites.restart; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`serverId (path)`	`Uuid`	Ndiyo	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.

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`ip`	`string`	Ndiyo	The public address that should be allowed to connect.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`url`	`string`	Ndiyo	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`	Ndiyo	The password the console asks for, when the provider issues one alongside the URL. `""` when the URL alone authenticates.
`expires_at`	`string`	Ndiyo	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>`	Ndiyo	⛔⛔ 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`	Ndiyo	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`	Ndiyo	The VNC port, `0` when the provider does not state one.
`allowed_ips`	`string[]`	Ndiyo	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`	Ndiyo	Whether the caller's address must be allow-listed before anything can connect. `false` means the credential alone is enough.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429 · 503

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