hosting
POST /v1/index-monitoring
Monitor another page, or a whole site hosted elsewhere.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'وارد شدهاید؟ کنسول 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 than… |
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. They… |
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 checked… |
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 the… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 409 · 422