Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData Dashboards API

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

InfluxData Dashboards API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 20 operations across 11 paths, and defines 76 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

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

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

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

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

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
/dashboards/{dashboardID}
Retrieve a dashboard
GetDashboardsID 3 params → 200404default
PATCH
/dashboards/{dashboardID}
Update a dashboard
PatchDashboardsID 2 params body → 200404default
DELETE
/dashboards/{dashboardID}
Delete a dashboard
DeleteDashboardsID 2 params → 204404default
PUT
/dashboards/{dashboardID}/cells
Replace cells in a dashboard
PutDashboardsIDCells 2 params body → 201404default
POST
/dashboards/{dashboardID}/cells
Create a dashboard cell
PostDashboardsIDCells 2 params body → 201404default
PATCH
/dashboards/{dashboardID}/cells/{cellID}
Update the non-positional information related to a cell
PatchDashboardsIDCellsID 3 params body → 200404default
DELETE
/dashboards/{dashboardID}/cells/{cellID}
Delete a dashboard cell
DeleteDashboardsIDCellsID 3 params → 204404default
GET
/dashboards/{dashboardID}/cells/{cellID}/view
Retrieve the view for a cell
GetDashboardsIDCellsIDView 3 params → 200404default
PATCH
/dashboards/{dashboardID}/cells/{cellID}/view
Update the view for a cell
PatchDashboardsIDCellsIDView 3 params body → 200404default
GET
/dashboards/{dashboardID}/labels
List all labels for a dashboard
GetDashboardsIDLabels 2 params → 200default
POST
/dashboards/{dashboardID}/labels
Add a label to a dashboard
PostDashboardsIDLabels 2 params body → 201default
DELETE
/dashboards/{dashboardID}/labels/{labelID}
Delete a label from a dashboard
DeleteDashboardsIDLabelsID 3 params → 204404default
GET
/dashboards/{dashboardID}/members
List all dashboard members
GetDashboardsIDMembers 2 params → 200default
POST
/dashboards/{dashboardID}/members
Add a member to a dashboard
PostDashboardsIDMembers 2 params body → 201default
DELETE
/dashboards/{dashboardID}/members/{userID}
Remove a member from a dashboard
DeleteDashboardsIDMembersID 3 params → 204default
GET
/dashboards/{dashboardID}/owners
List all dashboard owners
GetDashboardsIDOwners 2 params → 200default
POST
/dashboards/{dashboardID}/owners
Add an owner to a dashboard
PostDashboardsIDOwners 2 params body → 201default
DELETE
/dashboards/{dashboardID}/owners/{userID}
Remove an owner from a dashboard
DeleteDashboardsIDOwnersID 3 params → 204default
POST
/dashboards
Create a dashboard
PostDashboards 1 param body → 201default
GET
/dashboards
List dashboards
GetDashboards 9 params → 200default

Schemas 76

The contract defines 76 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.

TableViewProperties
object
10 properties 10 required
BuilderTagsType
object
3 properties
Cells
array
CellWithViewProperties
object
StaticLegend
object
StaticLegend represents the options specific to the static legend
7 properties
QueryEditMode
string
GeoViewLayerProperties
object
1 property 1 required
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.
ViewProperties
CellsWithViewProperties
array
BuilderConfig
object
4 properties
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
GaugeViewProperties
object
11 properties 11 required
ResourceOwner
View
object
4 properties 2 required
CustomCheck
Link
string
URI of resource.
Links
object
URI pointers for additional paged results.
3 properties 1 required
ResourceMember
DashboardQuery
object
4 properties
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
ThresholdCheck
AxisScale
string
Scale is the axis formatting scale. Supported: "log", "linear"
BuilderFunctionsType
object
1 property
Threshold
DeadmanCheck
Labels
array
ThresholdBase
object
2 properties
DashboardColor
object
Defines an encoding of data value into color space.
5 properties 5 required
SingleStatViewProperties
object
12 properties 11 required
LatLonColumns
object
Object type to define lat/lon columns
2 properties 2 required
HistogramViewProperties
object
16 properties 12 required
RangeThreshold
CreateDashboardRequest
object
3 properties 2 required
CheckBase
object
15 properties 3 required
CheckStatusLevel
string
The state to record if check matches a criteria.
AddResourceMemberRequestBody
object
2 properties 1 required
GeoPointMapViewLayer
CheckDiscriminator
CreateCell
object
6 properties
RenamableField
object
Describes a field that can be renamed and made visible or invisible.
3 properties
MosaicViewProperties
object
29 properties 17 required
GeoHeatMapViewLayer
MarkdownViewProperties
object
3 properties 3 required
ResourceOwners
object
2 properties
GeoViewLayer
object
Check
SimpleTableViewProperties
object
6 properties 6 required
LatLonColumn
object
Object type for key and column definitions
2 properties 2 required
BandViewProperties
object
29 properties 8 required
ScatterViewProperties
object
32 properties 18 required
ResourceMembers
object
2 properties
Error
object
4 properties 1 required
Cell
object
7 properties
GeoViewProperties
object
15 properties 10 required
CellUpdate
object
4 properties
LinePlusSingleStatProperties
object
30 properties 11 required
Axes
object
The viewport for a View's visualizations
2 properties 2 required
BuilderAggregateFunctionType
string
Axis
object
Axis used in a visualization.
6 properties
DashboardWithViewProperties
object
HeatmapViewProperties
object
31 properties 17 required
Dashboards
object
2 properties
UserResponse
object
4 properties 1 required
GeoCircleViewLayer
Dashboard
object
DecimalPlaces
object
Indicates whether decimal places should be enforced, and how many digits it should show.
2 properties
XYViewProperties
object
29 properties 9 required
CheckViewProperties
object
11 properties 5 required
LesserThreshold
LabelsResponse
object
2 properties
XYGeom
string
GeoTrackMapViewLayer
object
4 properties
LabelResponse
object
2 properties
GreaterThreshold
Label
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-dashboards-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API
InfluxData Health API