hosting

POST `/v1/index-monitoring`

Monitor another page, or a whole site hosted elsewhere.

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau 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> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`kind`	`string<section, external_site>`	Non	—
`fqdn`	`string`	Oui	The hostname to monitor, e.g. `example.com`.
`path`	`string`	Non	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`	Non	—

Réponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 409 · 422

POST /v1/index-monitoring