List managed devices

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 all managed devices along with their basic details and agent status.

Endpoints

Request URL

https://{serverurl}/bsp/api/v1/bmp/devices

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchstringOptional

Search string to filter devices by name, FQDN, or username (contains match). Example: 'laptop', 'user123'

uninstallstringOptional

Filter by agent installation status (comma-separated for multiple). Example: 'true', 'false'

limitintegerOptional

Max results per page. Example: 50, 100, 200

offsetintegerOptional

Starting index for results (0-based). Example: 0, 50, 100

skip-tokenstringOptional

Cursor-based pagination token returned from previous response for fetching next page

platform_typestringOptional

Filter by OS platform type. Example: '1' (Windows), '2' (Mac)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/devices \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

List of devices with agent details

Hide Sub-Attributes
devicesJSON Array

Device details with agent information

Show Sub-Attributes
JSON Object

Individual device entry

Show Sub-Attributes
device_idinteger

Unique device resource ID

fqdn_namestring

Fully qualified domain name

os_namestring

Operating system name

os_versionstring

Operating system version

platform_typestring

Operating system platform identifier

agent_statusstring

BSP agent installation status

agent_installed_timeinteger

Unix timestamp when agent was installed

agent_versionstring

Installed BSP agent version

user_namestring

Username of the logged-in user

agent_installed_typestring

Agent installation type identifier

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error when pagination parameters exceed the allowed range

Hide Sub-Attributes
errorCodestring

Error code indicating a pagination parameter exceeds the allowed range

errorMsgstring

Message indicating the parameter value is out of range

urlstring

Request URL that triggered the error

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Internal server error during device operations

Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Device list

Copied!
  {
    "devices": [
      {
        "agent_version": "1.0.5",
        "agent_installed_time": 1704067200000,
        "device_id": 999,
        "platform_type": 1,
        "user_name": "john.doe",
        "agent_installed_type": 1,
        "os_version": "10.0.19041",
        "agent_status": 1,
        "os_name": "Windows 10 Enterprise",
        "fqdn_name": "desktop-abc123.corp.local"
      }
    ],
    "paging": {
      "next": "<server-url>/api/v1/bmp/devices?skip-token=eyJ0eXBlIjoib2Zmc2V0IiwidmFsdWUiOjUwfQ"
    }
  }
                
Show full

Empty device list

Copied!
  {
    "devices": []
  }
                
Show full

Sample Response: HTTP 400

Pagination exceeded

Copied!
  {
    "errorCode": "COM0014",
    "url": "/bsp/api/v1/bmp/devices",
    "errorMsg": "ARRAY_SIZE_OUT_OF_RANGE"
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
Show full

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