hosting

POST `/v1/index-monitoring`

Monitor another page, or a whole site hosted elsewhere.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`kind`	`string<section, external_site>`	Hayır	—
`fqdn`	`string`	Evet	The hostname to monitor, e.g. `example.com`.
`path`	`string`	Hayır	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`	Hayır	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`string`	Evet	—
`kind`	`string<section, external_site>`	Evet	`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`	Evet	The hostname, lower-cased.
`path`	`string`	Evet	The path prefix without slashes (`blog`, `shop/offers`). Always empty on an `external_site`, and never empty on a `section`.
`label`	`string`	Evet	What the customer calls it, so a list of twelve paths is readable.
`operand`	`string`	Evet	The exact search operand checked, e.g. `example.com/blog`.
`created_at`	`string`	Evet	—
`indexed`	`boolean`	Evet	⛔ 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`	Evet	When the reading was taken. `null` when there has never been one.
`monitored`	`boolean`	Evet	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 uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 409 · 422

POST /v1/index-monitoring