links

POST /v1/content/external-sites/{siteId}/verify

Re-check the credential on one connected external site, now.

All links endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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

NameTypeRequiredWhat it is
siteId (path)stringYes

Response

NameTypeRequiredWhat it is
site_idstringYes
primary_domainstringYes
namestringYes
is_externalbooleanYesAlways true here. The same site appears in `/v1/sites` badged External.
base_urlstringYesThe address we publish to, including any path (e.g. `https://example.com/blog`).
reachablebooleanNoWhat 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_atstringNo
detailstringNoWhat the site said last time, verbatim. Shown on the site's own screen.
detected_identitystringNo

Errors this endpoint can return

401 · 403 · 404