Retrieve real-time live status of a computer agent

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 the real-time live status of a specific computer's agent. Returns whether the computer is currently online or offline.

Request URL

https://{serverurl}/dcapi/som/computers/{computer_resource_id}/liveStatus

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

computer_resource_idstringMandatory

Unique identifier for the computer, get resource id from Get Computers

Sample Request

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

Response Parameters

- HTTP code 200

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

true if the computer agent is currently online, false if offline

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Computer agent is online

Copied!
  {
    "isComputerLive": true
  }
                
Show full

Computer agent is offline

Copied!
  {
    "isComputerLive": false
  }
                
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.