domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como um campo no corpo JSON.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
fqdn | string | Sim | Any registrable domain, including one registered elsewhere. |
org_id | string | Não | The organisation to watch it for. Defaults to the caller's own. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | string | Sim | — |
fqdn | string | Sim | Normalised lowercase punycode. |
source | string<registered, hosting, manual> | Sim | 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 domai… |
domain_id | string | Não | The `Domain` row, when the watched name is one of ours. |
site_id | string | Não | — |
muted | boolean | Sim | Whether alerts are currently suppressed. |
muted_until | string | Não | — |
expires_at | string | Não | ⛔ `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 w… |
days_until_expiry | integer | Não | Whole days, or `null` when `expires_at` is unknown. |
registrar | string | Não | As the registry reports it. Empty when redacted or not yet read. |
nameservers | string[] | Não | — |
status | string[] | Não | The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, … |
last_checked_at | string | Não | 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 | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 422