Sidebar

dashboard.delete

Description

object dashboard.delete(array dashboardids)

This method allows to delete dashboards.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the dashboards to delete.

Return values

(object) Returns an object containing the IDs of the deleted dashboards under the dashboardids property.

Examples

Deleting multiple dashboards

Delete two dashboards.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.delete",
           "params": [
               "2",
               "3"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "2",
                   "3"
               ]
           },
           "id": 1
       }

Source

CDashboard::delete() in ui/include/classes/api/services/CDashboard.php.