Skip to navigation

Verify a website's connection

View as MarkdownOpen in Claude

Re-checks a website’s existing connection and returns the resulting state. Use it after reinstalling the plugin or when a website shows as disconnected. Unlike the automatic background checks, the request waits for the check to finish.

The check repeats the connection handshake, so your role must be one of those that connect websites (owner, administrator and collaborator); any other member, such as a viewer, gets 404. A failure is reported only through the connection status, never as raw connector error text.

Errors

  • 503: connection checks are paused for maintenance. Nothing is checked; the Retry-After header holds the seconds until they resume and detail the resume time in UTC. Connecting a new website is not affected.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

site_idstringRequired

Response

200 - Connection verified

jsonapiobjectOptional
metaobjectOptional

Errors

503
Service Unavailable Error