Triggers the agent to refresh the logged-on users list for the specified computer

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

Sends a refresh command to the agent on the specified computer to update the currently logged-on users list. The refreshed data can be polled via the userStatus endpoint.

Request URL

https://{server-hostname}:8383/dcapi/tools/{resourceId}/users

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

resourceIdstringMandatory

The unique identifier of the target device

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/{resourceId}/users \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Status of the refresh trigger: refresh_triggered or failed

resourceIdlong

Resource identifier of the computer for which the refresh was triggered

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "resourceId": 101,
    "status": "refresh_triggered"
  }
                
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.