compute

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

Let one address reach an IP-gated console.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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.

प्यारामिटरहरू

नाम	प्रकार	आवश्यक	यो के हो
`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