PIpipeshub-ai
Connector Instances

Stop the running sync for a connector

Changed on

Ask the in-flight sync for a connector instance to stop.

Overview:

Returns as soon as the request is recorded; the sync halts at its next interruptible point, which for a connector inside a long provider call is when that call returns. stopped reports whether a sync was actually running, and false is a normal answer rather than a failure.

Deliberately not refused while the connector is busy or locked: this is the endpoint that has to work precisely then, including against a lock a crashed process left behind. When nothing is running it also repairs a stale SYNCING or FULL_SYNCING status, unless the service cannot tell a live sync on another worker from a stale one, in which case it changes nothing and says so.

post/connectors/{connectorId}/sync/stop

Request

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

Path parameters

connectorIdstring required

Connector instance ID

Response

Stop recorded, or nothing was running

successboolean required
stoppedboolean required

Whether a sync was running and has been asked to stop. False is a normal answer, not an error.

status'IDLE' | 'SYNCING' | 'FULL_SYNCING' | 'QUEUED' | 'DELETING' required

The status the connector is actually left in.

messagestring required

Changes