DashboardsResource Resource

GET /timeseries/dashboards

Returns the list of all user-customized dashboards. This includes both the new dashboards created by users as well as any user customizations to built-in dashboards.

Available since API v6.

Response Body
media type data type
application/json ApiDashboardList (JSON)

POST /timeseries/dashboards

Creates the list of dashboards. If any of the dashboards already exist this whole command will fail and no dashboards will be created.

Available since API v6.

Request Body
media type data type description
application/json ApiDashboardList (JSON) The list of dashboards to create.
Response Body
media type data type description
application/json ApiDashboardList (JSON) The dashboards created.

DELETE /timeseries/dashboards/{dashboardName}

Deletes a dashboard.

Available since API v6.

Request Parameters
name type description default
dashboardName path The name of the dashboard. n/a
Response Body
media type data type description
application/json ApiDashboard (JSON) The deleted dashboard.

GET /timeseries/dashboards/{dashboardName}

Returns a dashboard definition for the specified name. This dashboard can be imported with the createDashboards API.

Available since API v6.

Request Parameters
name type description default
dashboardName path The name of the dashboard. n/a
Response Body
media type data type
application/json ApiDashboard (JSON)