PIpipeshub-ai
Connector Instances

Resync connector

Changed on

Trigger a resync of records from a connector instance.

Overview:

Fetches content from the external source and updates local records. Use when you suspect data is out of sync.

Only a connector in the caller's list of active connectors (GET /connectors/active, knowledge bases included) can be resynced. Any other ID, including one that does not exist, is refused with 400. The reply only acknowledges that the resync event was published.

Fields of the body other than connectorName and fullSync are dropped without an error.

Warning: This can be resource-intensive for large connectors.

The scope check also accepts kb:write in place of connector:write.

post/connectors/{connectorId}/resync

Request

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

Path parameters

connectorIdstring required

Connector instance ID. An ID that decodes to a path separator or another unsafe segment is refused with 400 before the token is checked.

Request body

connectorNamestring required

The connector's type as the registry lists it, for example RSS or Jira. It names the sync event; the connector synced is always the one in the path.

fullSyncboolean

When true, triggers a full sync instead of incremental.

Example request

{
  "connectorName": "RSS"
}

Response

Resync queued

Changes