domains

POST /v1/domains/search

Search domain availability.

Todos os endpoints de domains

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

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/domains/search \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "query": <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

Checks availability + price for candidate names and returns a signed **availability token** for each name that is available in a TLD we offer. The token is what a `domain_register` cart line carries; checkout re-verifies it (a stale/taken one → `409`, no charge) — so registration/transfer happen through the cart/checkout flow, and this is the "find one to buy" half. A dotted `query` is checked as one exact FQDN; a bare name is checked across the requested `tlds` (or every offered TLD when none are given). Rate-limited. Requires `sites.view`.

Corpo da requisição

NomeTipoObrigatórioO que é
querystringSimA bare name (`acme`) checked across `tlds`, or a full FQDN (`acme.com`).
tldsstring[]NãoTLDs to check a bare name against. Ignored for a dotted query. Omitted, a bare name expands to the catalogue's most popular extensions — the top ten on the public endpoint and t…

Resposta

NomeTipoObrigatórioO que é
resultsDomainSearchResult[]Sim

Erros que este endpoint pode retornar

401 · 403 · 422 · 429