You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

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"
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

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

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.