Sensor request parameters

Prev Next

Retrieves sensor information, start or stop monitoring database, and updates specific sensor properties.

Service

Sensor

Permission

SENSOR XML API

Version

4.4.9 or later

Parameter

Definition

HH$Action

List (default), start-db, stop-db, update

HH$Name

String

HH$Id

Long

HH$Sid

String

HH$ApprovedBy

User ID

HH$Hostname

String

HH$Ip

String

HH$Database

Database ID

HH$Approved

CSV approved status

The valid values are APPROVED, DENIED, and PENDING

HH$Status

Communication status

The valid values are ALIVE, DELETED, DISCONNECTED, and STOPPED

HH$Server

Server ID

HH$pageSize

Long — The maximum number of results per call. The default value is -1 (ALL)

HH$pageNum

Long — The number of the page to return. The default value is 0

HH$Sensor-db-id

Long — (Optional) Database-sensor-db

This number reflects the connection between sensor and database

Note

You can get this variable value from using the regular sensor service. Find the related XML node <database> of your sensor. In the XML node <database>, you may find XML node <sensor-db-id>

HH$EnableNetMonitor

Enable or disable the network monitoring option

HH$AddParams

Add a list of advanced parameters to the sensor in the format param1:value1,param2:value2

The values of existing parameters are updated automatically after adding the list of advanced parameters

HH$RemoveParams

Remove a list of advanced parameters from the sensor

Examples

Note

The port number mentioned here varies depending on the Database Security configuration.

  • To get all connected sensors:

    https://127.0.0.1:8443/xmlapi.svc?service=sensor&HH$status=ALIVE

  • To start monitoring database:

    https://127.0.0.1:8443/xmlapi.svc?service=sensor&HH$Action=start-db&HH$Sensor-db-id=10000000

  • To stop monitoring database:

    https://127.0.0.1:8443/xmlapi.svc?service=sensor&HH$Action=stop-db&HH$Sensor-db-id=10000000

  • To enable network monitoring for all (non-deleted) sensors:

    https://127.0.0.1:8443/xmlapi.svc?service=sensor&HH$Action=update&HH$EnableNetMonitor=true