object dashboard.create(object/array dashboards)
This method allows to create new dashboards.
(object/array)
Dashboards to create.
Additionally to the standard dashboard properties, the method accepts the following parameters.
Parameter | Type | Description |
---|---|---|
widgets | array | Dashboard widgets to be created for the dashboard. |
users | array | Dashboard user shares to be created on the dashboard. |
userGroups | array | Dashboard user group shares to be created on the dashboard. |
(object)
Returns an object containing the IDs of the created dashboards under the dashboardids
property. The order of the returned IDs matches the order of the passed dashboards.
Create a dashboard named “My dashboard” with one Problems widget with tags and using two types of sharing (user group and user).
Request:
{ "jsonrpc": "2.0", "method": "dashboard.create", "params": { "name": "My dashboard", "widgets": [ { "type": "problems", "x": 0, "y": 0, "width": 6, "height": 5, "fields": [ { "type": 1, "name": "tags.tag.0", "value": "service" }, { "type": 0, "name": "tags.operator.0", "value": 1 }, { "type": 1, "name": "tags.value.0", "value": "zabbix_server" } ] } ], "userGroups": [ { "usrgrpid": "7", "permission": "2" } ], "users": [ { "userid": "4", "permission": "3" } ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": { "dashboardids": [ "2" ] }, "id": 1 }
CDashboard::create() in frontends/php/include/classes/api/services/CDashboard.php.