hosting

POST `/v1/index-monitoring`

Monitor another page, or a whole site hosted elsewhere.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`kind`	`string<section, external_site>`	Nu	—
`fqdn`	`string`	Da	The hostname to monitor, e.g. `example.com`.
`path`	`string`	Nu	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`	Nu	—

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`string`	Da	—
`kind`	`string<section, external_site>`	Da	`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`	Da	The hostname, lower-cased.
`path`	`string`	Da	The path prefix without slashes (`blog`, `shop/offers`). Always empty on an `external_site`, and never empty on a `section`.
`label`	`string`	Da	What the customer calls it, so a list of twelve paths is readable.
`operand`	`string`	Da	The exact search operand checked, e.g. `example.com/blog`.
`created_at`	`string`	Da	—
`indexed`	`boolean`	Da	⛔ 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`	Da	When the reading was taken. `null` when there has never been one.
`monitored`	`boolean`	Da	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…

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 409 · 422

POST /v1/index-monitoring