Initiate AD synchronization for a domain

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Initiates an immediate AD synchronization for a specific domain. Returns whether the sync was successfully started or is already in progress.

Request URL

https://{serverurl}/dcapi/som/domains/{domain_id}/sync

Scope

DesktopCentralCloud.SOM.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/domainTreeSyncStatus.v1+jsonapplication/domainTreeSyncStatus.v1+jsonCopied!

- Path Parameters

domain_idstringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/som/domains/{domain_id}/sync \
  --header 'Accept: application/domainTreeSyncStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 202

Response Body - application/json
JSON Object
Hide Sub-Attributes
isDomainAdSyncInProgressboolean

Indicates whether the Active Directory synchronization process is now running for this domain

statusboolean

Indicates whether the synchronization request was accepted and initiated successfully

messagestring

Descriptive message confirming the sync initiation or explaining why it could not be started (e.g., 'Domain sync is already in progress')

- HTTP code 412

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusCodestring

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

202HTTP code
412HTTP code

Sample Response: HTTP 202

Sync initiated successfully

Copied!
  {
    "message": "Domain sync initiated for ECSOM",
    "isDomainAdSyncInProgress": true,
    "status": true
  }
                
Show full

Sample Response: HTTP 412

Domain sync is already in progress

Copied!
  {
    "errorCode": "10015",
    "message": "AD Domain Sync is already in progress. Sync attempt failed.",
    "statusCode": 412
  }
                
Show full

Daily sync limit reached

Copied!
  {
    "errorCode": "30104",
    "message": "Reached daily limit to initiate domain Sync",
    "statusCode": 412
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.