SnozeDevelopers
API referenceData sources

Run a data source sync now

Claims the data source and runs a sync immediately outside its schedule, returning the resulting run record. Requires `data_sources:write` and edit access to the data source's item. A disabled source, or one refreshed moments ago and not in an error state, is rejected as a validation error by the manual-run cooldown. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/data-sources/{dataSourceId}/refresh
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string
dataSourceId*string

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/data-sources/string/refresh"
{  "data": {    "id": "string",    "workspaceId": "string",    "dataSourceId": "string",    "status": "running",    "trigger": "manual",    "actorUserId": "string",    "stats": {      "rowsFetched": 0,      "rowsInserted": 0,      "rowsUpdated": 0,      "rowsUnchanged": 0,      "rowsRemoved": 0,      "rowsSkipped": 0,      "bytesFetched": 0,      "durationMs": 0    },    "error": "string",    "errorKind": "fetch",    "startedAt": "string",    "completedAt": "string"  }}