RPC API Developer's Guide (Deprecated)

RPC API: Update a Dashboard

Note that LogicMonitor does have an available REST API equivalent for this API call.

LogicMonitor's RPC API enables you to update your dashboards using updateDashboard.

Note: As with all of our APIs, authentication is required.

 

URL:
https://accountName.logicmonitor.com/santaba/rpc/updateDashboard?c=accountName&u=user&p=password&id=dashboardId&name=dashboardName&description=dashboardDescription&sharable=trueOrFalse

 

Request Parameters: You can include the following as query parameters in an updateDashboard request:

Parameter

Type

Description

id Integer Required. The Id of the dashboard to be updated.
name String Required. The name of the dashboard to be updated.
description String Optional. The description of the dashboard.
sharable Boolean Optional. When true, this value indicates that the dashboard can be shared across users. When false, this value indicates that the dashboard is a private dashboard.

 

All outputs will be in the format: { [status], [data], [errmsg] }, where status is the status of the response, errmsg is the error message associated with the response, and the data object includes the following:

  • id
  • name
  • description
  • sharable
  • adminId (note that this value is equal to 0 when the dashboard sharable value is true)

 

Example

Request:
curl "https://apiAccount.logicmonitor.com/santaba/rpc/updateDashboard?c=apiAccount&u=apiUser&p=example&id=52&description=new%20description&name=MyDashboard" 
Response:
{
  "status": 200,
  "data": {
    "widgets": [],
    "dashboard": {
      "widgetsOrder": "",
      "id": 52,
      "adminId": 4,
      "description": "new description",
      "sharable": false,
      "name": "MyDashboard",
      "widgetsConfig": "",
      "folderId": 1
    }
  },
  "errmsg": "OK"
}