compute

GET `/v1/compute/terminal`

Whether the web terminal is turned on for an organisation.

אימות

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

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.

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

נסה זאת

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

curl -X GET https://api.zinndigital.com/v1/compute/terminal \
  -H "Authorization: Bearer zdk_live_…"

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

פרטים

enabled is true only when BOTH halves exist — the organisation's terminal key is registered as one of its SSH keys, and its private half is in our secret store. public_key is the one line to add to authorized_keys on a machine built before the terminal was turned on. ?org_id= is required only of a caller in more than one organisation. Requires sites.view.

פרמטרים

שם	סוג	נדרש	מה זה
`org_id (query)`	`Uuid`	לא	—

תשובה

שם	סוג	נדרש	מה זה
`enabled`	`boolean`	כן	—
`public_key`	`string`	כן	The one line to add to `authorized_keys` on a machine built before the terminal was turned on. Public by definition — not a secret. `""` when the terminal was never on.
`fingerprint`	`string`	כן	—

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 429