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

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.

## Endpoint

`GET /api/1.4/desktop/serverproperties`

## Request URL

https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/1.4/desktop/serverproperties

## Scope

`DesktopCentralCloud.Common.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` — Mandatory
  - `application/json`

## Sample Request

```curl
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`
  - **message_response** `JSON Object`
    - Wrapper object containing the actual response data.
    - **serverproperties** `JSON Object`
      - Contains server discovery details.
  - **status** `string`
    - Response status success/failure.
  - **message_version** `string`
    - Version of the response message format.
  - **message_type** `string`
    - Identifies the type of message.

### HTTP Code 401

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`
    - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
  - **errorMsg** `string`
    - Authentication failure reason

### HTTP Code 403

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`
    - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
  - **errorMsg** `string`
    - Message indicating insufficient privileges to access this resource

### HTTP Code 429

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`
    - 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
  - **errorMsg** `string`
    - Rate limit exceeded message with retry guidance

### HTTP Code 500

Response Body — `application/json`

- `JSON Object`
  - **error_code** `string`
    - INTERNAL_ERROR - unexpected exception while collecting server properties
  - **error_description** `string`
    - Internal server error message for server properties retrieval failures

## Sample Response: HTTP 200

```json
{
  "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"
}
```

## Sample Response: HTTP 401

Missing or invalid authentication details

```json
{
  "errorCode": "UAC_UNAUTHORIZED",
  "message": "Unauthorized access",
  "statusCode": 401
}
```

## Sample Response: HTTP 403

User lacks permission to access server properties

```json
{
  "errorCode": "FORBIDDEN",
  "message": "Insufficient privileges to access this resource",
  "statusCode": 403
}
```

## Sample Response: HTTP 429

Too many requests sent within the throttle window

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "message": "Too many requests. Please retry after some time",
  "statusCode": 429
}
```

## Sample Response: HTTP 500

Unexpected server-side failure while fetching server properties

```json
{
  "error_description": "Internal server error while retrieving server properties",
  "error_code": "INTERNAL_ERROR"
}
```

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.