Overview
The device resource allows you to programmatically manage your LogicMonitor dashboard groups. As with all of our API calls, authentication is required.
Using LogicMonitor’s REST API you can:
- Get a list of all dashboard groups
- Get information about a particular dashboard group
- Add a dashboard group
- Update a dashboard group
- Delete a dashboard group
Resource Information
Resource URI: /dashboard/groups
Resource Properties: All dashboard groups have the following properties.
| Property | Description | Type |
| id | The Id of the dashboard group | Integer |
| parentId | The Id of the parent dashboard group | Integer |
| name | The name of the dashboard group | String |
| fullPath | The full path of the dashboard group | String |
| description | The description of the dashboard group | String |
| dashboards | The dashboards that belong to the group | JSON Object |
| userPermission | The permission of the user that made the API call | String |
| numOfDirectSubGroups | The number of groups directly under the Dashboard Group | Integer |
| numOfDashboards | The number of dashboards that belong to the Dashboard Group and any sub-groups | Integer |
| numOfDirectDashboards | The number of dashboards that belong directly to the Dashboard Group | Integer |
| widgetTokens | The tokens assigned at the group level | JSON Object |
You can use LogicMonitor’s REST API to programmatically add dashboard groups to your account. As with all of our API calls, authentication is required.
HTTP Method: POST
URI: /dashboard/groups
Request Parameters: You can POST the following properties for all new dashboard groups.
| Property | Description | Required? | Type |
| name | The name of the dashboard group | Yes | String |
| description | The description of the dashboard group | No. Defaults to a blank string. | String |
| parentId | The id of the parent group (id=1 means the group will be top level) | No. Defaults to 1. | Integer |
| widgetTokens | The tokens assigned at the group level, where name and value should be specified (e.g. widgetTokens =[{“name”:”defaultDeviceGroup”,”value”:”Prod AWS”}]) | No. Defaults to no tokens. | JSON Object |
You can use LogicMonitor’s REST API to update the dashboard groups in your account. As with all of our API calls, authentication is required.
Note: Consistent with REST standards, any properties not specified in a PUT request will revert back to their default values.
HTTP Method: PUT
URI: /dashboard/groups/{id}
Request Parameters:
| Property | Description | Required? | Type |
| name | The name of the dashboard | Yes | String |
| parentId | The id of the parent group | No. Defaults to 1 (root group) | Integer |
| description | The description of the dashboard | No. Defaults to a blank string. | String |
| widgetTokens | The tokens assigned at the group level, where name and value should be specified (e.g. widgetTokens =[{“name”:”defaultDeviceGroup”,”value”:”Prod AWS”}]) | No. Defaults to no tokens. | JSON Object |
Overview
You can use LogicMonitor’s REST API to programmatically get information about the dashboard groups in your account. Specifically, you can:
- Get a list of dashboard groups
- Get information about a particular dashboard group
Note: As with all of our API calls, authentication is required.
Get a List of Dashboard Groups
HTTP Method: GET
Resource URI: /dashboard/groups
Request Parameters: By default, a list of 50 Dashboard Groups will be returned. You can include sort, filter, fields, size and offset parameters in your request to control what data is included in the response and how it is formatted.
| Property | Syntax | Description | Example URI |
| sort | sort={+ or -}property | Sorts the response by the property specified in either increasing (+) or decreasing (-) order | /dashboard/groups?sort=-id |
| filter | filter=property{operator}value | Filters the response according to the operator and value specified. Note that you can use * to match on more than one character.You can use the ‘.’ character to filter values within an object (e.g. custom properties), and multiple filters can be separated by a comma.
Operators include:
|
/dashboard/groups?filter=description~QA* |
| fields | fields={list of properties separated by commas} | Filters the response to only include the following fields for each object | /dashboard/groups?fields=id,description |
| size | size=integer | The number of results to display | /dashboard/groups?size=5 |
| offset | offset=integer | The number of results to offset the displayed results by | /dashboard/groups?offset=2 |
Get Information About a Specific Dashboard Group
HTTP Method: GET
Resource URI: /dashboard/groups/{id}
You can use LogicMonitor’s REST API to programmatically delete dashboard groups from your account. As with all of our API calls, authentication is required.
HTTP Method: DELETE
Resource URI: /dashboard/groups/{id}
