hosting
POST /v1/index-monitoring
Monitor another page, or a whole site hosted elsewhere.
Санҷиши ҳаққоният
Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.
Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X POST https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
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.
Ҷисми дархост
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
kind | string<section, external_site> | Не | — |
fqdn | string | Бале | The hostname to monitor, e.g. `example.com`. |
path | string | Не | 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 | Не | — |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
id | string | Бале | — |
kind | string<section, external_site> | Бале | `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 | Бале | The hostname, lower-cased. |
path | string | Бале | The path prefix without slashes (`blog`, `shop/offers`). Always empty on an `external_site`, and never empty on a `section`. |
label | string | Бале | What the customer calls it, so a list of twelve paths is readable. |
operand | string | Бале | The exact search operand checked, e.g. `example.com/blog`. |
created_at | string | Бале | — |
indexed | boolean | Бале | ⛔ **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 | Бале | When the reading was taken. `null` when there has never been one. |
monitored | boolean | Бале | 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… |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 404 · 409 · 422