Connector Control

Toggle connector sync or agent

Changed on

Flip a connector's sync or agent use: each call turns it on when it is off and off when it is on. Read <code>isActive</code> / <code>isAgentActive</code> first. Turning sync on starts the first sync.<br><br> <b>Toggle Types:</b><br>

<ul> <li><code>sync</code> - data synchronization</li> <li><code>agent</code> - use by AI agents</li> </ul> <b>Before Sync Can Be Turned On:</b><br> <ul> <li>The connector is configured (<code>isConfigured: true</code>)</li> <li>OAuth connectors: sign-in has completed</li> <li>The connection test against the source passes</li> <li>For agent: the connector supports agents (<code>supportsAgent: true</code>)</li> <li>Local FS: must be enabled from the owner device via the desktop app, which sends <code>deviceId</code> and <code>deviceName</code>. The first enable claims that device as owner.</li> </ul> <b>Permissions:</b><br> <ul> <li>Team scope: Requires admin</li> <li>Personal scope: Only creator can toggle</li> </ul>
post/connectors/{connectorId}/toggle

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}/toggle
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:sync, connector:read

Path parameters

connectorIdstring required

Connector instance ID

Request body

type'sync' | 'agent' required

'sync' flips data synchronization; 'agent' flips use by agents

fullSyncboolean

When turning sync on, start from scratch

deviceIdstring

Local FS only

deviceNamestring

Local FS only

Response

Flipped

successboolean required
messagestring

Changes