Restart synchronizationJob

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Synchronization.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Application.ReadWrite.OwnedBy, Synchronization.ReadWrite.All

To configure application provisioning or HR-driven provisioning, the calling user must also be assigned the Application Administrator or Cloud Application Administrator directory role.

To configure Azure AD Cloud Sync, the calling user must also be assigned the Hybrid Identity Administrator directory role.

HTTP Request

{servicePrincipalId} refers to the id of the service principal object. id is referred to as the Object ID of the enterprise application in the Azure portal.

POST /servicePrincipals/{servicePrincipalId}/synchronization/jobs/{jobId}/restart

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

In the request body, provide a JSON object with the following parameter.

Parameter Type Description
criteria synchronizationJobRestartCriteria Restart criteria


If successful, returns a 204 No Content response. It does not return anything in the response body.



The following is an example of a request.

Authorization: Bearer <token>
Content-type: application/json

   "criteria": {
       "resetScope": "Watermark, Escrows, QuarantineState"


The following is an example of a response.

HTTP/1.1 204 No Content