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

Copy full URL

Request URL

https://{server-hostname}:8383/api/1.4/desktop/serverproperties Copied!

Scope

Common.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Query Parameters

loginidstringOptional

resource_idstringOptional

{resource_id} - Unique identifier of the computer

useridstringOptional

usernamestringOptional

ticketstringOptional

customeridstringOptional

customerNamestringOptional

customernamestringOptional

residfilterintegerOptional

Filter computer with particular resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

branchofficefilterstringOptional

Get branch office list from api/1.4/desktop/serverproperties

remoteofficefilterstringOptional

customgroupfilterstringOptional

Get custom group list from api/1.4/desktop/serverproperties

livestatusfilterintegerOptional

1 - Live: System is working.
2 - Down: System is not working.
3 - Unknown: System status is not known.

platformfilterstringOptional

connidfilterstringOptional

pagestringOptional

pagelimitstringOptional

orderbystringOptional

sortorderstringOptional

sortcolumnstringOptional

searchtypestringOptional

searchcolumnstringOptional

searchvaluestringOptional

patchidstringOptional

residstringOptional

{resid} - Unique identifier of the computer

languagefilterintegerOptional

approvalstatusfilterintegerOptional

downloadstatusfilterintegerOptional

supercedestatusfilterintegerOptional

healthfilterintegerOptional

severityfilterintegerOptional

patchtypefilterintegerOptional

patchstatusfilterintegerOptional

agentinstallationstatusfilterintegerOptional

installstatusfilterintegerOptional

21: Yet to install (agent has not been installed).
22: Installed (agent is currently installed).
23: Uninstalled (agent has been removed).
24: Yet to uninstall (marked for uninstallation but not yet removed).
29: Installation failure (an error occurred during installation).

licensetypefilterintegerOptional

1: Commercial (used for business or paid purposes).
2: Non-commercial (used for personal or educational purposes).
0: Unidentified (license type not specified).

scanstatusfilterintegerOptional

-1: Not done scan has not started.
0: Failed scan failed.
1: In progress scan is ongoing.
2: Success scan completed successfully.

deploymentstatusfilterintegerOptional

configtypefilterintegerOptional

accesstypefilterintegerOptional

1: Allowed (access is permitted).
2: Prohibited (access is restricted).
0: Not assigned (no access configuration).

compliancestatusfilterintegerOptional

0: Under licensed (fewer licenses than required).
1: Over licensed (more licenses than needed).
2: In compliance (license usage matches availability).
3: Expired (license validity has ended).
-1: Not available (compliance data is missing).

complianceStatusFilterintegerOptional

bulletinidstringOptional

oscompatibilityfilterstringOptional

32-bit: For 32-bit operating systems.
64-bit: For 64-bit operating systems.

uninstallsupportfilterstringOptional

Yes: Supports uninstallation.
No: Does not support uninstallation.

installerformatfilterstringOptional

MSI: Installed via MSI installer.
EXE: Installed via EXE installer.

licensefilterstringOptional

Get License List from api/1.4/inventory/licenses?swid={softwareID} in license_id parameter inside message response

hardwaretypefilterstringOptional

Get hardware type list from api/1.4/inventory/filterparams

manufacturerfilterstringOptional

Get hardware manufacturer list from api/1.4/inventory/filterparams

osfilterstringOptional

vendorfilterstringOptional

policynamestringOptional

configstatusfilterstringOptional

viewtypefilterstringOptional

latestpatchesstringOptional

prohibitedswidstringOptional

unique identifier of the prohibited software

categoryfilterstringOptional

ticketidstringOptional

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/1.4/desktop/serverproperties?loginid=SOME_STRING_VALUE&resource_id=SOME_STRING_VALUE&userid=SOME_STRING_VALUE&username=SOME_STRING_VALUE&ticket=SOME_STRING_VALUE&customerid=SOME_STRING_VALUE&customerName=SOME_STRING_VALUE&customername=SOME_STRING_VALUE&residfilter=SOME_INTEGER_VALUE&domainfilter=SOME_STRING_VALUE&branchofficefilter=SOME_STRING_VALUE&remoteofficefilter=SOME_STRING_VALUE&customgroupfilter=SOME_STRING_VALUE&livestatusfilter=SOME_INTEGER_VALUE&platformfilter=SOME_STRING_VALUE&connidfilter=SOME_STRING_VALUE&page=SOME_STRING_VALUE&pagelimit=SOME_STRING_VALUE&orderby=SOME_STRING_VALUE&sortorder=SOME_STRING_VALUE&sortcolumn=SOME_STRING_VALUE&searchtype=SOME_STRING_VALUE&searchcolumn=SOME_STRING_VALUE&searchvalue=SOME_STRING_VALUE&patchid=SOME_STRING_VALUE&resid=SOME_STRING_VALUE&languagefilter=SOME_INTEGER_VALUE&approvalstatusfilter=SOME_INTEGER_VALUE&downloadstatusfilter=SOME_INTEGER_VALUE&supercedestatusfilter=SOME_INTEGER_VALUE&healthfilter=SOME_INTEGER_VALUE&severityfilter=SOME_INTEGER_VALUE&patchtypefilter=SOME_INTEGER_VALUE&patchstatusfilter=SOME_INTEGER_VALUE&agentinstallationstatusfilter=SOME_INTEGER_VALUE&installstatusfilter=SOME_INTEGER_VALUE&licensetypefilter=SOME_INTEGER_VALUE&scanstatusfilter=SOME_INTEGER_VALUE&deploymentstatusfilter=SOME_INTEGER_VALUE&configtypefilter=SOME_INTEGER_VALUE&accesstypefilter=SOME_INTEGER_VALUE&compliancestatusfilter=SOME_INTEGER_VALUE&complianceStatusFilter=SOME_INTEGER_VALUE&bulletinid=SOME_STRING_VALUE&oscompatibilityfilter=SOME_STRING_VALUE&uninstallsupportfilter=SOME_STRING_VALUE&installerformatfilter=SOME_STRING_VALUE&licensefilter=SOME_STRING_VALUE&hardwaretypefilter=SOME_STRING_VALUE&manufacturerfilter=SOME_STRING_VALUE&osfilter=SOME_STRING_VALUE&vendorfilter=SOME_STRING_VALUE&policyname=SOME_STRING_VALUE&configstatusfilter=SOME_STRING_VALUE&viewtypefilter=SOME_STRING_VALUE&latestpatches=SOME_STRING_VALUE&prohibitedswid=SOME_STRING_VALUE&categoryfilter=SOME_STRING_VALUE&ticketid=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/1.4/desktop/serverproperties?loginid=SOME_STRING_VALUE&resource_id=SOME_STRING_VALUE&userid=SOME_STRING_VALUE&username=SOME_STRING_VALUE&ticket=SOME_STRING_VALUE&customerid=SOME_STRING_VALUE&customerName=SOME_STRING_VALUE&customername=SOME_STRING_VALUE&residfilter=SOME_INTEGER_VALUE&domainfilter=SOME_STRING_VALUE&branchofficefilter=SOME_STRING_VALUE&remoteofficefilter=SOME_STRING_VALUE&customgroupfilter=SOME_STRING_VALUE&livestatusfilter=SOME_INTEGER_VALUE&platformfilter=SOME_STRING_VALUE&connidfilter=SOME_STRING_VALUE&page=SOME_STRING_VALUE&pagelimit=SOME_STRING_VALUE&orderby=SOME_STRING_VALUE&sortorder=SOME_STRING_VALUE&sortcolumn=SOME_STRING_VALUE&searchtype=SOME_STRING_VALUE&searchcolumn=SOME_STRING_VALUE&searchvalue=SOME_STRING_VALUE&patchid=SOME_STRING_VALUE&resid=SOME_STRING_VALUE&languagefilter=SOME_INTEGER_VALUE&approvalstatusfilter=SOME_INTEGER_VALUE&downloadstatusfilter=SOME_INTEGER_VALUE&supercedestatusfilter=SOME_INTEGER_VALUE&healthfilter=SOME_INTEGER_VALUE&severityfilter=SOME_INTEGER_VALUE&patchtypefilter=SOME_INTEGER_VALUE&patchstatusfilter=SOME_INTEGER_VALUE&agentinstallationstatusfilter=SOME_INTEGER_VALUE&installstatusfilter=SOME_INTEGER_VALUE&licensetypefilter=SOME_INTEGER_VALUE&scanstatusfilter=SOME_INTEGER_VALUE&deploymentstatusfilter=SOME_INTEGER_VALUE&configtypefilter=SOME_INTEGER_VALUE&accesstypefilter=SOME_INTEGER_VALUE&compliancestatusfilter=SOME_INTEGER_VALUE&complianceStatusFilter=SOME_INTEGER_VALUE&bulletinid=SOME_STRING_VALUE&oscompatibilityfilter=SOME_STRING_VALUE&uninstallsupportfilter=SOME_STRING_VALUE&installerformatfilter=SOME_STRING_VALUE&licensefilter=SOME_STRING_VALUE&hardwaretypefilter=SOME_STRING_VALUE&manufacturerfilter=SOME_STRING_VALUE&osfilter=SOME_STRING_VALUE&vendorfilter=SOME_STRING_VALUE&policyname=SOME_STRING_VALUE&configstatusfilter=SOME_STRING_VALUE&viewtypefilter=SOME_STRING_VALUE&latestpatches=SOME_STRING_VALUE&prohibitedswid=SOME_STRING_VALUE&categoryfilter=SOME_STRING_VALUE&ticketid=SOME_STRING_VALUE"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/api/1.4/desktop/serverproperties?loginid=SOME_STRING_VALUE&resource_id=SOME_STRING_VALUE&userid=SOME_STRING_VALUE&username=SOME_STRING_VALUE&ticket=SOME_STRING_VALUE&customerid=SOME_STRING_VALUE&customerName=SOME_STRING_VALUE&customername=SOME_STRING_VALUE&residfilter=SOME_INTEGER_VALUE&domainfilter=SOME_STRING_VALUE&branchofficefilter=SOME_STRING_VALUE&remoteofficefilter=SOME_STRING_VALUE&customgroupfilter=SOME_STRING_VALUE&livestatusfilter=SOME_INTEGER_VALUE&platformfilter=SOME_STRING_VALUE&connidfilter=SOME_STRING_VALUE&page=SOME_STRING_VALUE&pagelimit=SOME_STRING_VALUE&orderby=SOME_STRING_VALUE&sortorder=SOME_STRING_VALUE&sortcolumn=SOME_STRING_VALUE&searchtype=SOME_STRING_VALUE&searchcolumn=SOME_STRING_VALUE&searchvalue=SOME_STRING_VALUE&patchid=SOME_STRING_VALUE&resid=SOME_STRING_VALUE&languagefilter=SOME_INTEGER_VALUE&approvalstatusfilter=SOME_INTEGER_VALUE&downloadstatusfilter=SOME_INTEGER_VALUE&supercedestatusfilter=SOME_INTEGER_VALUE&healthfilter=SOME_INTEGER_VALUE&severityfilter=SOME_INTEGER_VALUE&patchtypefilter=SOME_INTEGER_VALUE&patchstatusfilter=SOME_INTEGER_VALUE&agentinstallationstatusfilter=SOME_INTEGER_VALUE&installstatusfilter=SOME_INTEGER_VALUE&licensetypefilter=SOME_INTEGER_VALUE&scanstatusfilter=SOME_INTEGER_VALUE&deploymentstatusfilter=SOME_INTEGER_VALUE&configtypefilter=SOME_INTEGER_VALUE&accesstypefilter=SOME_INTEGER_VALUE&compliancestatusfilter=SOME_INTEGER_VALUE&complianceStatusFilter=SOME_INTEGER_VALUE&bulletinid=SOME_STRING_VALUE&oscompatibilityfilter=SOME_STRING_VALUE&uninstallsupportfilter=SOME_STRING_VALUE&installerformatfilter=SOME_STRING_VALUE&licensefilter=SOME_STRING_VALUE&hardwaretypefilter=SOME_STRING_VALUE&manufacturerfilter=SOME_STRING_VALUE&osfilter=SOME_STRING_VALUE&vendorfilter=SOME_STRING_VALUE&policyname=SOME_STRING_VALUE&configstatusfilter=SOME_STRING_VALUE&viewtypefilter=SOME_STRING_VALUE&latestpatches=SOME_STRING_VALUE&prohibitedswid=SOME_STRING_VALUE&categoryfilter=SOME_STRING_VALUE&ticketid=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/api/1.4/desktop/serverproperties"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/desktop/serverproperties?loginid=SOME_STRING_VALUE&resource_id=SOME_STRING_VALUE&userid=SOME_STRING_VALUE&username=SOME_STRING_VALUE&ticket=SOME_STRING_VALUE&customerid=SOME_STRING_VALUE&customerName=SOME_STRING_VALUE&customername=SOME_STRING_VALUE&residfilter=SOME_INTEGER_VALUE&domainfilter=SOME_STRING_VALUE&branchofficefilter=SOME_STRING_VALUE&remoteofficefilter=SOME_STRING_VALUE&customgroupfilter=SOME_STRING_VALUE&livestatusfilter=SOME_INTEGER_VALUE&platformfilter=SOME_STRING_VALUE&connidfilter=SOME_STRING_VALUE&page=SOME_STRING_VALUE&pagelimit=SOME_STRING_VALUE&orderby=SOME_STRING_VALUE&sortorder=SOME_STRING_VALUE&sortcolumn=SOME_STRING_VALUE&searchtype=SOME_STRING_VALUE&searchcolumn=SOME_STRING_VALUE&searchvalue=SOME_STRING_VALUE&patchid=SOME_STRING_VALUE&resid=SOME_STRING_VALUE&languagefilter=SOME_INTEGER_VALUE&approvalstatusfilter=SOME_INTEGER_VALUE&downloadstatusfilter=SOME_INTEGER_VALUE&supercedestatusfilter=SOME_INTEGER_VALUE&healthfilter=SOME_INTEGER_VALUE&severityfilter=SOME_INTEGER_VALUE&patchtypefilter=SOME_INTEGER_VALUE&patchstatusfilter=SOME_INTEGER_VALUE&agentinstallationstatusfilter=SOME_INTEGER_VALUE&installstatusfilter=SOME_INTEGER_VALUE&licensetypefilter=SOME_INTEGER_VALUE&scanstatusfilter=SOME_INTEGER_VALUE&deploymentstatusfilter=SOME_INTEGER_VALUE&configtypefilter=SOME_INTEGER_VALUE&accesstypefilter=SOME_INTEGER_VALUE&compliancestatusfilter=SOME_INTEGER_VALUE&complianceStatusFilter=SOME_INTEGER_VALUE&bulletinid=SOME_STRING_VALUE&oscompatibilityfilter=SOME_STRING_VALUE&uninstallsupportfilter=SOME_STRING_VALUE&installerformatfilter=SOME_STRING_VALUE&licensefilter=SOME_STRING_VALUE&hardwaretypefilter=SOME_STRING_VALUE&manufacturerfilter=SOME_STRING_VALUE&osfilter=SOME_STRING_VALUE&vendorfilter=SOME_STRING_VALUE&policyname=SOME_STRING_VALUE&configstatusfilter=SOME_STRING_VALUE&viewtypefilter=SOME_STRING_VALUE&latestpatches=SOME_STRING_VALUE&prohibitedswid=SOME_STRING_VALUE&categoryfilter=SOME_STRING_VALUE&ticketid=SOME_STRING_VALUE' -Method GET -Headers $headers

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.

  {
    "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.