Retrieves details of domains, custom groups, and branch offices managed by the Endpoint Central server

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

The Server Properties API provides information about the configuration of the Endpoint Central server. It returns the list of branch offices, domains, and custom groups available in the server environment. This information can be used to identify organizational structures, group policies, and domain settings.

Request URL

https://{serverurl}/api/1.4/desktop/serverproperties Copied!

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/desktop/serverproperties \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Wrapper object containing the actual response data.

Show Sub-Attributes
serverpropertiesJSON Object

Contains server discovery details.

Show Sub-Attributes
branch_officesarray

Lists the branch offices managed by the server.

domainsarray

Lists the domains managed by the server.

custom_groupsarray

Lists the custom groups configured in the server.

branch_officesarray

Lists the branch offices managed by the server.

domainsarray

Lists the domains managed by the server.

custom_groupsarray

Lists the custom groups configured in the server.

serverpropertiesJSON Object

Contains server discovery details.

Show Sub-Attributes
branch_officesarray

Lists the branch offices managed by the server.

domainsarray

Lists the domains managed by the server.

custom_groupsarray

Lists the custom groups configured in the server.

branch_officesarray

Lists the branch offices managed by the server.

domainsarray

Lists the domains managed by the server.

custom_groupsarray

Lists the custom groups configured in the server.

statusstring

Response status success/failure.

message_versionstring

Version of the response message format.

message_typestring

Identifies the type of message

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

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

INTERNAL_ERROR - unexpected exception while collecting server properties

error_descriptionstring

Internal server error message for server properties retrieval failures

Sample Response: HTTP 200

Copied!
  {
    "message_response": {
      "serverproperties": {
        "branch_offices": [
          "Direct Comm",
          "Intern Ds Remote",
          "Local Office"
        ],
        "domains": [
          "ZOHOCORP",
          "DESKTOPCENTRAL",
          "WORKGROUP",
          "macosgroup"
        ],
        "custom_groups": [
          "All Computers Group",
          "All Users Group",
          "Default_iOS_Corporate",
          "Default_iOS_Personal",
          "Default_Android_Corporate",
          "Default_Android_Personal",
          "Default_Windows_Corporate",
          "Default_Windows_Personal",
          "Inactive_Users_ZOHOCORP",
          "Inactive_Computers_ZOHOCORP",
          "test",
          "sathish"
        ]
      }
    },
    "message_type": "discover",
    "message_version": "1.0",
    "status": "success"
  }
                
▼ Show full

Sample Response: HTTP 401

Missing or invalid authentication details

Copied!
  {
    "errorCode": "UAC_UNAUTHORIZED",
    "message": "Unauthorized access",
    "statusCode": 401
  }
                
▼ Show full

Sample Response: HTTP 403

User lacks permission to access server properties

Copied!
  {
    "errorCode": "FORBIDDEN",
    "message": "Insufficient privileges to access this resource",
    "statusCode": 403
  }
                
▼ Show full

Sample Response: HTTP 429

Too many requests sent within the throttle window

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please retry after some time",
    "statusCode": 429
  }
                
▼ Show full

Sample Response: HTTP 500

Unexpected server-side failure while fetching server properties

Copied!
  {
    "error_description": "Internal server error while retrieving server properties",
    "error_code": "INTERNAL_ERROR"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 120 | 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.