Updating Dashboard Details
Last updated on 07 October, 2024You can use LogicMonitor REST API v3 to update dashboard details. You must authenticate yourself before making the API request.
URI: PATCH /dashboard/dashboards/{id}
URI: PUT /dashboard/dashboards/{id}
Note: As per the REST standards, any property not specified in a PUT request will revert to its default value.
| Parameter | Type | Description |
id | Integer | (Mandatory) The ID of the dashboard that you want to update. |
overwriteGroupFields | Boolean | By default, the value is set to false. If it is set to true, then overwrite all widgets group field value by default group token, that is, defaultResourceGroup and defaultWebsiteGroup. |
owner | String | If the dashboard is private, the owner is listed, else the field remains empty. It defaults to the user who adds the dashboard. |
template | JSON | The template used for importing dashboard. Note that the template field works only for the POST API requests. |
groupId | Integer | The ID of the group the dashboard belongs to. It defaults to 1 (root group). |
description | String | The description of the dashboard. Example – "description": "Windows Servers Performance" |
sharable | Boolean | Indicates whether or not the dashboard is sharable.
true unless the dashboard is a private dashboard. |
widgetsConfig | JSON | Information about widget configuration used by the UI position of widgets, such as col, sizex, row, and sizey. Example: "widgetsConfig": {"1": {"col": 1,"sizex": 6,"row": 1,"sizey": 6},"2": {"col": 10,"sizex": 3,"row": 1,"sizey": 6}} |
groupName | String | The name of group where created dashboard will reside. Example – "groupName": "Server Dashboard" |
widgetTokens | JSON List | Dashboard tokens allow you to apply a single dashboard template to different devices or website groups by changing the tokens’ value. Widget tokens contain name of the parent group of devices and child group of devices, if there is one established. The field must at least contain the default tokens ##defaultResourceGroup## and ##defaultWebsiteGroup##. You can also add custom tokens. For more info, see Using Dashboard Tokens.Example – “widgetTokens”:[{“name”:”defaultDeviceGroup”,”value”:”*”},{“name”:”defaultServiceGroup”,”value”:”*”}] |
name | String | (Mandatory) The name of the dashboard. Example – "name": "Default Device Group" |