API ReferenceConnections

Trigger sync

Initiates a sync operation for the specified connection. The operation can either wait for the sync to complete or queue it for later processing based on the `wait` query parameter.

POST
/api/connections/{id}/sync

Authorization

AuthorizationRequiredBearer <token>

Bearer token authentication required

In: header

Path Parameters

idRequiredstring

The unique identifier of the connection to sync

Query Parameters

waitstring

If "true", waits for the sync operation to complete before returning. Defaults to "false" if omitted.

Default: "false"Value in: "true" | "false"
curl -X POST "https://app.dcup.dev/api/connections/string/sync?wait=true" \
  -H "Authorization: Bearer <token>"

Sync operation initiated successfully

{
  "code": "ok",
  "message": "Your file was successfully synced and processed"
}

Previous

Retrieve connections GET

Next

Update specific connection PUT