seo-connect

PUT /v1/seo-connection/guard

Change SEO Guard for this site.

All seo-connect endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks sites.create; 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 PUT https://api.zinndigital.com/v1/seo-connection/guard \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Any of: switch it on or off, set the key pages (on this site only, at most 20), send the Pro licence (checked with Freemius — the plan is never taken from the site; a confirmed licence holds the 15-minute cadence for 8 days and is re-sent by the plugin), accept the current canonical addresses as the new normal (rebaseline), or ask for a check at the next sweep (check_now). Audited. Needs seo.run.

Request body

NameTypeRequiredWhat it is
enabledbooleanNo—
key_urlsstring[]No—
licenceobjectNo—
rebaselinebooleanNo—
check_nowbooleanNo—

Response

NameTypeRequiredWhat it is
enabledbooleanYes—
site_urlstringYes—
key_urlsstring[]Yes—
max_key_urlsintegerYes—
tierstring<free, pro>Yes—
interval_minutesintegerYes1440 on Free
pro_untilobjectYes—
last_checked_atobjectYes—
next_check_atobjectYes—
incidentsSeoGuardIncident[]YesEvery open problem, and those fixed in the last 30 days.

Errors this endpoint can return

401 · 403 · 422