domains

POST `/v1/domain-watches`

Watch a domain — any domain, including one registered elsewhere.

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

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

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

Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։

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

Փորձել

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

curl -X POST https://api.zinndigital.com/v1/domain-watches \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "fqdn": <string> }'

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

Adds fqdn to the caller's watchlist with source: manual. ⭐ Idempotent by (org, fqdn): watching a domain that is already watched returns the existing row rather than erroring, because the customer's intent — "I want this watched" — is already satisfied and a 409 would be a worse answer to it. ⭐ Re-adding a domain the customer previously removed un-removes it. That is the one thing that clears removed_at, and it must be a deliberate act by the customer rather than a side effect of a provision.

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`fqdn`	`string`	Այո	Any registrable domain, including one registered elsewhere.
`org_id`	`string`	Ոչ	The organisation to watch it for. Defaults to the caller's own.

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`id`	`string`	Այո	—
`fqdn`	`string`	Այո	Normalised lowercase punycode.
`source`	`string<registered, hosting, manual>`	Այո	How it came to be watched. `registered` — we hold it. `hosting` — it is attached to a hosting account with us, whoever registered it. `manual` — the customer added it. ⛔ A domain…
`domain_id`	`string`	Ոչ	The `Domain` row, when the watched name is one of ours.
`site_id`	`string`	Ոչ	—
`muted`	`boolean`	Այո	Whether alerts are currently suppressed.
`muted_until`	`string`	Ոչ	—
`expires_at`	`string`	Ոչ	⛔ `null` is "the registry did not say", never "it does not expire". Render it as unknown; a client that treats it as a far-future date shows a customer a reassuring answer we…
`days_until_expiry`	`integer`	Ոչ	Whole days, or `null` when `expires_at` is unknown.
`registrar`	`string`	Ոչ	As the registry reports it. Empty when redacted or not yet read.
`nameservers`	`string[]`	Ոչ	—
`status`	`string[]`	Ոչ	The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, …
`last_checked_at`	`string`	Ոչ	When the registry last answered. ⛔ Every value on this row is a snapshot of the outside world taken at this instant, so it is never rendered without this beside it (§2.36).
`created_at`	`string`	Այո	—

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

401 · 403 · 422