hosting

POST `/v1/sites/{siteId}/sitemap`

Start a sitemap crawl.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.panel_access 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 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

POST /v1/sites/{siteId}/sitemap