hosting
POST /v1/index-monitoring
Monitor another page, or a whole site hosted elsewhere.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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