Skip to main content

Cancel a running sync job

Signals the running job's abort controller. The job transitions to cancelled phase.

Request​

Method: POST
Path: /api/sync/external/{jobId}/cancel

Authentication: Not required

Parameters​

NameTypeInRequiredDescription
jobIdstringpathYes

Responses​

200 - Cancellation requested​

403 - No access to the job's tenant​

404 - No active job with that ID​

Examples​

cURL​

curl -X POST \
  -H "Content-Type: application/json" \
  http://localhost:3000/api/sync/external/{jobId}/cancel

JavaScript​

const response = await fetch('http://localhost:3000/api/sync/external/{jobId}/cancel', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

This documentation is automatically generated from the OpenAPI specification.