Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
X-Zinn-Org (header) | string | Нет | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | Нет | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Нет | Maximum items to return (page size). |
status (query) | DomainStatus | Нет | Filter by domain lifecycle status. |
org_id (query) | Uuid | Нет | Restrict to one organization in scope. |
tld (query) | string | Нет | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | Нет | Restrict to the domain backing one site — the link a site's DNS screen follows to reach the zone it should edit. Scoped by the same RLS filter as everything else here, so a site… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
data | Domain[] | Да | — |
page | PageMeta | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422 · 429