influxdb-client-js

InfluxDB 2.0 JavaScript client

View the Project on GitHub influxdata/influxdb-client-js

Home > @influxdata/influxdb-client-apis > DashboardsAPI

DashboardsAPI class

Dashboards API

Signature:

declare class DashboardsAPI 

Constructors

Constructor Modifiers Description
(constructor)(influxDB)   Creates DashboardsAPI

Methods

Method Modifiers Description
deleteDashboardsID(request, requestOptions)   Delete a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsID
deleteDashboardsIDCellsID(request, requestOptions)   Delete a dashboard cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDCellsID
deleteDashboardsIDLabelsID(request, requestOptions)   Delete a label from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDLabelsID
deleteDashboardsIDMembersID(request, requestOptions)   Remove a member from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDMembersID
deleteDashboardsIDOwnersID(request, requestOptions)   Remove an owner from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDOwnersID
getDashboards(request, requestOptions)   List all dashboards. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboards
getDashboardsID(request, requestOptions)   Retrieve a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsID
getDashboardsIDCellsIDView(request, requestOptions)   Retrieve the view for a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDCellsIDView
getDashboardsIDLabels(request, requestOptions)   List all labels for a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDLabels
getDashboardsIDMembers(request, requestOptions)   List all dashboard members. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDMembers
getDashboardsIDOwners(request, requestOptions)   List all dashboard owners. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDOwners
patchDashboardsID(request, requestOptions)   Update a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsID
patchDashboardsIDCellsID(request, requestOptions)   Update the non-positional information related to a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsIDCellsID
patchDashboardsIDCellsIDView(request, requestOptions)   Update the view for a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsIDCellsIDView
postDashboards(request, requestOptions)   Create a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboards
postDashboardsIDCells(request, requestOptions)   Create a dashboard cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDCells
postDashboardsIDLabels(request, requestOptions)   Add a label to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDLabels
postDashboardsIDMembers(request, requestOptions)   Add a member to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDMembers
postDashboardsIDOwners(request, requestOptions)   Add an owner to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDOwners
putDashboardsIDCells(request, requestOptions)   Replace cells in a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutDashboardsIDCells