Syntax for Checking the Synchronization Process

GET /api/tenants/{tenantId}/directories/{id}/status shows the status of the synchronization.

Input

Use the supported input parameters to control the command output.


Parameter	Description
URL	https://`$vRA`/identity/api/tenants/{tenantId}/directories/{id}/sync, where: `tenantId` is the ID of the tenant `id` is the domain name of the directory for synchronization
`$vRA`	Specifies the appliance name and fully qualified domain name, or IP address of the vRealize Automation server.
`$token`	Specifies a valid HTTP bearer token with necessary credentials. The bearer token is included in the HEADER of the request.

Output

The command output contains property names and values based on the command input parameters.


Parameter	Description
syncStatus	Specifies the status of the synchronization: status: Specifies the status of the sync process. Positive responses include: RUNNING and COMPLETED. If a negative status code is returned, the message included with the error provides troubleshooting suggestions. message: Provides additional information regarding the status.

curl Command to Check Status of Synchronization

The following example command checks the synchronization process for a directory with domain name demo.ad-example.local.

curl -X --insecure -H "accept: application/json" -H "Authorization: Bearer $token”  https://$vRA/identity/api/tenants/$tenantId/directories/demo.ad-example.local/status

The response in JSON provides the status of the synchronization process. The following example is a positive response that shows the synchronization is running.

{
    "syncStatus": {
        "status": "RUNNING",
        "message": null
    },
}