Checks whether the latest logged-on users list has been refreshed by the 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

Polling endpoint to check whether the agent has completed a user refresh and the logged-on users list has been updated. A user refresh must be triggered first via the /users endpoint.

Request URL

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

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}/userStatus \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

true if the agent has completed the user refresh and the logged-on users list is up to date

versioninteger

Current version counter of the logged-on users data; increments on each refresh

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "isUpdated": true,
    "version": 7
  }
                
Show full

Duration: 1 minute | Threshold: 300 | 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.