compute

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

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

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.restart; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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