compute

GET /v1/compute/servers

List the servers in scope.

Все эндпоинты compute

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Every machine the caller can see, or — with `?org_id=` — one organisation's. The scoped form is what a reseller's console sends. An organisation outside the readable scope narrows to nothing rather than `403`-ing, exactly as `listSites` does: a `403` would confirm the organisation exists. ⛔ **Resolved from our own rows, not from the provider's listing**, which is every customer on the reseller account. `status` is ours (how far the order got) and `power_state` is the machine's (what it is doing now); they are separate facts and rounding the provider's word into ours would silently make an unrecognised state `active`, which is what unlocks the power and resize controls. `operable` is read rather than re-derived from `status`, so a screen never offers a control the engine refuses. Requires `sites.view`.

Параметры

ИмяТипОбязательноЧто это
org_id (query)UuidНетNarrow the list to one organisation the caller can read.

Ответ

ИмяТипОбязательноЧто это
dataComputeServer[]ДаThe machines, across every organisation the caller can read.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429 · 503