Cancel Sync

Requests cancellation of any running executions on a model sync. Cancellation is asynchronous. A successful response means the cancellation signal has been queued; the running execution continues until the signal is processed. Poll `GET /api/syncs/{id}/status` until the current execution reaches a terminal state (`completed`, `canceled`, or `failed`) to confirm cancellation has taken effect.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
The active execution of this sync ID will be cancelled.

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error