How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxDB Dashboards API

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

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.2.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.2.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

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), MosaicViewProperties (29 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-dashboards-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API
InfluxDB Legacy Authorizations API
Where this information came from

This is an independent, third-party profile of InfluxDB Dashboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.