Retrieves the details of all configured remote offices

Provides a list of remote offices along with configuration details such as proxy details, distribution server details, etc.

Endpoints

get /api/1.4/som/remoteoffice

Copy full URL

Request URL

https://{serverurl}/api/1.4/som/remoteoffice

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pagestringOptional

Specifies the page number to retrieve. Default is 1

pagelimitstringOptional

Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/1.4/som/remoteoffice \
  --header 'Authorization: Zoho-oauthtoken  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/som/remoteoffice"))
        .header("Authorization", "Zoho-oauthtoken  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 = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/1.4/som/remoteoffice", 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/som/remoteoffice"
        type: GET
        headers: headersMap
        
        
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/som/remoteoffice' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

message_typestring

Name of the module

message_responseJSON object

Response message containing remote office details

Show Sub-Attributes

totalinteger

Total number of remote offices

limitinteger

Number of remote offices per page

pageinteger

Current page number

remoteofficeJSON array

Show Sub-Attributes

JSON object

Show Sub-Attributes

updated_timeinteger

Represents the most recent time the remote office details were modified

is_httpsboolean

Indicates whether secure HTTPS communication is enabled for the remote office

ds_statusinteger

Specifies the Distribution Server installation state in the remote office, (Possible values listed below)
21 - Yet to install
22 - Installed
23 - Uninstalled
29 - Installation Failure

branch_office_namestring

Specifies the display name of the remote office

agent_arc_locstring

Specifies the location where the Remote Office agent installation files were stored. This field is currently deprecated and no longer in use

compression_typeinteger

Defines the compression type used during data transfer from the remote office. (Possible values listed below)
1 - Best
0 - Fast

replicationpolicydetails.policy_namestring

Indicates the policy's name applied for replicating data between the remote office and the server

branch_office_idinteger

A unique identifier for the remote office

proxy_details_branch_office_idinteger

Unique identifier linking the remote office to its proxy server details

resource_id_stringstring

String representation of the unique identifier for the remote office

policytobranchofficerel.policy_idinteger

Unique identifier of the policy associated with this remote office

agent_comm_branch_office_idinteger

Unique identifier for the remote office associated with the agent communication settings

ds_dns_namestring

DNS name of the Distribution Server connected to the remote office

branch_office_descstring

Text description giving additional information about the remote office

ds_versionstring

Indicates the Distribution Server version associated with the remote office

policytobranchofficerel.branch_office_idinteger

Unique identifier linking the remote office to branch office policy configurations

proxy_port_numberinteger

Port number of the proxy server associated with the remote office

last_contact_timeinteger

Last contact time of the remote office with the server

is_proxyboolean

Indicates whether a proxy server is configured for the remote office

colorquality_typeinteger

Defines the color quality type associated with the branch office. (Possible values listed below)
24 - True color
16 - High
8 - Medium
4 - Low

ds_https_portstring

Port number used for HTTPS communication with the Distribution Server

proxy_usernamestring

Username for the proxy server associated with the remote office

adgroupremoteofficemapping.branch_office_idinteger

Unique identifier for the remote office mapping associated with the Active Directory group

has_masteragentboolean

Indicates whether the remote office is associated with the distribution server

managed_computersinteger

Number of computers managed by the remote office

replicationpolicydetails.policy_idinteger

Unique identifier for the replication policy associated with the remote office

error_code_kb_urlstring

URL for the knowledge base article related to the error code

ds_sync_statusinteger

Indicates the synchronization status of data such as patches, configurations, and deployment details from the server to the Distribution Server. (Possible values listed below)
101 - Sync started
102 - Sync inprogress
104 - Sync failure

error_kb_urlstring

URL for the knowledge base article related to the error

ds_ipaddressstring

Indicated the ip address of the distribution server for the remote office

branch_office_customer_idinteger

Unique identifier for the customer associated with the remote office

proxy_server_namestring

Name of the proxy server associated with the remote office

resource_idinteger

Unique identifier for the remote office

disserverdetails.branch_office_idinteger

Unique identifier for the remote office associated with distribution server details

error_codeinteger

Error code indicating the status of the remote office

customer_namestring

Name of the customer associated with the remote office

customer_idinteger

Unique identifier for the customer associated with the remote office

resource_namestring

Name of the distribution server associated with the remote office

remarksstring

Remarks or comments related to the remote office

message_versionstring

Version of the Api

statusstring

Status of the request

Possible HTTP Status Codes

200HTTP code

Request processed successfully

Sample Response: HTTP 200

Copied!

  {
    "message_type": "remoteoffice",
    "message_response": {
      "total": 3,
      "limit": 25,
      "page": 1,
      "remoteoffice": [
        {
          "updated_time": 1756445282837,
          "ds_status": 29,
          "is_https": true,
          "branch_office_name": "DS RemoteOffice",
          "agent_arc_loc": "",
          "compression_type": 1,
          "replicationpolicydetails.policy_name": "Policy_1",
          "branch_office_id": 301,
          "proxy_details_branch_office_id": 301,
          "resource_id_string": "309",
          "policytobranchofficerel.policy_id": 1,
          "agent_comm_branch_office_id": 301,
          "ds_dns_name": "ds.mycomp.com",
          "branch_office_desc": "--",
          "ds_version": "11.4.2522.01",
          "policytobranchofficerel.branch_office_id": 301,
          "proxy_port_number": 80,
          "last_contact_time": -1,
          "is_proxy": true,
          "colorquality_type": 16,
          "ds_https_port": "8384",
          "proxy_username": "Alex",
          "adgroupremoteofficemapping.branch_office_id": 301,
          "has_masteragent": true,
          "managed_computers": 1,
          "replicationpolicydetails.policy_id": 1,
          "error_code_kb_url": "--",
          "ds_sync_status": 1,
          "error_kb_url": "$(dcUrl)/agent_installation_logon_failure.html?",
          "ds_ipaddress": "10.92.8.98",
          "branch_office_customer_id": 1,
          "proxy_server_name": "Proxy - Server",
          "resource_id": 309,
          "disserverdetails.branch_office_id": 301,
          "error_code": 60006,
          "customer_name": "DC_CUSTOMER",
          "customer_id": 1,
          "resource_name": "Alex",
          "remarks": "[i18n]dc.som.agentinstall.remarks.unknown_credential[/i18n]"
        }
      ]
    },
    "message_version": "1.4",
    "status": "success"
  }

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