domains

GET /v1/domains

List the caller's domains.

Բոլոր domains վերջնակետերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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…

Պատասխան

ԱնունՏեսակՊահանջվում էԻնչ է դա
dataDomain[]Այո
pagePageMetaԱյո

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 422 · 429