--- title: Dashboards description: Create and manage dashboards in InfluxDB OSS v2. url: https://docs.influxdata.com/influxdb/v2/api/dashboards/ estimated_tokens: 28984 product: InfluxDB OSS v2 version: v2 publisher: InfluxData canonical: https://docs.influxdata.com/influxdb/v2/api/dashboards/ --- [Download InfluxDB API Spec](/openapi/influxdb-oss-v2-api.yml) Create and manage dashboards in InfluxDB OSS v2. GET`/api/v2/dashboards` ### List dashboards Lists [dashboards](/influxdb/v2/reference/glossary/#dashboard). #### Related guides * [Manage dashboards](/influxdb/v2/visualize-data/dashboards/). #### Parameters ##### Query parameters `offset`integer The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](/influxdb/v2/api/#tag/Pagination). `limit`integer Limits the number of records returned. Default is `20`. Default:`20` `descending`boolean `owner`string A user ID. Only returns [dashboards](/influxdb/v2/reference/glossary/#dashboard) where the specified user has the `owner` role. `sortBy`string The column to sort by. Allowed values:`ID`, `CreatedAt`, `UpdatedAt` `id`array A list of dashboard IDs. Returns only the specified [dashboards](/influxdb/v2/reference/glossary/#dashboard). If you specify `id` and `owner`, only `id` is used. `orgID`string An organization ID. Only returns [dashboards](/influxdb/v2/reference/glossary/#dashboard) that belong to the specified[organization](/influxdb/v2/reference/glossary/#organization). `org`string An organization name. Only returns [dashboards](/influxdb/v2/reference/glossary/#dashboard) that belong to the specified[organization](/influxdb/v2/reference/glossary/#organization). ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Success. The response body contains dashboards. `dashboards`object[] `cells`object[] `h`integer \ `id`string `links`object `viewID`string The reference to a view from the views API. `w`integer \ `x`integer \ `y`integer \ `description`string The user-facing description of the dashboard. `id`string `labels`object[] `id`string `name`string `orgID`string `properties`object Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key. Example:`{"color":"ffb3b3","description":"this is a description"}` `links`object Example:`{"cells":"/api/v2/dashboards/1/cells","labels":"/api/v2/dashboards/1/labels","members":"/api/v2/dashboards/1/members","org":"/api/v2/labels/1","owners":"/api/v2/dashboards/1/owners","self":"/api/v2/dashboards/1"}` `cells`string \ URI of resource. `labels`string \ URI of resource. `members`string \ URI of resource. `org`string \ URI of resource. `owners`string \ URI of resource. `self`string \ URI of resource. `meta`object `createdAt`string \ `updatedAt`string \ `name`requiredstring The user-facing name of the dashboard. `orgID`requiredstring The ID of the organization that owns the dashboard. `links`object URI pointers for additional paged results. `next`string \ URI of resource. `prev`string \ URI of resource. `self`requiredstring \ URI of resource. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. POST`/api/v2/dashboards` ### Create a dashboard #### Parameters ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Dashboard to create Content-Type:`application/json` `description`string The user-facing description of the dashboard. `name`requiredstring The user-facing name of the dashboard. `orgID`requiredstring The ID of the organization that owns the dashboard. Example request[Ask AI about this](#) ```sh curl --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 201Success. The dashboard is created. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. GET`/api/v2/dashboards/{dashboardID}` ### Retrieve a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. ##### Query parameters `include`string If `properties`, includes the cell view properties in the response. Allowed values:`properties` ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards/{dashboardID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Retrieve a single dashboard 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. PATCH`/api/v2/dashboards/{dashboardID}` ### Update a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Patching of a dashboard Content-Type:`application/json` `cells`object `h`integer \ `id`string `links`object `self`string `view`string `name`string `properties`object or object or object or object or object or object or object or object or object or object or object or object or object or object One of:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `colors`requiredobject[] Colors define color encoding of data into a visualization `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `prefix`requiredstring `queries`requiredobject[] `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `suffix`requiredstring `timeFormat`string `type`requiredstring Allowed:`line-plus-single-stat` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `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. Example:`{"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}` `colors`requiredobject[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `timeFormat`string `type`requiredstring Allowed:`xy` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`single-stat` Or:object `binCount`requiredinteger `colors`requiredobject[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`histogram` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`gauge` Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `fieldOptions`requiredobject[] fieldOptions represent the fields retrieved by the query with customization options `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `tableOptions`requiredobject `timeFormat`requiredstring timeFormat describes the display format for time values according to moment.js date formatting `type`requiredstring Allowed:`table` Or:object `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showAll`requiredboolean `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`simple-table` Or:object `note`requiredstring `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`markdown` Or:object `adaptiveZoomHide`boolean `check`object or object or object `checkID`requiredstring `colors`requiredobject[] Colors define color encoding of data into a visualization `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`check` Or:object `adaptiveZoomHide`boolean `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `symbolColumns`requiredstring[] `timeFormat`string `type`requiredstring Allowed:`scatter` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `binSize`requirednumber `colors`requiredstring[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`heatmap` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`mosaic` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yDomain`requirednumber[] `yLabelColumnSeparator`string `yLabelColumns`string[] `yPrefix`requiredstring `ySeriesColumns`requiredstring[] `ySuffix`requiredstring Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `colors`requiredobject[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `lowerColumn`string `mainColumn`string `note`requiredstring `queries`requiredobject[] `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `timeFormat`string `type`requiredstring Allowed:`band` `upperColumn`string `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `allowPanAndZoom`requiredboolean If true, map zoom and pan controls are enabled on the dashboard view Default:`true` `center`requiredobject Coordinates of the center of the map `colors`object[] Colors define color encoding of data into a visualization `detectCoordinateFields`requiredboolean If true, search results get automatically regroupped so that lon,lat and value are treated as columns Default:`true` `latLonColumns`object Object type to define lat/lon columns `layers`requiredobject[] List of individual layers shown in the map `mapStyle`string Define map type - regular, satellite etc. `note`requiredstring `queries`requiredobject[] `s2Column`string String to define the column `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`geo` `useS2CellID`boolean If true, S2 column is used to calculate lat/lon `zoom`requirednumber \ Zoom level used for initial display of the map `viewID`string The reference to a view from the views API. `w`integer \ `x`integer \ `y`integer \ `description`string optional, when provided will replace the description `name`string optional, when provided will replace the name Example request[Ask AI about this](#) ```sh curl --request PATCH \ "http://localhost:8086/api/v2/dashboards/{dashboardID}" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "cells": { "h": 0, "id": "ID", "links": { "self": "SELF", "view": "VIEW" }, "name": "NAME", "properties": {}, "viewID": "VIEWID", "w": 0, "x": 0, "y": 0 }, "description": "DESCRIPTION", "name": "NAME" }' ``` #### Responses 200Updated dashboard 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. DELETE`/api/v2/dashboards/{dashboardID}` ### Delete a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/dashboards/{dashboardID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Delete has been accepted 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. POST`/api/v2/dashboards/{dashboardID}/cells` ### Create a dashboard cell #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Cell that will be added Content-Type:`application/json` `h`integer \ `name`string `usingView`string Makes a copy of the provided view. `w`integer \ `x`integer \ `y`integer \ Example request[Ask AI about this](#) ```sh 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 201Cell successfully added `h`integer \ `id`string `links`object `self`string `view`string `viewID`string The reference to a view from the views API. `w`integer \ `x`integer \ `y`integer \ 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. PUT`/api/v2/dashboards/{dashboardID}/cells` ### Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells. #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Content-Type:`application/json` Example request[Ask AI about this](#) ```sh curl --request PUT \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/cells" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" ``` #### Responses 201Replaced dashboard cells 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. PATCH`/api/v2/dashboards/{dashboardID}/cells/{cellID}` ### Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell’s positional data could cause grid conflicts. #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. `cellID`requiredstring The ID of the cell to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Content-Type:`application/json` `h`integer \ `w`integer \ `x`integer \ `y`integer \ Example request[Ask AI about this](#) ```sh 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 200Updated dashboard cell `h`integer \ `id`string `links`object `self`string `view`string `viewID`string The reference to a view from the views API. `w`integer \ `x`integer \ `y`integer \ 404Cell or dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. DELETE`/api/v2/dashboards/{dashboardID}/cells/{cellID}` ### Delete a dashboard cell #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to delete. `cellID`requiredstring The ID of the cell to delete. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Cell successfully deleted 404Cell or dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. GET`/api/v2/dashboards/{dashboardID}/cells/{cellID}/view` ### Retrieve the view for a cell #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. `cellID`requiredstring The cell ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/cells/{cellID}/view" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200A dashboard cells view `id`string `links`object `self`string `name`requiredstring `properties`requiredobject or object or object or object or object or object or object or object or object or object or object or object or object or object One of:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `generateXAxisTicks`string[] `generateYAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `timeFormat`string `type`requiredstring Allowed:`line-plus-single-stat` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `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. Example:`{"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}` `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`xy` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`single-stat` Or:object `binCount`requiredinteger `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `fillColumns`requiredstring[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`histogram` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`gauge` Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `fieldOptions`requiredobject[] fieldOptions represent the fields retrieved by the query with customization options `displayName`string The name that a field is renamed to by the user. `internalName`string The calculated name of a field. `visible`boolean Indicates whether this field should be visible on the table. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `tableOptions`requiredobject `fixFirstColumn`boolean fixFirstColumn indicates whether the first column of the table should be locked `sortBy`object Describes a field that can be renamed and made visible or invisible. `verticalTimeAxis`boolean verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically `wrapping`string Wrapping describes the text wrapping style to be used in table views Allowed:`truncate`, `wrap`, `single-line` `timeFormat`requiredstring timeFormat describes the display format for time values according to moment.js date formatting `type`requiredstring Allowed:`table` Or:object `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showAll`requiredboolean `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`simple-table` Or:object `note`requiredstring `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`markdown` Or:object `adaptiveZoomHide`boolean `check`object or object or object One of:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `level`string The state to record if check matches a criteria. Allowed:`UNKNOWN`, `OK`, `INFO`, `CRIT`, `WARN` `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `reportZero`boolean If only zero values reported since time, trigger an alert `staleTime`string String duration for time that a series is considered stale and should not trigger deadman. `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `timeSince`string String duration before deadman triggers. `type`requiredstring Allowed:`deadman` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `thresholds`object[] `type`requiredstring Allowed:`threshold` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `taskID`string The ID of the task associated with this check. `type`requiredstring Allowed:`custom` `updatedAt`string \ `checkID`requiredstring `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`check` Or:object `adaptiveZoomHide`boolean `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `symbolColumns`requiredstring[] `timeFormat`string `type`requiredstring Allowed:`scatter` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `binSize`requirednumber `colors`requiredstring[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`heatmap` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`mosaic` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yDomain`requirednumber[] `yLabelColumnSeparator`string `yLabelColumns`string[] `yPrefix`requiredstring `ySeriesColumns`requiredstring[] `ySuffix`requiredstring Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `lowerColumn`string `mainColumn`string `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`band` `upperColumn`string `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `allowPanAndZoom`requiredboolean If true, map zoom and pan controls are enabled on the dashboard view Default:`true` `center`requiredobject Coordinates of the center of the map `lat`requirednumber \ Latitude of the center of the map `lon`requirednumber \ Longitude of the center of the map `colors`object[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `detectCoordinateFields`requiredboolean If true, search results get automatically regroupped so that lon,lat and value are treated as columns Default:`true` `latLonColumns`object Object type to define lat/lon columns `lat`requiredobject Object type for key and column definitions `lon`requiredobject Object type for key and column definitions `layers`requiredobject[] List of individual layers shown in the map `mapStyle`string Define map type - regular, satellite etc. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `s2Column`string String to define the column `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`geo` `useS2CellID`boolean If true, S2 column is used to calculate lat/lon `zoom`requirednumber \ Zoom level used for initial display of the map 404Cell or dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. PATCH`/api/v2/dashboards/{dashboardID}/cells/{cellID}/view` ### Update the view for a cell #### Parameters ##### Path parameters `dashboardID`requiredstring The ID of the dashboard to update. `cellID`requiredstring The ID of the cell to update. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Content-Type:`application/json` `id`string `links`object `self`string `name`requiredstring `properties`requiredobject or object or object or object or object or object or object or object or object or object or object or object or object or object One of:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `generateXAxisTicks`string[] `generateYAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `timeFormat`string `type`requiredstring Allowed:`line-plus-single-stat` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `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. Example:`{"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}` `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`xy` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`single-stat` Or:object `binCount`requiredinteger `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `fillColumns`requiredstring[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`histogram` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`gauge` Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `fieldOptions`requiredobject[] fieldOptions represent the fields retrieved by the query with customization options `displayName`string The name that a field is renamed to by the user. `internalName`string The calculated name of a field. `visible`boolean Indicates whether this field should be visible on the table. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `tableOptions`requiredobject `fixFirstColumn`boolean fixFirstColumn indicates whether the first column of the table should be locked `sortBy`object Describes a field that can be renamed and made visible or invisible. `verticalTimeAxis`boolean verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically `wrapping`string Wrapping describes the text wrapping style to be used in table views Allowed:`truncate`, `wrap`, `single-line` `timeFormat`requiredstring timeFormat describes the display format for time values according to moment.js date formatting `type`requiredstring Allowed:`table` Or:object `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showAll`requiredboolean `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`simple-table` Or:object `note`requiredstring `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`markdown` Or:object `adaptiveZoomHide`boolean `check`object or object or object One of:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `level`string The state to record if check matches a criteria. Allowed:`UNKNOWN`, `OK`, `INFO`, `CRIT`, `WARN` `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `reportZero`boolean If only zero values reported since time, trigger an alert `staleTime`string String duration for time that a series is considered stale and should not trigger deadman. `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `timeSince`string String duration before deadman triggers. `type`requiredstring Allowed:`deadman` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `thresholds`object[] `type`requiredstring Allowed:`threshold` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `taskID`string The ID of the task associated with this check. `type`requiredstring Allowed:`custom` `updatedAt`string \ `checkID`requiredstring `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`check` Or:object `adaptiveZoomHide`boolean `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `symbolColumns`requiredstring[] `timeFormat`string `type`requiredstring Allowed:`scatter` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `binSize`requirednumber `colors`requiredstring[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`heatmap` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`mosaic` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yDomain`requirednumber[] `yLabelColumnSeparator`string `yLabelColumns`string[] `yPrefix`requiredstring `ySeriesColumns`requiredstring[] `ySuffix`requiredstring Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `lowerColumn`string `mainColumn`string `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`band` `upperColumn`string `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `allowPanAndZoom`requiredboolean If true, map zoom and pan controls are enabled on the dashboard view Default:`true` `center`requiredobject Coordinates of the center of the map `lat`requirednumber \ Latitude of the center of the map `lon`requirednumber \ Longitude of the center of the map `colors`object[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `detectCoordinateFields`requiredboolean If true, search results get automatically regroupped so that lon,lat and value are treated as columns Default:`true` `latLonColumns`object Object type to define lat/lon columns `lat`requiredobject Object type for key and column definitions `lon`requiredobject Object type for key and column definitions `layers`requiredobject[] List of individual layers shown in the map `mapStyle`string Define map type - regular, satellite etc. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `s2Column`string String to define the column `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`geo` `useS2CellID`boolean If true, S2 column is used to calculate lat/lon `zoom`requirednumber \ Zoom level used for initial display of the map Example request[Ask AI about this](#) ```sh curl --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": { "self": "SELF" }, "name": "NAME", "properties": { "adaptiveZoomHide": false, "axes": {}, "colors": [], "decimalPlaces": {}, "generateXAxisTicks": [], "generateYAxisTicks": [], "hoverDimension": "auto", "legendColorizeRows": false, "legendHide": false, "legendOpacity": 0, "legendOrientationThreshold": 0, "note": "NOTE", "position": "overlaid", "prefix": "PREFIX", "queries": [], "shadeBelow": false, "shape": "chronograf-v2", "showNoteWhenEmpty": false, "staticLegend": {}, "suffix": "SUFFIX", "timeFormat": "TIMEFORMAT", "type": "line-plus-single-stat", "xColumn": "XCOLUMN", "xTickStart": 0, "xTickStep": 0, "xTotalTicks": 0, "yColumn": "YCOLUMN", "yTickStart": 0, "yTickStep": 0, "yTotalTicks": 0 } }' ``` #### Responses 200Updated cell view `id`string `links`object `self`string `name`requiredstring `properties`requiredobject or object or object or object or object or object or object or object or object or object or object or object or object or object One of:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `generateXAxisTicks`string[] `generateYAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `timeFormat`string `type`requiredstring Allowed:`line-plus-single-stat` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `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. Example:`{"configcat_deployments-autopromotionblocker":"#663cd0","measurement_birdmigration_europe":"#663cd0","series_id_1":"#edf529","series_id_2":"#edf529"}` `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shadeBelow`boolean `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`xy` `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`single-stat` Or:object `binCount`requiredinteger `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `fillColumns`requiredstring[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `position`requiredstring Allowed:`overlaid`, `stacked` `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`histogram` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `note`requiredstring `prefix`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `suffix`requiredstring `tickPrefix`requiredstring `tickSuffix`requiredstring `type`requiredstring Allowed:`gauge` Or:object `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `decimalPlaces`requiredobject Indicates whether decimal places should be enforced, and how many digits it should show. `digits`integer \ The number of digits after decimal to display `isEnforced`boolean Indicates whether decimal point setting should be enforced `fieldOptions`requiredobject[] fieldOptions represent the fields retrieved by the query with customization options `displayName`string The name that a field is renamed to by the user. `internalName`string The calculated name of a field. `visible`boolean Indicates whether this field should be visible on the table. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `tableOptions`requiredobject `fixFirstColumn`boolean fixFirstColumn indicates whether the first column of the table should be locked `sortBy`object Describes a field that can be renamed and made visible or invisible. `verticalTimeAxis`boolean verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically `wrapping`string Wrapping describes the text wrapping style to be used in table views Allowed:`truncate`, `wrap`, `single-line` `timeFormat`requiredstring timeFormat describes the display format for time values according to moment.js date formatting `type`requiredstring Allowed:`table` Or:object `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showAll`requiredboolean `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`simple-table` Or:object `note`requiredstring `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`markdown` Or:object `adaptiveZoomHide`boolean `check`object or object or object One of:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `level`string The state to record if check matches a criteria. Allowed:`UNKNOWN`, `OK`, `INFO`, `CRIT`, `WARN` `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `reportZero`boolean If only zero values reported since time, trigger an alert `staleTime`string String duration for time that a series is considered stale and should not trigger deadman. `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `timeSince`string String duration before deadman triggers. `type`requiredstring Allowed:`deadman` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `every`string Check repetition interval. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `offset`string Duration to delay after the schedule, before executing check. `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `statusMessageTemplate`string The template used to generate and write a status message. `tags`object[] List of tags to write to each status. `taskID`string The ID of the task associated with this check. `thresholds`object[] `type`requiredstring Allowed:`threshold` `updatedAt`string \ Or:object `createdAt`string \ `description`string An optional description of the check. `id`string `labels`object[] `lastRunError`string `lastRunStatus`string Allowed:`failed`, `success`, `canceled` `latestCompleted`string \ A timestamp ([RFC3339 date/time format](/influxdb/v2/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. `links`object Example:`{"labels":"/api/v2/checks/1/labels","members":"/api/v2/checks/1/members","owners":"/api/v2/checks/1/owners","query":"/api/v2/checks/1/query","self":"/api/v2/checks/1"}` `name`requiredstring `orgID`requiredstring The ID of the organization that owns this check. `ownerID`string The ID of creator used to create this check. `query`requiredobject `status`string `inactive` cancels scheduled runs and prevents manual runs of the task. Allowed:`active`, `inactive` `taskID`string The ID of the task associated with this check. `type`requiredstring Allowed:`custom` `updatedAt`string \ `checkID`requiredstring `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `type`requiredstring Allowed:`check` Or:object `adaptiveZoomHide`boolean `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `symbolColumns`requiredstring[] `timeFormat`string `type`requiredstring Allowed:`scatter` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `adaptiveZoomHide`boolean `binSize`requirednumber `colors`requiredstring[] Colors define color encoding of data into a visualization `generateXAxisTicks`string[] `generateYAxisTicks`string[] `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`heatmap` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yColumn`requiredstring `yDomain`requirednumber[] `yPrefix`requiredstring `ySuffix`requiredstring `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `colors`requiredstring[] Colors define color encoding of data into a visualization `fillColumns`requiredstring[] `generateXAxisTicks`string[] `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `timeFormat`string `type`requiredstring Allowed:`mosaic` `xAxisLabel`requiredstring `xColumn`requiredstring `xDomain`requirednumber[] `xPrefix`requiredstring `xSuffix`requiredstring `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yAxisLabel`requiredstring `yDomain`requirednumber[] `yLabelColumnSeparator`string `yLabelColumns`string[] `yPrefix`requiredstring `ySeriesColumns`requiredstring[] `ySuffix`requiredstring Or:object `adaptiveZoomHide`boolean `axes`requiredobject The viewport for a View’s visualizations `x`requiredobject Axis used in a visualization. `y`requiredobject Axis used in a visualization. `colors`requiredobject[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `generateXAxisTicks`string[] `generateYAxisTicks`string[] `geom`requiredstring Allowed:`line`, `step`, `stacked`, `bar`, `monotoneX`, `stepBefore`, `stepAfter` `hoverDimension`string Allowed:`auto`, `x`, `y`, `xy` `legendColorizeRows`boolean `legendHide`boolean `legendOpacity`number \ `legendOrientationThreshold`integer `lowerColumn`string `mainColumn`string `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `staticLegend`object StaticLegend represents the options specific to the static legend `colorizeRows`boolean `heightRatio`number \ `opacity`number \ `orientationThreshold`integer `show`boolean `valueAxis`string `widthRatio`number \ `timeFormat`string `type`requiredstring Allowed:`band` `upperColumn`string `xColumn`string `xTickStart`number \ `xTickStep`number \ `xTotalTicks`integer `yColumn`string `yTickStart`number \ `yTickStep`number \ `yTotalTicks`integer Or:object `allowPanAndZoom`requiredboolean If true, map zoom and pan controls are enabled on the dashboard view Default:`true` `center`requiredobject Coordinates of the center of the map `lat`requirednumber \ Latitude of the center of the map `lon`requirednumber \ Longitude of the center of the map `colors`object[] Colors define color encoding of data into a visualization `hex`requiredstring The hex number of the color `id`requiredstring The unique ID of the view color. `name`requiredstring The user-facing name of the hex color. `type`requiredstring Type is how the color is used. Allowed:`min`, `max`, `threshold`, `scale`, `text`, `background` `value`requirednumber \ The data value mapped to this color. `detectCoordinateFields`requiredboolean If true, search results get automatically regroupped so that lon,lat and value are treated as columns Default:`true` `latLonColumns`object Object type to define lat/lon columns `lat`requiredobject Object type for key and column definitions `lon`requiredobject Object type for key and column definitions `layers`requiredobject[] List of individual layers shown in the map `mapStyle`string Define map type - regular, satellite etc. `note`requiredstring `queries`requiredobject[] `builderConfig`object `editMode`string Allowed:`builder`, `advanced` `name`string `text`string The text of the Flux query. `s2Column`string String to define the column `shape`requiredstring Allowed:`chronograf-v2` `showNoteWhenEmpty`requiredboolean If true, will display note when empty `type`requiredstring Allowed:`geo` `useS2CellID`boolean If true, S2 column is used to calculate lat/lon `zoom`requirednumber \ Zoom level used for initial display of the map 404Cell or dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. GET`/api/v2/dashboards/{dashboardID}/labels` ### List all labels for a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/labels" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200A list of all labels for a dashboard `labels`object[] `id`string `name`string `orgID`string `properties`object Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key. Example:`{"color":"ffb3b3","description":"this is a description"}` `links`object URI pointers for additional paged results. `next`string \ URI of resource. `prev`string \ URI of resource. `self`requiredstring \ URI of resource. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. POST`/api/v2/dashboards/{dashboardID}/labels` ### Add a label to a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired Label to add Content-Type:`application/json` `labelID`requiredstring A label ID. Specifies the label to attach. Example request[Ask AI about this](#) ```sh curl --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 201The label added to the dashboard `label`object `id`string `name`string `orgID`string `properties`object Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key. Example:`{"color":"ffb3b3","description":"this is a description"}` `links`object URI pointers for additional paged results. `next`string \ URI of resource. `prev`string \ URI of resource. `self`requiredstring \ URI of resource. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. DELETE`/api/v2/dashboards/{dashboardID}/labels/{labelID}` ### Delete a label from a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. `labelID`requiredstring The ID of the label to delete. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/labels/{labelID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Delete has been accepted 404Dashboard not found `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. GET`/api/v2/dashboards/{dashboardID}/members` ### List all dashboard members #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/members" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200A list of users who have member privileges for a dashboard `links`object `self`string \ `users`object[] `id`string The user ID. `links`object Example:`{"self":"/api/v2/users/1"}` `self`string \ `name`requiredstring The user name. `role`string Allowed:`member` Default:`member` `status`string The status of a user. An inactive user can’t read or write resources. Allowed:`active`, `inactive` Default:`active` defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. POST`/api/v2/dashboards/{dashboardID}/members` ### Add a member to a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired User to add as member Content-Type:`application/json` `id`requiredstring The ID of the user to add to the resource. `name`string The name of the user to add to the resource. Example request[Ask AI about this](#) ```sh curl --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 201Added to dashboard members defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. DELETE`/api/v2/dashboards/{dashboardID}/members/{userID}` ### Remove a member from a dashboard #### Parameters ##### Path parameters `userID`requiredstring The ID of the member to remove. `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/members/{userID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Member removed defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. GET`/api/v2/dashboards/{dashboardID}/owners` ### List all dashboard owners #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/owners" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200A list of users who have owner privileges for a dashboard `links`object `self`string \ `users`object[] `id`string The user ID. `links`object Example:`{"self":"/api/v2/users/1"}` `self`string \ `name`requiredstring The user name. `role`string Allowed:`owner` Default:`owner` `status`string The status of a user. An inactive user can’t read or write resources. Allowed:`active`, `inactive` Default:`active` defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. POST`/api/v2/dashboards/{dashboardID}/owners` ### Add an owner to a dashboard #### Parameters ##### Path parameters `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context #### Request bodyrequired User to add as owner Content-Type:`application/json` `id`requiredstring The ID of the user to add to the resource. `name`string The name of the user to add to the resource. Example request[Ask AI about this](#) ```sh curl --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 201Added to dashboard owners defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging. DELETE`/api/v2/dashboards/{dashboardID}/owners/{userID}` ### Remove an owner from a dashboard #### Parameters ##### Path parameters `userID`requiredstring The ID of the owner to remove. `dashboardID`requiredstring The dashboard ID. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request DELETE \ "http://localhost:8086/api/v2/dashboards/{dashboardID}/owners/{userID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Owner removed defaultUnexpected error `code`requiredstring code is the machine-readable error code. Allowed:`internal 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 type` `err`string Stack of errors that occurred during processing of the request. Useful for debugging. `message`string Human-readable message. `op`string Describes the logical code operation when the error occurred. Useful for debugging.