InfluxDB Dashboards API

The Dashboards API from InfluxDB — 11 operation(s) for dashboards.

Documentation Provider Profile APIs.io OpenAPI GitHub

InfluxDB Dashboards API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 20 operations across 11 paths, and defines 77 schemas. It is described by OpenAPI 3.0.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

20 operations 11 paths 77 schemas 5 DELETE6 GET3 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

Base URL

https://cloud2.influxdata.com/api/v2

Authentication

HTTP Basic, API Key

Resource Areas

Authentication & Security 2

InfluxDB Dashboards API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication). An API key is passed in the header as Authorization (TokenAuthentication). By default, every request must be authenticated.

BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…
TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…

Paths & Operations 20

Across 11 paths, the API surfaces 20 operations — 5 DELETE, 6 GET, 3 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Dashboards 20

GET

/api/v2/dashboards

List dashboards

GetDashboards 9 params → 200default

POST

/api/v2/dashboards

Create a dashboard

PostDashboards 1 param body → 201default

DELETE

/api/v2/dashboards/{dashboardID}

Delete a dashboard

DeleteDashboardsID 2 params → 204404default

GET

/api/v2/dashboards/{dashboardID}

Retrieve a dashboard

GetDashboardsID 3 params → 200404default

PATCH

/api/v2/dashboards/{dashboardID}

Update a dashboard

PatchDashboardsID 2 params body → 200404default

POST

/api/v2/dashboards/{dashboardID}/cells

Create a dashboard cell

PostDashboardsIDCells 2 params body → 201404default

PUT

/api/v2/dashboards/{dashboardID}/cells

Replace cells in a dashboard

PutDashboardsIDCells 2 params body → 201404default

DELETE

/api/v2/dashboards/{dashboardID}/cells/{cellID}

Delete a dashboard cell

DeleteDashboardsIDCellsID 3 params → 204404default

PATCH

/api/v2/dashboards/{dashboardID}/cells/{cellID}

Update the non-positional information related to a cell

PatchDashboardsIDCellsID 3 params body → 200404default

GET

/api/v2/dashboards/{dashboardID}/cells/{cellID}/view

Retrieve the view for a cell

GetDashboardsIDCellsIDView 3 params → 200404default

PATCH

/api/v2/dashboards/{dashboardID}/cells/{cellID}/view

Update the view for a cell

PatchDashboardsIDCellsIDView 3 params body → 200404default

GET

/api/v2/dashboards/{dashboardID}/labels

List all labels for a dashboard

GetDashboardsIDLabels 2 params → 200default

POST

/api/v2/dashboards/{dashboardID}/labels

Add a label to a dashboard

PostDashboardsIDLabels 2 params body → 201default

DELETE

/api/v2/dashboards/{dashboardID}/labels/{labelID}

Delete a label from a dashboard

DeleteDashboardsIDLabelsID 3 params → 204404default

GET

/api/v2/dashboards/{dashboardID}/members

List all dashboard members

GetDashboardsIDMembers 2 params → 200default

POST

/api/v2/dashboards/{dashboardID}/members

Add a member to a dashboard

PostDashboardsIDMembers 2 params body → 201default

DELETE

/api/v2/dashboards/{dashboardID}/members/{userID}

Remove a member from a dashboard

DeleteDashboardsIDMembersID 3 params → 204default

GET

/api/v2/dashboards/{dashboardID}/owners

List all dashboard owners

GetDashboardsIDOwners 2 params → 200default

POST

/api/v2/dashboards/{dashboardID}/owners

Add an owner to a dashboard

PostDashboardsIDOwners 2 params body → 201default

DELETE

/api/v2/dashboards/{dashboardID}/owners/{userID}

Remove an owner from a dashboard

DeleteDashboardsIDOwnersID 3 params → 204default

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are ScatterViewProperties (32 properties), HeatmapViewProperties (31 properties), LinePlusSingleStatProperties (30 properties), XYViewProperties (29 properties). Each schema is shown below with its type and property counts.

AxisScale

string

Scale is the axis formatting scale. Supported: "log", "linear"

SimpleTableViewProperties

object

6 properties 6 required

HeatmapViewProperties

object

31 properties 17 required

DecimalPlaces

object

Indicates whether decimal places should be enforced, and how many digits it should show.

2 properties

ResourceMembers

object

2 properties

UserResponse

object

4 properties 1 required

RenamableField

object

Describes a field that can be renamed and made visible or invisible.

3 properties

View

object

4 properties 2 required

Cell

object

7 properties

LinePlusSingleStatProperties

object

30 properties 11 required

Labels

array

LesserThreshold

CellWithViewProperties

object

TableViewProperties

object

10 properties 10 required

Cells

array

Axis

object

Axis used in a visualization.

6 properties

CustomCheck

BandViewProperties

object

29 properties 8 required

Threshold

ThresholdBase

object

2 properties

MosaicViewProperties

object

29 properties 17 required

DashboardWithViewProperties

object

ThresholdCheck

CheckBase

object

15 properties 3 required

CreateCell

object

6 properties

GaugeViewProperties

object

11 properties 11 required

XYGeom

string

ScatterViewProperties

object

32 properties 18 required

DeadmanCheck

CheckDiscriminator

BuilderFunctionsType

object

1 property

GreaterThreshold

Error

object

4 properties 1 required

MarkdownViewProperties

object

3 properties 3 required

ResourceMember

GeoPointMapViewLayer

RangeThreshold

SingleStatViewProperties

object

12 properties 11 required

Check

AddResourceMemberRequestBody

object

2 properties 1 required

BuilderAggregateFunctionType

string

ErrorCode

string

code is the machine-readable error code.

LabelResponse

object

2 properties

DashboardColor

object

Defines an encoding of data value into color space.

5 properties 5 required

ResourceOwner

HistogramViewProperties

object

16 properties 12 required

Label

object

4 properties

DashboardQuery

object

4 properties

GeoViewLayer

object

Axes

object

The viewport for a View's visualizations

2 properties 2 required

XYViewProperties

object

29 properties 9 required

CheckViewProperties

object

11 properties 5 required

LatLonColumns

object

Object type to define lat/lon columns

2 properties 2 required

TaskStatusType

string

inactive cancels scheduled runs and prevents manual runs of the task.

LabelsResponse

object

2 properties

ViewProperties

Dashboards

object

2 properties

ResourceOwners

object

2 properties

LatLonColumn

object

Object type for key and column definitions

2 properties 2 required

CreateDashboardRequest

object

3 properties 2 required

GeoTrackMapViewLayer

object

4 properties

LabelMapping

object

A label mapping contains a label ID to attach to a resource.

1 property 1 required

GeoCircleViewLayer

CellsWithViewProperties

array

Link

string

URI of resource.

ColorMapping

object

A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.

GeoHeatMapViewLayer

BuilderTagsType

object

3 properties

CheckStatusLevel

string

The state to record if check matches a criteria.

BuilderConfig

object

4 properties

GeoViewLayerProperties

object

1 property 1 required

Dashboard

object

GeoViewProperties

object

15 properties 10 required

QueryEditMode

string

Links

object

URI pointers for additional paged results.

3 properties 1 required

StaticLegend

object

StaticLegend represents the options specific to the static legend

7 properties

CellUpdate

object

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API

AE Profile APIs.io

InfluxDB Bucket Schemas API

AE Profile APIs.io

InfluxDB Buckets API

AE Profile APIs.io

InfluxDB Cells API

AE Profile APIs.io

InfluxDB Checks API

AE Profile APIs.io

InfluxDB Config API

AE Profile APIs.io

InfluxDB Data I/O endpoints API

AE Profile APIs.io

InfluxDB DBRPs API

AE Profile APIs.io

InfluxDB Delete API

AE Profile APIs.io

InfluxDB Invokable Scripts API

AE Profile APIs.io

InfluxDB Labels API

AE Profile APIs.io

InfluxDB Legacy Authorizations API

AE Profile APIs.io

#Dashboards

← Back to I APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

InfluxDB Dashboards API

Metadata

Authentication & Security 2

Paths & Operations 20

Schemas 77

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

InfluxDB Dashboards API

Metadata

Authentication & Security 2

Paths & Operations 20

Schemas 77

Specification

Source

More from InfluxDB 12

API Details

Provider

Explore more