Dashboards
/api/v2/dashboardsList dashboards
Parameters
Query parameters
offset
integerThe offset for pagination. The number of records to skip.
For more information about pagination parameters, see Pagination.
limit
integer20.20descending
booleanowner
stringowner role.sortBy
stringID
, CreatedAt
, UpdatedAtid
arrayid and owner, only id is used.orgID
stringorg
stringHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
dashboards
object[]links
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboardsCreate a dashboard
Parameters
Header parameters
Zap-Trace-Span
stringRequest body required
application/jsondescription
stringname
required
stringorgID
required
stringcurl --request POST \
"http://localhost:8086/api/v2/dashboards" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"description": "DESCRIPTION",
"name": "NAME",
"orgID": "ORGID"
}'Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}Retrieve a dashboard
Parameters
Path parameters
dashboardID
required
stringQuery parameters
include
stringproperties, includes the cell view properties in the response.propertiesHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards/{dashboardID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}Update a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsoncells
stringdescription
stringname
stringcurl --request PATCH \
"http://localhost:8086/api/v2/dashboards/{dashboardID}" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"cells": {},
"description": "DESCRIPTION",
"name": "NAME"
}'Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}Delete a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request DELETE \
"http://localhost:8086/api/v2/dashboards/{dashboardID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cellsCreate a dashboard cell
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonh
integer <int32>name
stringusingView
stringw
integer <int32>x
integer <int32>y
integer <int32>curl --request POST \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"h": 0,
"name": "NAME",
"usingView": "USINGVIEW",
"w": 0,
"x": 0,
"y": 0
}'Responses
h
integer <int32>id
stringlinks
objectself
stringview
stringviewID
stringw
integer <int32>x
integer <int32>y
integer <int32>code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cellsReplace cells in a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsoncurl --request PUT \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cells/{cellID}Update the non-positional information related to a cell
Parameters
Path parameters
dashboardID
required
stringcellID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonh
integer <int32>w
integer <int32>x
integer <int32>y
integer <int32>curl --request PATCH \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"h": 0,
"w": 0,
"x": 0,
"y": 0
}'Responses
h
integer <int32>id
stringlinks
objectself
stringview
stringviewID
stringw
integer <int32>x
integer <int32>y
integer <int32>code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cells/{cellID}Delete a dashboard cell
Parameters
Path parameters
dashboardID
required
stringcellID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request DELETE \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cells/{cellID}/viewRetrieve the view for a cell
Parameters
Path parameters
dashboardID
required
stringcellID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}/view" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
id
stringlinks
objectself
stringname
required
stringproperties
required
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/cells/{cellID}/viewUpdate the view for a cell
Parameters
Path parameters
dashboardID
required
stringcellID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonid
stringlinks
objectself
stringname
required
stringproperties
required
stringcurl --request PATCH \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}/view" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "ID",
"links": {},
"name": "NAME",
"properties": "PROPERTIES"
}'Responses
id
stringlinks
objectself
stringname
required
stringproperties
required
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/labelsList all labels for a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/labels" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
labels
stringlinks
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/labelsAdd a label to a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonlabelID
required
stringcurl --request POST \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/labels" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"labelID": "LABELID"
}'Responses
label
stringlinks
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/labels/{labelID}Delete a label from a dashboard
Parameters
Path parameters
dashboardID
required
stringlabelID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request DELETE \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/labels/{labelID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringcode
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/membersList all dashboard members
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/members" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
links
objectself
string <uri>users
object[]code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/membersAdd a member to a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonid
required
stringname
stringcurl --request POST \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/members" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "ID",
"name": "NAME"
}'Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/members/{userID}Remove a member from a dashboard
Parameters
Path parameters
userID
required
stringdashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request DELETE \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/members/{userID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/ownersList all dashboard owners
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request GET \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/owners" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
links
objectself
string <uri>users
object[]code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/ownersAdd an owner to a dashboard
Parameters
Path parameters
dashboardID
required
stringHeader parameters
Zap-Trace-Span
stringRequest body required
application/jsonid
required
stringname
stringcurl --request POST \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/owners" \
--header "Authorization: Bearer INFLUX_TOKEN" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "ID",
"name": "NAME"
}'Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
string/api/v2/dashboards/{dashboardID}/owners/{userID}Remove an owner from a dashboard
Parameters
Path parameters
userID
required
stringdashboardID
required
stringHeader parameters
Zap-Trace-Span
stringcurl --request DELETE \
"http://localhost:8086/api/v2/dashboards/{dashboardID}/owners/{userID}" \
--header "Authorization: Bearer INFLUX_TOKEN"Responses
code
required
stringinternal error
, not implemented
, not found
, conflict
, invalid
, unprocessable entity
, empty value
, unavailable
, forbidden
, too many requests
, unauthorized
, method not allowed
, request too large
, unsupported media typeerr
stringmessage
stringop
stringWas this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.