Retrieve library entries for sensors or remote actions

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

Get a list of available sensor or remote action scripts. You can filter by platform and paginate the results.

Request URL

https://{serverurl}/intelligence/sensors/api/libraries

Scope

DesktopCentralCloud.Platform.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

typestringMandatory

Library type to retrieve: 'sensor' or 'remote_action'

platformstringOptional

Filter by platform: WINDOWS, LINUX, MAC. Default: all

offsetstringOptional

Pagination offset. Default: 0

limitstringOptional

Maximum number of results. Default: 1000

filterstringOptional

Text filter to search library entries by name

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/intelligence/sensors/api/libraries?type=SOME_STRING_VALUE' \
  --header 'Accept: application/SensorsList.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Script name in the library (e.g., 'CollectDisk.ps1')

libraryIdlong

Unique identifier of the library script

descriptionstring

Description of what the script does

libraryTypestring

Script file extension: ps1, vbs, bat, or sh

platformstring

Platform code: 1=Windows, 2=Mac, 3=Linux, 4=All

- HTTP code 500

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

Error code for library retrieval failure

errorMessagestring

Details about the library retrieval failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Sensor library entries for Windows

Copied!
  [
    {
      "libraryName": "CollectDisk.ps1",
      "libraryId": 4501,
      "description": "Collect disk usage",
      "libraryType": "ps1",
      "platform": 1
    }
  ]
                
Show full

Sample Response: HTTP 500

Could not load library entries

Copied!
  {
    "errorMessage": "Failed to retrieve sensor library entries.",
    "errorCode": "LIBRARY_FETCH_ERROR"
  }
                
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.