API ReferenceSource Connections

Cancel Job

Cancel a running sync job for a source connection. This endpoint requests cancellation and marks the job as CANCELLING. The workflow updates the final status to CANCELLED when it processes the cancellation request.

Authentication

x-api-keystring
API Key authentication via header

Path Parameters

source_connection_idstringRequiredformat: "uuid"
job_idstringRequiredformat: "uuid"

Headers

X-Framework-NamestringOptional
X-Framework-VersionstringOptional

Response

Successful Response
idstringformat: "uuid"
source_connection_idstringformat: "uuid"
statusenum
Sync job status enum.
started_atstring or nullformat: "date-time"
completed_atstring or nullformat: "date-time"
duration_secondsdouble or null
entities_insertedinteger or nullDefaults to 0
entities_updatedinteger or nullDefaults to 0
entities_deletedinteger or nullDefaults to 0
entities_failedinteger or nullDefaults to 0
errorstring or null
error_detailsmap from strings to any or null

Errors