hosting
POST /v1/index-monitoring
Monitor another page, or a whole site hosted elsewhere.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 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