compute

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

Let one address reach an IP-gated console.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.restart 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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