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