Manual connection credentials | Modular DS

Response meta: client_id (the OAuth client’s public id), reveal_url (an absolute, signed URL - follow it once to read client_secret; see “Show connection manual reveal”), expires_at (when the reveal URL stops working).

Sites of other organizations answer 404; a read-only token answers 403. If the single-use token store is unavailable, the call answers 503 rather than handing out a URL that would look already used the moment it is followed.

Starts the manual connection flow for one website: answers with the public half of its OAuth client plus a short-lived, single-use signed URL that reveals the secret. Handing out credentials is treated as a write on the website's connection, so a read-only token is refused even though this is a GET. Response `meta`: `client_id` (the OAuth client's public id), `reveal_url` (an absolute, signed URL - follow it once to read `client_secret`; see "Show connection manual reveal"), `expires_at` (when the reveal URL stops working). Sites of other organizations answer 404; a read-only token answers 403. If the single-use token store is unavailable, the call answers 503 rather than handing out a URL that would look already used the moment it is followed.

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 - Manual connection credentials

jsonapiobjectOptional

metaobjectOptional