compute

POST `/v1/compute/servers/{serverId}/terminal`

Mint a single-use ticket for one web terminal session on a server.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास sites.restart अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/terminal \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

⛔⛔ The ticket is a credential: one use, sixty seconds. Open wss://<this API's host><path> and send it as the FIRST message — {"type":"auth","ticket":"…","cols":N,"rows":N} — never in the URL, which access logs keep. After that, binary frames are keystrokes and terminal output; text frames are {"type":"resize",…} from the client and {"type":"status","state","code","message"} from the gateway. The gateway logs in over SSH with the organisation's terminal key and pins the machine's host key on first use; a changed key is refused (code: host_key_changed). Every ticket, connection, failure and close is audit-logged — who, when, how long and how many bytes, never what was typed. 422 when the terminal is off, the login name is not one a server accepts, or the machine has no public address. Requires sites.restart.

पैरामीटर

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

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`username`	`string`	नहीं	The login name. `""` means `root`.

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`ticket`	`string`	हाँ	—
`path`	`string`	हाँ	The gateway path on this API's host — connect to `wss://<host><path>`.
`expires_at`	`integer`	हाँ	Unix seconds.
`host`	`string`	हाँ	The machine address the gateway will connect to.
`username`	`string`	हाँ	—

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404 · 422 · 429 · 503

POST /v1/compute/servers/{serverId}/terminal