Retrieve details of a specific remote office

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

Retrieves details of a specific remote office (branch office) by ID including DS details, proxy configuration, replication policy, and auto-install settings.

Endpoints

Request URL

https://{serverurl}/dcapi/som/remote-offices/{remote_office_id}

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

remote_office_idstringMandatory

Unique identifier for the remote office, get remote office id from Get Remote Offices resource_id field in response

- Query Parameters

fieldsstringOptional

Comma-separated field list for response projection.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/som/remote-offices/{remote_office_id} \
  --header 'Accept: application/remoteOfficeDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the remote office

remoteOfficeNamestring

Display name of the remote office as configured by the administrator

descriptionstring

Administrator-provided description of the remote office. Returns '--' if not set

communicationTypestring

Communication type between agents and the server: 'DS' (via Distribution Server) or 'Direct' (direct to server)

agentCommunicationstring

Protocol used for agent communication: HTTPS

managedComputerCountinteger

Total number of computers currently managed under this remote office

isProxyDefinedboolean

Whether a proxy server is configured for this remote office

proxyDetailsJSON Object

Proxy server configuration for agent communication. Present only when isProxyDefined is true

Show Sub-Attributes
proxyHoststring

Hostname or IP address of the proxy server used for agent-to-server communication

proxyPortinteger

Port number on which the proxy server listens for connections

proxyUsernamestring

Username for authenticating with the proxy server. Empty if the proxy does not require authentication

hasDSboolean

Whether a Distribution Server is associated with this remote office

dsDetailsJSON Object

Distribution Server configuration and status details. Present only when hasDS is true

Show Sub-Attributes
dsIDstring

Unique identifier of the Distribution Server

dsNamestring

Hostname or display name of the Distribution Server

dsDNSNamestring

Fully qualified DNS name of the Distribution Server

dsIPAddressarray

Array of IP addresses assigned to the Distribution Server

domainNetbiosNamestring

NetBIOS name of the domain where the Distribution Server resides

dsHTTPPortstring

HTTP port number used by the Distribution Server for communication

dsHTTPSPortstring

HTTPS port number used by the Distribution Server for secure communication

dsStatusstring

Current status of the Distribution Server (e.g., DS Installed, DS Installation Failed, DS Not Reachable)

dsVersionstring

Installed version of the Distribution Server software (e.g., 11.5.2611.03)

dsInstallationStatusinteger

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

dsLastContactTimestring

Timestamp of the last successful contact with the Distribution Server, or '--' if never contacted

updatedTimestring

Formatted timestamp of when the Distribution Server details were last updated

hasOSDeploymentboolean

Whether OS Deployment is enabled for this remote office

osdSettingsJSON Object

OS Deployment configuration including replication policy and ADK install settings. Present only when hasOSDeployment is true

Show Sub-Attributes
replicationPolicyIDstring

Unique identifier of the replication policy used for OS Deployment data synchronization

autoADKInstallinteger

Automatic Windows ADK installation flag: 0 = disabled, 1 = enabled

imageRepositoriesarray

Array of OS image repository configurations for this remote office

driverRepositoriesarray

Array of driver repository configurations for this remote office

remoteInstallationDetailsJSON Object

Auto-installation configuration including agent and DS auto-install toggles and the credential used for installation

Show Sub-Attributes
isAgentAutoInstallboolean

Whether automatic agent installation is enabled for newly discovered computers in this remote office

isDSAutoInstallboolean

Whether automatic Distribution Server installation is enabled for this remote office

credentialDetailsJSON Object

Credential details used for auto-installation of agents and Distribution Servers

Show Sub-Attributes
credentialIDstring

Unique identifier of the credential used for auto-installation. Fetch from List Credentials

credentialUUIDstring

Universally unique identifier (UUID) of the credential. Returns null if not applicable

credentialNamestring

Administrator-defined display name of the credential

domainNetbiosNamestring

NetBIOS name of the domain associated with the credential. Empty string if not domain-specific

replicationPolicyJSON Object

Summary of the replication policy assigned to this remote office for data synchronization

Show Sub-Attributes
replicationPolicyIDstring

Unique identifier of the replication policy assigned to this remote office

policyNamestring

Display name of the assigned replication policy

replicationIntervalinteger

Data sync interval in minutes between the Distribution Server and the central server

remoteControlSettingsJSON Object

Remote control session settings including compression and display color depth configuration

Show Sub-Attributes
compressioninteger

Remote control data compression: 0 = disabled, 1 = enabled. Reduces bandwidth usage during remote sessions

colorQualityinteger

Remote control display color depth in bits: 4 (16 colors), 8 (256 colors), 16 (High Color), or 24 (True Color)

- HTTP code 404

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

HTTP status code (404)

errorCodestring

Error code identifying the resource that was not found

messagestring

Error message describing the missing resource

Possible Response Codes

200HTTP code
404HTTP code

Sample Response: HTTP 200

Remote office with Distribution Server

Copied!
  {
    "dsDetails": {
      "dsHTTPSPort": "8384",
      "updatedTime": "Apr 13, 2026 04:47 PM",
      "dsName": "DSserver1",
      "dsID": "3039",
      "dsStatus": "DS Installation Failed",
      "dsVersion": "11.5.2611.03",
      "dsHTTPPort": "8021",
      "dsLastContactTime": "--",
      "dsIPAddress": [
        "10.92.63.36"
      ],
      "dsInstallationStatus": 29,
      "domainNetbiosName": "ECSOM",
      "dsDNSName": "ds.mycomp.com"
    },
    "description": "--",
    "communicationType": "DS",
    "replicationPolicy": {
      "policyName": "Business Hours Only",
      "replicationInterval": 30,
      "replicationPolicyID": "902"
    },
    "agentCommunication": "HTTPS",
    "remoteControlSettings": {
      "compression": 1,
      "colorQuality": 16
    },
    "hasDS": true,
    "hasOSDeployment": false,
    "remoteOfficeID": "906",
    "remoteOfficeName": "US DS",
    "remoteInstallationDetails": {
      "credentialDetails": {
        "credentialUUID": null,
        "credentialID": "3",
        "credentialName": "ECSOM",
        "domainNetbiosName": ""
      },
      "isDSAutoInstall": true,
      "isAgentAutoInstall": true
    },
    "isProxyDefined": false,
    "managedComputerCount": 0
  }
▼ Show full

Sample Response: HTTP 404

Remote office not found

Copied!
  {
    "errorCode": "30028",
    "message": "Remote office does not exist",
    "statusCode": 404
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.