InfluxDB

InfluxDB Dashboards API

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

GitHub OpenAPI

Operations 20

GET /api/v2/dashboards List dashboards #
POST /api/v2/dashboards Create a dashboard #
DELETE /api/v2/dashboards/{dashboardID} Delete a dashboard #
GET /api/v2/dashboards/{dashboardID} Retrieve a dashboard #
PATCH /api/v2/dashboards/{dashboardID} Update a dashboard #
POST /api/v2/dashboards/{dashboardID}/cells Create a dashboard cell #
PUT /api/v2/dashboards/{dashboardID}/cells Replace cells in a dashboard #
DELETE /api/v2/dashboards/{dashboardID}/cells/{cellID} Delete a dashboard cell #
PATCH /api/v2/dashboards/{dashboardID}/cells/{cellID} Update the non-positional information related to a cell #
GET /api/v2/dashboards/{dashboardID}/cells/{cellID}/view Retrieve the view for a cell #
PATCH /api/v2/dashboards/{dashboardID}/cells/{cellID}/view Update the view for a cell #
GET /api/v2/dashboards/{dashboardID}/labels List all labels for a dashboard #
POST /api/v2/dashboards/{dashboardID}/labels Add a label to a dashboard #
DELETE /api/v2/dashboards/{dashboardID}/labels/{labelID} Delete a label from a dashboard #
GET /api/v2/dashboards/{dashboardID}/members List all dashboard members #
POST /api/v2/dashboards/{dashboardID}/members Add a member to a dashboard #
DELETE /api/v2/dashboards/{dashboardID}/members/{userID} Remove a member from a dashboard #
GET /api/v2/dashboards/{dashboardID}/owners List all dashboard owners #
POST /api/v2/dashboards/{dashboardID}/owners Add an owner to a dashboard #
DELETE /api/v2/dashboards/{dashboardID}/owners/{userID} Remove an owner from a dashboard #

Documentation

📖
Documentation
https://docs.influxdata.com/influxdb/cloud/api/v2/
📖
Authentication
https://docs.influxdata.com/influxdb/cloud/api/v2/#tag/Authentication
📖
GettingStarted
https://docs.influxdata.com/influxdb/cloud/api/v2/#tag/Quick-start

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/influxdb/refs/heads/main/openapi/influxdb-dashboards-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/influxdb/refs/heads/main/openapi/influxdb-asyncapi.yml

Other Resources

🔗
Pagination
https://docs.influxdata.com/influxdb/cloud/api/v2/#tag/Pagination
🔗
Headers
https://docs.influxdata.com/influxdb/cloud/api/v2/#tag/Headers
🔗
Source
https://github.com/influxdata/openapi

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/influxdb-dashboards-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

influxdb-dashboards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Complete InfluxDB Cloud Authorizations (API tokens) Authorizations (API tokens) Dashboards API
  description: 'Create and manage authorizations (API tokens).


    An _authorization_ contains a list of `read` and `write`

    permissions for organization resources and provides an API token for authentication.

    An authorization belongs to an organization and only contains permissions for that organization.


    We recommend the following for managing your tokens:


    - Create a generic user to create and manage tokens for writing data.

    - Store your tokens in a secure password vault for future access.


    ### User sessions with authorizations


    Optionally, when creating an authorization, you can scope it to a specific user.

    If the user signs in with username and password, creating a _user session_,

    the session carries the permissions granted by all the user''s authorizations.

    For more information, see [how to assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/).

    To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).


    ### Related endpoints


    - [Signin](#tag/Signin)

    - [Signout](#tag/Signout)


    ### Related guides


    - [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication)

    - [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)

    - [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/)

    '
servers:
- url: ''
security:
- TokenAuthentication: []
tags:
- name: Dashboards
paths:
  /api/v2/dashboards:
    get:
      description: 'Lists [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard).


        #### Related guides


        - [Manage dashboards](https://docs.influxdata.com/influxdb/cloud/visualize-data/dashboards/).

        '
      operationId: GetDashboards
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Descending'
      - description: 'The maximum number of [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) to return.

          Default is `20`.

          The minimum is `-1` and the maximum is `100`.

          '
        in: query
        name: limit
        schema:
          default: 20
          maximum: 100
          minimum: -1
          type: integer
      - description: A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) where the specified user has the `owner` role.
        in: query
        name: owner
        schema:
          type: string
      - description: The column to sort by.
        in: query
        name: sortBy
        schema:
          enum:
          - ID
          - CreatedAt
          - UpdatedAt
          type: string
      - description: 'A list of dashboard IDs.

          Returns only the specified [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard).

          If you specify `id` and `owner`, only `id` is used.

          '
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
      - description: 'An organization ID.

          Only returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) that belong to the specified

          [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).

          '
        in: query
        name: orgID
        schema:
          type: string
      - description: 'An organization name.

          Only returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) that belong to the specified

          [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).

          '
        in: query
        name: org
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboards'
          description: Success. The response body contains dashboards.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List dashboards
      tags:
      - Dashboards
    post:
      operationId: PostDashboards
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDashboardRequest'
        description: Dashboard to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Dashboard'
                - $ref: '#/components/schemas/DashboardWithViewProperties'
          description: Success. The dashboard is created.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Create a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}:
    delete:
      operationId: DeleteDashboardsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Delete has been accepted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Delete a dashboard
      tags:
      - Dashboards
    get:
      operationId: GetDashboardsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: If `properties`, includes the cell view properties in the response.
        in: query
        name: include
        required: false
        schema:
          enum:
          - properties
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Dashboard'
                - $ref: '#/components/schemas/DashboardWithViewProperties'
          description: Retrieve a single dashboard
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Retrieve a dashboard
      tags:
      - Dashboards
    patch:
      operationId: PatchDashboardsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cells:
                  $ref: '#/components/schemas/CellWithViewProperties'
                  description: optional, when provided will replace all existing cells with the cells provided
                description:
                  description: optional, when provided will replace the description
                  type: string
                name:
                  description: optional, when provided will replace the name
                  type: string
              title: PatchDashboardRequest
              type: object
        description: Patching of a dashboard
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: Updated dashboard
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Update a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/cells:
    post:
      operationId: PostDashboardsIDCells
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCell'
        description: Cell that will be added
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cell'
          description: Cell successfully added
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Create a dashboard cell
      tags:
      - Dashboards
    put:
      description: Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
      operationId: PutDashboardsIDCells
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cells'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: Replaced dashboard cells
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Replace cells in a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/cells/{cellID}:
    delete:
      operationId: DeleteDashboardsIDCellsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to delete.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: The ID of the cell to delete.
        in: path
        name: cellID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Cell successfully deleted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Cell or dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Delete a dashboard cell
      tags:
      - Dashboards
    patch:
      description: Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
      operationId: PatchDashboardsIDCellsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: The ID of the cell to update.
        in: path
        name: cellID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cell'
          description: Updated dashboard cell
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Cell or dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Update the non-positional information related to a cell
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/cells/{cellID}/view:
    get:
      operationId: GetDashboardsIDCellsIDView
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: The cell ID.
        in: path
        name: cellID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/View'
          description: A dashboard cells view
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Cell or dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Retrieve the view for a cell
      tags:
      - Dashboards
    patch:
      operationId: PatchDashboardsIDCellsIDView
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the dashboard to update.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: The ID of the cell to update.
        in: path
        name: cellID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/View'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/View'
          description: Updated cell view
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Cell or dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Update the view for a cell
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/labels:
    get:
      operationId: GetDashboardsIDLabels
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelsResponse'
          description: A list of all labels for a dashboard
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List all labels for a dashboard
      tags:
      - Dashboards
    post:
      operationId: PostDashboardsIDLabels
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelMapping'
        description: Label to add
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelResponse'
          description: The label added to the dashboard
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Add a label to a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/labels/{labelID}:
    delete:
      operationId: DeleteDashboardsIDLabelsID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      - description: The ID of the label to delete.
        in: path
        name: labelID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Delete has been accepted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Delete a label from a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/members:
    get:
      operationId: GetDashboardsIDMembers
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceMembers'
          description: A list of users who have member privileges for a dashboard
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List all dashboard members
      tags:
      - Dashboards
    post:
      operationId: PostDashboardsIDMembers
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourceMemberRequestBody'
        description: User to add as member
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceMember'
          description: Added to dashboard members
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Add a member to a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/members/{userID}:
    delete:
      operationId: DeleteDashboardsIDMembersID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the member to remove.
        in: path
        name: userID
        required: true
        schema:
          type: string
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Member removed
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Remove a member from a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/owners:
    get:
      operationId: GetDashboardsIDOwners
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOwners'
          description: A list of users who have owner privileges for a dashboard
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: List all dashboard owners
      tags:
      - Dashboards
    post:
      operationId: PostDashboardsIDOwners
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourceMemberRequestBody'
        description: User to add as owner
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOwner'
          description: Added to dashboard owners
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Add an owner to a dashboard
      tags:
      - Dashboards
  /api/v2/dashboards/{dashboardID}/owners/{userID}:
    delete:
      operationId: DeleteDashboardsIDOwnersID
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - description: The ID of the owner to remove.
        in: path
        name: userID
        required: true
        schema:
          type: string
      - description: The dashboard ID.
        in: path
        name: dashboardID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Owner removed
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      summary: Remove an owner from a dashboard
      tags:
      - Dashboards
components:
  parameters:
    TraceSpan:
      description: OpenTracing span context
      example:
        baggage:
          key: value
        span_id: '1'
        trace_id: '1'
      in: header
      name: Zap-Trace-Span
      required: false
      schema:
        type: string
    Descending:
      in: query
      name: descending
      required: false
      schema:
        default: false
        type: boolean
    Offset:
      description: 'The offset for pagination.

        The number of records to skip.


        For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).

        '
      in: query
      name: offset
      required: false
      schema:
        minimum: 0
        type: integer
  schemas:
    TableViewProperties:
      properties:
        colors:
          description: Colors define color encoding of data into a visualization
          items:
            $ref: '#/components/schemas/DashboardColor'
          type: array
        decimalPlaces:
          $ref: '#/components/schemas/DecimalPlaces'
        fieldOptions:
          description: fieldOptions represent the fields retrieved by the query with customization options
          items:
            $ref: '#/components/schemas/RenamableField'
          type: array
        note:
          type: string
        queries:
          items:
            $ref: '#/components/schemas/DashboardQuery'
          type: array
        shape:
          enum:
          - chronograf-v2
          type: string
        showNoteWhenEmpty:
          description: If true, will display note when empty
          type: boolean
        tableOptions:
          properties:
            fixFirstColumn:
              description: fixFirstColumn indicates whether the first column of the table should be locked
              type: boolean
            sortBy:
              $ref: '#/components/schemas/RenamableField'
            verticalTimeAxis:
              description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically
              type: boolean
            wrapping:
              description: Wrapping describes the text wrapping style to be used in table views
              enum:
              - truncate
              - wrap
              - single-line
              type: string
          type: object
        timeFormat:
          description: timeFormat describes the display format for time values according to moment.js date formatting
          type: string
        type:
          enum:
          - table
          type: string
      required:
      - type
      - queries
      - colors
      - shape
      - note
      - showNoteWhenEmpty
      - tableOptions
      - fieldOptions
      - timeFormat
      - decimalPlaces
      type: object
    XYViewProperties:
      properties:
        adaptiveZoomHide:
          type: boolean
        axes:
          $ref: '#/components/schemas/Axes'
        colorMapping:
          $ref: '#/components/schemas/ColorMapping'
          description: An object that contains information about the color mapping
        colors:
          description: Colors define color encoding of data into a visualization
          items:
            $ref: '#/components/schemas/DashboardColor'
          type: array
        generateXAxisTicks:
          items:
            type: string
          type: array
        generateYAxisTicks:
          items:
            type: string
          type: array
        geom:
          $ref: '#/components/schemas/XYGeom'
        hoverDimension:
          enum:
          - auto
          - x
          - y
          - xy
          type: string
        legendColorizeRows:
          type: boolean
        legendHide:
          type: boolean
        legendOpacity:
          format: float
          type: number
        legendOrientationThreshold:
          type: integer
        note:
          type: string
        position:
          enum:
          - overlaid
          - stacked
          type: string
        queries:
          items:
            $ref: '#/components/schemas/DashboardQuery'
          type: array
        shadeBelow:
          type: boolean
        shape:
          enum:
          - chronograf-v2
          type: string
        showNoteWhenEmpty:
          description: If true, will display note when empty
          type: boolean
        staticLegend:
          $ref: '#/components/schemas/StaticLegend'
        timeFormat:
          type: string
        type:
          enum:
          - xy
          type: string
        xColumn:
          type: string
        xTickStart:
          format: float
          type: number
        xTickStep:
          format: float
          type: number
        xTotalTicks:
          type: integer
        yColumn:
          type: string
        yTickStart:
          format: float
          type: number
        yTickStep:
          format: float
          type: number
        yTotalTicks:
          type: integer
      required:
      - type
      - geom
      - queries
      - shape
      - axes
      - colors
      - note
      - showNoteWhenEmpty
      - position
      type: object
    ResourceMembers:
      properties:
        links:
          properties:
            self:
              format: uri
              type: string
          type: object
        users:
          items:
            $ref: '#/components/schemas/ResourceMember'
          type: array
      type: object
    TaskStatusType:
      description: '`inactive` cancels scheduled runs and prevents manual runs of the task.

        '
      enum:
      - active
      - inactive
      type: string
    RangeThreshold:
      allOf:
      - $ref: '#/components/schemas/ThresholdBase'
      - properties:
          max:
            format: float
            type: number
          min:
            format: float
            type: number
          type:
            enum:
            - range
            type: string
          within:
            type: boolean
        required:
        - type
        - min
        - max
        - within
        type: object
    CustomCheck:
      allOf:
      - $ref: '#/components/schemas/CheckBase'
      - properties:
          type:
            enum:
            - custom
            type: string
        required:
        - type
        type: object
    CheckBase:
      properties:
        createdAt:
          format: date-time
          readOnly: true
          type: string
        description:
          description: An optional description of the check.
          type: string
        id:
          readOnly: true
          type: string
        labels:
          $ref: '#/components/schemas/Labels'
        lastRunError:
          readOnly: true
          type: string
        lastRunStatus:
          enum:
          - failed
          - success
          - canceled
          readOnly: true
          type: string
        latestCompleted:
          description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
          format: date-time
          readOnly: true
          type: string
        links:
          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
          properties:
            labels:
              $ref: '#/components/schemas/Link'
              description: The URL to retrieve labels for this check.
            members:
              $ref: '#/components/schemas/Link'
              description: The URL to retrieve members for this check.
            owners:
              $ref: '#/components/schemas/Link'
              description: The URL to retrieve owners for this check.
            query:
              $ref: '#/components/schemas/Link'
              description: The URL to retrieve the Flux script for this check.
            self:
              $ref: '#/components/schemas/Link'
              description: The URL for this check.
          readOnly: true
          type: object
        name:
          type: string
        orgID:
          description: The ID of the organization that owns this check.
          type: string
        ownerID:
          description: The ID of creator used to create this check.
          readOnly: true
          type: string
        query:
          $ref: '#/components/schemas/DashboardQuery'
        status:
          

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/influxdb/refs/heads/main/openapi/influxdb-dashboards-api-openapi.yml