인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.panel_access 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
⛔ **`202`, and the returned state describes a job that has STARTED.** A crawler walks the whole site and may take minutes; the sitemap does not exist when this returns. Poll `getSiteSitemap` until `running` is false. Answering `200` here would be the status-code equivalent of telling the customer their sitemap is ready. `upload` writes `sitemap.xml` into the webspace, overwriting any existing file. Requires `sites.panel_access`.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
siteId (path) | Uuid | 예 | Site ID (UUIDv7). |
요청 본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | 아니요 | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | 아니요 | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
ever_run | boolean | 예 | Has a crawl ever been run for this site? |
running | boolean | 예 | Is a crawl in progress? ⛔ Computed as *not in a terminal state*, so a state we have never seen reads as still working rather than as finished. |
state | string | 예 | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | 예 | When the most recent crawl started. Empty when none has run. |
output | string | 예 | The crawler's own output, if it produced any. |
upload | boolean | 예 | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | 예 | The change frequencies this site's crawler accepts. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404 · 422 · 429 · 503