Skip to main content

Cancel the running Active Directory sync for a domain

POST 

/api/v1/DomainSync/Cancel/:domainConfigId

Marks the sync runs for the domain that are still in progress as cancelled. Use it to stop a sync that is queued or running.

Permission required: Admin or App role. The session must also satisfy the multi-factor authentication requirement.

Request​

Responses​

The cancellation was recorded. The body is empty. The call also succeeds when the domain configuration ID matches no sync runs.