compute
POST /v1/compute/terminal
Turn the web terminal on — mint the organisation's terminal key.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/compute/terminal \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Mints one ed25519 key for the organisation. ⛔ The private half is written to our secret store and never returned by any API; the public half is registered as one of the organisation's SSH keys, so every machine ordered afterwards carries it from first boot. Idempotent. Audit-logged. Requires billing.payment.manage — the same authority that registers an SSH key.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 422 · 429 · 503