links
POST /v1/content/external-sites/{siteId}/verify
Re-check the credential on one connected external site, now.
Authentication
Send an API key as a bearer token. The key must carry the links.edit permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/content/external-sites/{siteId}/verify \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on links.edit. The same check runs daily on its own; this is the button for a customer who has just fixed something and does not want to wait.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
primary_domain | string | Yes | — |
name | string | Yes | — |
is_external | boolean | Yes | Always true here. The same site appears in /v1/sites badged External. |
base_url | string | Yes | The address we publish to, including any path (e.g. https://example.com/blog). |
reachable | boolean | No | What the last check found. null means we have not checked, which is not the same as "it does not work" — an unchecked site is never rendered as broken. |
checked_at | string | No | — |
detail | string | No | What the site said last time, verbatim. Shown on the site's own screen. |
detected_identity | string | No | — |
backup | object | Yes | Whether we can back this site up, and whether we can put it back. Served on the list so a screen showing a customer's whole external estate makes one request rather than one per… |
Errors this endpoint can return
401 · 403 · 404