# Post Endpoint - CancelSyncJob

Cancels execution of sync job with provided id.

# HTTP Request

One of the following requests should be made:

POST /api/syncjobs/cancel({syncJobId})
POST /api/syncjobs/cancel/{syncJobId}

# Path parameters

Name Description
syncJobId required. ID of sync job which have to synchronized.

# Query parameters

Name Description
repository optional. Destination repository key.

# Request headers

Name Description
Authorization required. Bearer {token}. See authorization
Content-Type required. application/json

# Responses

Code Description Type
202 The cancellation has been accepted, but not yet executed.
401 If access is not allowed with the given credentials/data.
404 The sync job does not exist or is not being executed.
500 Cancellation of the sync job synchronization failed due to an internal server error.

# Example

# Request

The following is an example of how to call the endpoint:

POST /api/syncjobs/cancel(1)?repository=repo1

# Response

The following example shows the response:

Information

The response object is truncated for clarity. Default properties will be returned from the call.

HTTP/1.1 200 OK
Zuletzt aktualisiert: 7. Februar 2025 um 08:35