hosting

POST `/v1/index-monitoring`

Monitor another page, or a whole site hosted 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.

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/index-monitoring \
  -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

Creates one monitored target. `kind` decides which product and therefore which allowance it consumes, and the two are **not** interchangeable: a `section` needs a `path` and consumes `indexing_targets`; an `external_site` takes no `path` and consumes `external_index_sites`. Does **not** check the target. The next scheduled sweep does, on this account's normal cadence — so creating a target costs nothing, and a typo costs nothing. Answers `409` when the same page is already monitored, rather than succeeding silently: a duplicate would consume a second allowance slot and a second check every day for the same answer. Answers `422` with `ALLOWANCE_EXCEEDED` when the relevant allowance is full, carrying the limit in `details` and naming the add-on that raises it.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`kind`	`string<section, external_site>`	Não	—
`fqdn`	`string`	Sim	The hostname to monitor, e.g. `example.com`.
`path`	`string`	Não	Required for `section`, and rejected for `external_site`. ⛔ An empty path on a section would be the whole site, which every plan already checks free — so it is refused rather th…
`label`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`kind`	`string<section, external_site>`	Sim	`section` is a page or path prefix inside a site, on top of the free whole-site check. `external_site` is an entire website hosted somewhere else, billed per site per month. The…
`fqdn`	`string`	Sim	The hostname, lower-cased.
`path`	`string`	Sim	The path prefix without slashes (`blog`, `shop/offers`). Always empty on an `external_site`, and never empty on a `section`.
`label`	`string`	Sim	What the customer calls it, so a list of twelve paths is readable.
`operand`	`string`	Sim	The exact search operand checked, e.g. `example.com/blog`.
`created_at`	`string`	Sim	—
`indexed`	`boolean`	Sim	⛔ Three-valued. `true` and `false` are answers from the provider. `null` means no reading exists yet, or this row is beyond the current allowance and is not being checke…
`checked_at`	`string`	Sim	When the reading was taken. `null` when there has never been one.
`monitored`	`boolean`	Sim	Whether the sweep is currently checking this row. `false` with the row still present is the "you have downgraded, this one is paused" state — shown rather than hidden, because t…

Erros que este endpoint pode retornar

401 · 403 · 404 · 409 · 422

POST /v1/index-monitoring