Class DashboardsAPI

Dashboards API

Constructors

constructor

new DashboardsAPI(influxDB: InfluxDB): DashboardsAPI
Creates DashboardsAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns DashboardsAPI
- Defined in apis/src/generated/DashboardsAPI.ts:170

Methods

deleteDashboardsID

deleteDashboardsID(
request: DeleteDashboardsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsID
Parameters
- request: DeleteDashboardsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:220

deleteDashboardsIDCellsID

deleteDashboardsIDCellsID(
request: DeleteDashboardsIDCellsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a dashboard cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDCellsID
Parameters
- request: DeleteDashboardsIDCellsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:295

deleteDashboardsIDLabelsID

deleteDashboardsIDLabelsID(
request: DeleteDashboardsIDLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a label from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDLabelsID
Parameters
- request: DeleteDashboardsIDLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:387

deleteDashboardsIDMembersID

deleteDashboardsIDMembersID(
request: DeleteDashboardsIDMembersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove a member from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDMembersID
Parameters
- request: DeleteDashboardsIDMembersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:442

deleteDashboardsIDOwnersID

deleteDashboardsIDOwnersID(
request: DeleteDashboardsIDOwnersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove an owner from a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDashboardsIDOwnersID
Parameters
- request: DeleteDashboardsIDOwnersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:497

getDashboards

getDashboards(
request?: GetDashboardsRequest,
requestOptions?: RequestOptions,
): Promise<Dashboards>
List all dashboards. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboards
Parameters
- Optionalrequest: GetDashboardsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Dashboards>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:515

getDashboardsID

getDashboardsID(
request: GetDashboardsIDRequest,
requestOptions?: RequestOptions,
): Promise<Dashboard | DashboardWithViewProperties>
Retrieve a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsID
Parameters
- request: GetDashboardsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Dashboard | DashboardWithViewProperties>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:180

getDashboardsIDCellsIDView

getDashboardsIDCellsIDView(
request: GetDashboardsIDCellsIDViewRequest,
requestOptions?: RequestOptions,
): Promise<View>
Retrieve the view for a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDCellsIDView
Parameters
- request: GetDashboardsIDCellsIDViewRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<View>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:313

getDashboardsIDLabels

getDashboardsIDLabels(
request: GetDashboardsIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels for a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDLabels
Parameters
- request: GetDashboardsIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:350

getDashboardsIDMembers

getDashboardsIDMembers(
request: GetDashboardsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMembers>
List all dashboard members. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDMembers
Parameters
- request: GetDashboardsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMembers>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:405

getDashboardsIDOwners

getDashboardsIDOwners(
request: GetDashboardsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwners>
List all dashboard owners. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDashboardsIDOwners
Parameters
- request: GetDashboardsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwners>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:460

patchDashboardsID

patchDashboardsID(
request: PatchDashboardsIDRequest,
requestOptions?: RequestOptions,
): Promise<Dashboard>
Update a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsID
Parameters
- request: PatchDashboardsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Dashboard>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:201

patchDashboardsIDCellsID

patchDashboardsIDCellsID(
request: PatchDashboardsIDCellsIDRequest,
requestOptions?: RequestOptions,
): Promise<Cell>
Update the non-positional information related to a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsIDCellsID
Parameters
- request: PatchDashboardsIDCellsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Cell>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:276

patchDashboardsIDCellsIDView

patchDashboardsIDCellsIDView(
request: PatchDashboardsIDCellsIDViewRequest,
requestOptions?: RequestOptions,
): Promise<View>
Update the view for a cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDashboardsIDCellsIDView
Parameters
- request: PatchDashboardsIDCellsIDViewRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<View>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:331

postDashboards

postDashboards(
request: PostDashboardsRequest,
requestOptions?: RequestOptions,
): Promise<Dashboard | DashboardWithViewProperties>
Create a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboards
Parameters
- request: PostDashboardsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Dashboard | DashboardWithViewProperties>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:542

postDashboardsIDCells

postDashboardsIDCells(
request: PostDashboardsIDCellsRequest,
requestOptions?: RequestOptions,
): Promise<Cell>
Create a dashboard cell. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDCells
Parameters
- request: PostDashboardsIDCellsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Cell>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:238

postDashboardsIDLabels

postDashboardsIDLabels(
request: PostDashboardsIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Add a label to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDLabels
Parameters
- request: PostDashboardsIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:368

postDashboardsIDMembers

postDashboardsIDMembers(
request: PostDashboardsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMember>
Add a member to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDMembers
Parameters
- request: PostDashboardsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMember>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:423

postDashboardsIDOwners

postDashboardsIDOwners(
request: PostDashboardsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwner>
Add an owner to a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDashboardsIDOwners
Parameters
- request: PostDashboardsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwner>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:478

putDashboardsIDCells

putDashboardsIDCells(
request: PutDashboardsIDCellsRequest,
requestOptions?: RequestOptions,
): Promise<Dashboard>
Replace cells in a dashboard. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutDashboardsIDCells
Parameters
- request: PutDashboardsIDCellsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Dashboard>
promise of response
- Defined in apis/src/generated/DashboardsAPI.ts:257

Class DashboardsAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DashboardsAPI

Methods

deleteDashboardsID

Parameters

Returns Promise<void>

deleteDashboardsIDCellsID

Parameters

Returns Promise<void>

deleteDashboardsIDLabelsID

Parameters

Returns Promise<void>

deleteDashboardsIDMembersID

Parameters

Returns Promise<void>

deleteDashboardsIDOwnersID

Parameters

Returns Promise<void>

getDashboards

Parameters

Returns Promise<Dashboards>

getDashboardsID

Parameters

Returns Promise<Dashboard | DashboardWithViewProperties>

getDashboardsIDCellsIDView

Parameters

Returns Promise<View>

getDashboardsIDLabels

Parameters

Returns Promise<LabelsResponse>

getDashboardsIDMembers

Parameters

Returns Promise<ResourceMembers>

getDashboardsIDOwners

Parameters

Returns Promise<ResourceOwners>

patchDashboardsID

Parameters

Returns Promise<Dashboard>

patchDashboardsIDCellsID

Parameters

Returns Promise<Cell>

patchDashboardsIDCellsIDView

Parameters

Returns Promise<View>

postDashboards

Parameters

Returns Promise<Dashboard | DashboardWithViewProperties>

postDashboardsIDCells

Parameters

Returns Promise<Cell>

postDashboardsIDLabels

Parameters

Returns Promise<LabelResponse>

postDashboardsIDMembers

Parameters

Returns Promise<ResourceMember>

postDashboardsIDOwners

Parameters

Returns Promise<ResourceOwner>

putDashboardsIDCells

Parameters

Returns Promise<Dashboard>

Settings

On This Page