hosting

POST `/v1/index-monitoring`

Monitor another page, or a whole site hosted elsewhere.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`kind`	`string<section, external_site>`	Xeyr	—
`fqdn`	`string`	Bəli	The hostname to monitor, e.g. `example.com`.
`path`	`string`	Xeyr	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`	Xeyr	—

Cavab

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

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 409 · 422

POST /v1/index-monitoring