Canceling a Synchronization Job
Use the post /v1/cckm/google/synchronization-jobs/{id}/cancel
API to cancel a synchronization job with the given ID. Only an in-progress synchronization can be canceled.
Syntax
Here, {id}
represents the resource ID of the synchronization job to be canceled. To get the ID of a synchronization job, refer to Viewing Synchronization Status.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Example Request
Example Response
In the sample output above, "abort": true
indicates that cancellation of a synchronization job with the ID "c48cdf05-3752-400f-ae3e-41826dedd862"
is triggered and its "overall_status"
is "in_progress"
. After the job is canceled, its status becomes "completed"
.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.