Verify connection | Modular DS

Re-checks an existing connection synchronously (no credentials involved) and answers with the resulting state. Unlike the automatic background checks, the caller waits for this one to finish.

Answers 200 with meta.connection_status (the raw connection status - e.g. established, lost, restoring, pending, or one of the specific connector error codes) and meta.is_connected (boolean, true for established, maintaining and restoring).

Requires a full-access token (read-only tokens answer 403); sites of other organizations answer 404. Connection failures surface only through the status enum, never raw connector error text.

Re-checks an existing connection synchronously (no credentials involved) and answers with the resulting state. Unlike the automatic background checks, the caller waits for this one to finish. Answers **200** with `meta.connection_status` (the raw connection status - e.g. `established`, `lost`, `restoring`, `pending`, or one of the specific connector error codes) and `meta.is_connected` (boolean, true for `established`, `maintaining` and `restoring`). Requires a full-access token (read-only tokens answer 403); sites of other organizations answer 404. Connection failures surface only through the status enum, never raw connector error text.

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