domains

GET /v1/domains

List the caller's domains.

Svi domains krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu sites.view; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.

Parametri

NazivVrstaObaveznoŠto je to
X-Zinn-Org (header)stringNe**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)stringNeOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeMaximum items to return (page size).
status (query)DomainStatusNeFilter by domain lifecycle status.
org_id (query)UuidNeRestrict to one organization in scope.
tld (query)stringNeFilter by TLD (e.g. `com`).
site_id (query)UuidNeRestrict 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…

Odgovor

NazivVrstaObaveznoŠto je to
dataDomain[]Da
pagePageMetaDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422 · 429