hosting
POST /v1/index-monitoring
Monitor another page, or a whole site hosted elsewhere.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
kind | string<section, external_site> | Ne | — |
fqdn | string | Ano | The hostname to monitor, e.g. `example.com`. |
path | string | Ne | 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 | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
kind | string<section, external_site> | Ano | `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 | Ano | The hostname, lower-cased. |
path | string | Ano | The path prefix without slashes (`blog`, `shop/offers`). Always empty on an `external_site`, and never empty on a `section`. |
label | string | Ano | What the customer calls it, so a list of twelve paths is readable. |
operand | string | Ano | The exact search operand checked, e.g. `example.com/blog`. |
created_at | string | Ano | — |
indexed | boolean | Ano | ⛔ **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 | Ano | When the reading was taken. `null` when there has never been one. |
monitored | boolean | Ano | 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… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 409 · 422