domains

GET /v1/domains

List the caller's domains.

Всички крайни точки в domains

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Отговор

ИмеТипЗадължителноКакво представлява
dataDomain[]Да
pagePageMetaДа

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429