Valarm API – Accessing Account Level Resources With Your API ID / Key

Retrieve metadata details for an individual Device Group

Valarm Tools Cloud API Key ID Device Groups Sensors Industrial IoT 3-3

Under Account Management, you can see/edit (regenerate) your Account-level API ID and Read-only API Key. These are required to access any account-level API resources. An example is shown on the right and at the bottom of this page there are step by step instructions and screenshots for getting your Valarm API ID and Key. To get your Valarm Device Group IDs, see this API tutorial on retrieving the list of device groups and group IDs associated with your account.

API to retrieve metadata details of a single Device Group:

http://tools.valarm.net/api/v1/group/{groupId}/metadata.json

(replace {groupId} in URL with the groupId of your Valarm Remote Monitoring, Sensor, and Industrial IoT devices)

Parameters:

  • apiId (required, string from Account management page)
  • apiKey (required, string from Account management page)
  • pretty (optional, for human-readability)
  • callback (optional, for JSONP)

Example:

http://tools.valarm.net/api/v1/group/53e1253430045116a0c08691/metadata.json?apiId=P6Dwb9YPy98378ihcfpkF&apiKey=TpWnQSRPBp5XwBktSSeIHXeE9yt&pretty=true

Step by step tutorial guide on setting up your Valarm sensor API ID & Key:

Valarm Tools Cloud API Key ID Device Groups Sensors Industrial IoT 1-1

Click your account name in the blue button in the upper right and then click the view button for the account you’d like to set up for your API ID + Key.

 

Valarm Tools Cloud API Key ID Device Groups Sensors Industrial IoT 2

After you’ve clicked view, click Edit on the view account screen.

 

Valarm Tools Cloud API Key ID Device Groups Sensors Industrial IoT 3-3

On the Edit Account screen you can see your API ID and Read-only API Key. Copy and paste the Valarm API text from here as you need. If you need a new API ID and API Key, click the corresponding red buttons to generate them.

 

Have a look at this API documentation for getting a list of all device groups associated with your Tools.Valarm.net account.