InfluxDB

opencollection: 1.0.0
info:
  name: Complete InfluxDB Cloud API
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Routes
    type: folder
  items:
  - info:
      name: List all top level routes
      type: http
    http:
      method: GET
      url: /api/v2
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
    docs: 'Retrieves all the top level routes for the InfluxDB API.


      #### Limitations


      - Only returns top level routes--for example, the response contains

      `"tasks":"/api/v2/tasks"`, and doesn''t contain resource-specific routes

      for tasks (`/api/v2/tasks/TASK_ID/...`).

      '
- info:
    name: Authorizations (API tokens)
    type: folder
  items:
  - info:
      name: List authorizations
      type: http
    http:
      method: GET
      url: /api/v2/authorizations
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: userID
        value: ''
        type: query
        description: 'A user ID.

          Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).

          '
      - name: user
        value: ''
        type: query
        description: 'A user name.

          Only returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).

          '
      - name: orgID
        value: ''
        type: query
        description: An organization ID. Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).
      - name: org
        value: ''
        type: query
        description: 'An organization name.

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

          '
      - name: token
        value: ''
        type: query
        description: "An API [token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token) value.\nSpecifies\
          \ an authorization by its `token` property value\nand returns the authorization.\n\n#### InfluxDB OSS\n\n- Doesn't\
          \ support this parameter. InfluxDB OSS ignores the `token=` parameter,\n  applies other parameters, and then returns\
          \ the result.\n\n#### Limitations\n\n- The parameter is non-repeatable. If you specify more than one,\n  only the\
          \ first one is used. If a resource with the specified\n  property value doesn't exist, then the response body contains\
          \ an empty list.\n"
    docs: "Lists authorizations.\n\nTo limit which authorizations are returned, pass query parameters in your request.\nIf\
      \ no query parameters are passed, InfluxDB returns all authorizations.\n\n#### InfluxDB Cloud\n\n- InfluxDB Cloud doesn't\
      \ expose [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n  values in `GET /api/v2/authorizations`\
      \ responses;\n  returns `token: redacted` for all authorizations.\n\n#### Required permissions\n\nTo retrieve an authorization,\
      \ the request must use an "
  - info:
      name: Create an authorization
      type: http
    http:
      method: POST
      url: /api/v2/authorizations
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      body:
        type: json
        data: '{}'
    docs: 'Creates an authorization and returns the authorization with the

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


      Use this endpoint to create an authorization, which generates an API token

      with permissions to `read` or `write` to a specific resource or `type` of resource.

      The API token is the authorization''s `token` property value.


      To follow best practices for secure API token generation and retrieval,

      InfluxDB enforces access restrictions on API toke'
  - info:
      name: Retrieve an authorization
      type: http
    http:
      method: GET
      url: /api/v2/authorizations/:authID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: authID
        value: ''
        type: path
        description: An authorization ID. Specifies the authorization to retrieve.
    docs: "Retrieves an authorization.\n\nUse this endpoint to retrieve information about an API token, including\nthe token's\
      \ permissions and the user that the token is scoped to.\n\n#### InfluxDB OSS\n\n- InfluxDB OSS returns\n  [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\
      \ values in authorizations.\n- If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_,\n\
      \  InfluxDB OSS returns authorizations for all organization"
  - info:
      name: Update an API token to be active or inactive
      type: http
    http:
      method: PATCH
      url: /api/v2/authorizations/:authID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: authID
        value: ''
        type: path
        description: An authorization ID. Specifies the authorization to update.
      body:
        type: json
        data: '{}'
    docs: 'Updates an authorization.


      Use this endpoint to set an API token''s status to be _active_ or _inactive_.

      InfluxDB rejects requests that use inactive API tokens.

      '
  - info:
      name: Delete an authorization
      type: http
    http:
      method: DELETE
      url: /api/v2/authorizations/:authID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: authID
        value: ''
        type: path
        description: An authorization ID. Specifies the authorization to delete.
    docs: 'Deletes an authorization.


      Use the endpoint to delete an API token.


      If you want to disable an API token instead of delete it,

      [update the authorization''s status to `inactive`](#operation/PatchAuthorizationsID).

      '
- info:
    name: Buckets
    type: folder
  items:
  - info:
      name: List buckets
      type: http
    http:
      method: GET
      url: /api/v2/buckets
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: offset
        value: ''
        type: query
        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).

          '
      - name: limit
        value: ''
        type: query
        description: 'Limits the number of records returned. Default is `20`.

          '
      - name: after
        value: ''
        type: query
        description: 'A resource ID to seek from.

          Returns records created after the specified record;

          results don''t include the specified record.


          Use `after` instead of the `offset` parameter.

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

          '
      - name: org
        value: ''
        type: query
        description: 'An organization name.


          #### InfluxDB Cloud


          - Doesn''t use the `org` parameter or `orgID` parameter.

          - Lists buckets for the organization associated with the authorization (API token).


          #### InfluxDB OSS


          - Lists buckets for the specified organization.

          '
      - name: orgID
        value: ''
        type: query
        description: 'An organization ID.


          #### InfluxDB Cloud


          - Doesn''t use the `org` parameter or `orgID` parameter.

          - Lists buckets for the organization associated with the authorization (API token).


          #### InfluxDB OSS


          - Requires either the `org` parameter or `orgID` parameter.

          - Lists buckets for the specified organization.

          '
      - name: name
        value: ''
        type: query
        description: 'A bucket name.

          Only returns buckets with the specified name.

          '
      - name: id
        value: ''
        type: query
        description: 'A bucket ID.

          Only returns the bucket with the specified ID.

          '
    docs: 'Lists [buckets](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#bucket).


      InfluxDB retrieves buckets owned by the

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

      associated with the authorization

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

      To limit which buckets are returned, pass query parameters in your request.

      If no query parameters are passed, InfluxDB returns all buckets up to the

      default `l'
  - info:
      name: Create a bucket
      type: http
    http:
      method: POST
      url: /api/v2/buckets
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      body:
        type: json
        data: '{}'
    docs: 'Creates a [bucket](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#bucket)

      and returns the bucket resource.

      The default data

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

      is 30 days.


      #### InfluxDB OSS


      - A single InfluxDB OSS instance supports active writes or queries for

      approximately 20 buckets across all organizations at a given time.

      Reading or writing to more than 20 buckets at a time can adversely affect

      performance.


      ##'
  - info:
      name: Retrieve a bucket
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to retrieve.

          '
    docs: 'Retrieves a bucket.


      Use this endpoint to retrieve information for a specific bucket.

      '
  - info:
      name: Update a bucket
      type: http
    http:
      method: PATCH
      url: /api/v2/buckets/:bucketID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: The bucket ID.
      body:
        type: json
        data: '{}'
    docs: 'Updates a bucket.


      Use this endpoint to update properties

      (`name`, `description`, and `retentionRules`) of a bucket.


      #### InfluxDB Cloud


      - Requires the `retentionRules` property in the request body. If you don''t

      provide `retentionRules`, InfluxDB responds with an HTTP `403` status code.


      #### InfluxDB OSS


      - Doesn''t require `retentionRules`.


      #### Related Guides


      - [Update a bucket](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/update-bucket/)

      '
  - info:
      name: Delete a bucket
      type: http
    http:
      method: DELETE
      url: /api/v2/buckets/:bucketID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'Bucket ID.

          The ID of the bucket to delete.

          '
    docs: "Deletes a bucket and all associated records.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a delete\
      \ request:\n\n  1. Validates the request and queues the delete.\n  2. Returns an HTTP `204` status code if queued; _error_\
      \ otherwise.\n  3. Handles the delete asynchronously.\n\n#### InfluxDB OSS\n\n- Validates the request, handles the delete\
      \ synchronously,\nand then responds with success or failure.\n\n#### Limitations\n\n- Only one bucket can be deleted\
      \ per request.\n\n#### Related Guides\n\n- [Delete a"
  - info:
      name: List all labels for a bucket
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID/labels
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to retrieve labels for.

          '
    docs: 'Lists all labels for a bucket.


      Labels are objects that contain `labelID`, `name`, `description`, and `color`

      key-value pairs. They may be used for grouping and filtering InfluxDB

      resources.

      Labels are also capable of grouping across different resources--for example,

      you can apply a label named `air_sensor` to a bucket and a task to quickly

      organize resources.


      #### Related guides


      - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels.

      - [Manage labels in '
  - info:
      name: Add a label to a bucket
      type: http
    http:
      method: POST
      url: /api/v2/buckets/:bucketID/labels
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'Bucket ID.

          The ID of the bucket to label.

          '
      body:
        type: json
        data: '{}'
    docs: "Adds a label to a bucket and returns the new label information.\n\nLabels are objects that contain `labelID`, `name`,\
      \ `description`, and `color`\nkey-value pairs. They may be used for grouping and filtering across one or\nmore kinds\
      \ of **resources**--for example, you can apply a label named\n`air_sensor` to a bucket and a task to quickly organize\
      \ resources.\n\n#### Limitations\n\n- Before adding a label to a bucket, you must create the label if you\n  haven't\
      \ already. To create a label with the InfluxDB A"
  - info:
      name: Delete a label from a bucket
      type: http
    http:
      method: DELETE
      url: /api/v2/buckets/:bucketID/labels/:labelID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: The bucket ID.
      - name: labelID
        value: ''
        type: path
        description: The ID of the label to delete.
    docs: Delete a label from a bucket
  - info:
      name: List all users with member privileges for a bucket
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID/members
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to retrieve users for.

          '
    docs: 'Lists all users for a bucket.


      InfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have

      permission to access InfluxDB.


      [Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users in

      an organization with access to the specified resource.


      Use this endpoint to retrieve all users with access to a bucket.


      #### Related guides


      - [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)

      - [Manage members](https://docs.influxdat'
  - info:
      name: Add a member to a bucket
      type: http
    http:
      method: POST
      url: /api/v2/buckets/:bucketID/members
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to retrieve users for.

          '
      body:
        type: json
        data: '{}'
    docs: 'Add a user to a bucket and return the new user information.


      InfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have

      permission to access InfluxDB.


      [Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users in

      an organization.


      Use this endpoint to give a user member privileges to a bucket.


      #### Related guides


      - [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)

      - [Manage members](https://docs.influxdata.com/inf'
  - info:
      name: Remove a member from a bucket
      type: http
    http:
      method: DELETE
      url: /api/v2/buckets/:bucketID/members/:userID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: userID
        value: ''
        type: path
        description: 'The ID of the user to remove.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to remove a user from.

          '
    docs: 'Removes a member from a bucket.


      Use this endpoint to remove a user''s member privileges from a bucket. This

      removes the user''s `read` and `write` permissions for the bucket.


      #### Related guides


      - [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)

      - [Manage members](https://docs.influxdata.com/influxdb/cloud/organizations/members/)

      '
  - info:
      name: List all owners of a bucket
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID/owners
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to retrieve owners for.

          '
    docs: "Lists all [owners](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner)\nof a bucket.\n\nBucket\
      \ owners have permission to delete buckets and remove user and member\npermissions from the bucket.\n\n#### InfluxDB\
      \ Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens))\
      \ to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n\
      - Owner permissions are used in the context of the Inf"
  - info:
      name: Add an owner to a bucket
      type: http
    http:
      method: POST
      url: /api/v2/buckets/:bucketID/owners
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to add an owner for.

          '
      body:
        type: json
        data: '{}'
    docs: "Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner)\n\
      with role and user detail.\n\nUse this endpoint to create a _resource owner_ for the bucket.\nBucket owners have permission\
      \ to delete buckets and remove user and member\npermissions from the bucket.\n\n#### InfluxDB Cloud\n\n- Doesn't use\
      \ `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\
      \n#### Limitations\n\n- Owne"
  - info:
      name: Remove an owner from a bucket
      type: http
    http:
      method: DELETE
      url: /api/v2/buckets/:bucketID/owners/:userID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: userID
        value: ''
        type: path
        description: 'The ID of the owner to remove.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'The ID of the bucket to remove an owner from.

          '
    docs: "Removes an owner from a bucket.\n\nUse this endpoint to remove a user's `owner` role for a bucket.\n\n#### InfluxDB\
      \ Cloud\n\n- Doesn't use `owner` and `member` roles.\n  Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens))\
      \ to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n\
      - Owner permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\
      \n*`INFLUX_ORG_ID`* is the ID of the organiz"
- info:
    name: Bucket Schemas
    type: folder
  items:
  - info:
      name: List measurement schemas of a bucket
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID/schema/measurements
      params:
      - name: org
        value: ''
        type: query
        description: 'An organization name.

          Specifies the organization that owns the schema.

          '
      - name: orgID
        value: ''
        type: query
        description: 'An organization ID.

          Specifies the organization that owns the schema.

          '
      - name: name
        value: ''
        type: query
        description: 'A measurement name.

          Only returns measurement schemas with the specified name.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'A bucket ID.

          Lists measurement schemas for the specified bucket.

          '
    docs: 'Lists _explicit_

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

      (`"schemaType": "explicit"`) for a bucket.


      _Explicit_ schemas are used to enforce column names, tags, fields, and data

      types for your data.


      By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`)

      that conforms to your data.


      #### Related guides


      - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/)

      '
  - info:
      name: Create a measurement schema for a bucket
      type: http
    http:
      method: POST
      url: /api/v2/buckets/:bucketID/schema/measurements
      params:
      - name: org
        value: ''
        type: query
        description: 'An organization name.

          Specifies the organization that owns the schema.

          '
      - name: orgID
        value: ''
        type: query
        description: 'An organization ID.

          Specifies the organization that owns the schema.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'A bucket ID.

          Adds a schema for the specified bucket.

          '
      body:
        type: json
        data: '{}'
    docs: 'Creates an _explict_ measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema)

      for a bucket.


      _Explicit_ schemas are used to enforce column names, tags, fields, and data

      types for your data.


      By default, buckets have an _implicit_ schema-type (`"schemaType": "implicit"`)

      that conforms to your data.


      Use this endpoint to create schemas that prevent non-conforming write requests.


      #### Limitations


      - Buckets must be created with the "explict" `schemaType` in order'
  - info:
      name: Retrieve a measurement schema
      type: http
    http:
      method: GET
      url: /api/v2/buckets/:bucketID/schema/measurements/:measurementID
      params:
      - name: org
        value: ''
        type: query
        description: 'Organization name.

          Specifies the organization that owns the schema.

          '
      - name: orgID
        value: ''
        type: query
        description: 'Organization ID.

          Specifies the organization that owns the schema.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'A bucket ID.

          Retrieves schemas for the specified bucket.

          '
      - name: measurementID
        value: ''
        type: path
        description: 'The measurement schema ID.

          Specifies the measurement schema to retrieve.

          '
    docs: 'Retrieves an explicit measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema).

      '
  - info:
      name: Update a measurement schema
      type: http
    http:
      method: PATCH
      url: /api/v2/buckets/:bucketID/schema/measurements/:measurementID
      params:
      - name: org
        value: ''
        type: query
        description: 'An organization name.

          Specifies the organization that owns the schema.

          '
      - name: orgID
        value: ''
        type: query
        description: 'An organization ID.

          Specifies the organization that owns the schema.

          '
      - name: bucketID
        value: ''
        type: path
        description: 'A bucket ID.

          Specifies the bucket to retrieve schemas for.

          '
      - name: measurementID
        value: ''
        type: path
        description: 'A measurement schema ID.

          Retrieves the specified measurement schema.

          '
      body:
        type: json
        data: '{}'
    docs: 'Updates a measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema).


      Use this endpoint to update the fields (`name`, `type`, and `dataType`) of a

      measurement schema.


      #### Limitations


      - You can''t update the `name` of a measurement.


      #### Related guides


      - [Manage bucket schemas](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/bucket-schema/).

      - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwante'
- info:
    name: Checks
    type: folder
  items:
  - info:
      name: List all checks
      type: http
    http:
      method: GET
      url: /api/v2/checks
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: offset
        value: ''
        type: query
        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).

          '
      - name: limit
        value: ''
        type: query
        description: 'Limits the number of records returned. Default is `20`.

          '
      - name: orgID
        value: ''
        type: query
        description: Only show checks that belong to a specific organization ID.
    docs: List all checks
  - info:
      name: Add new check
      type: http
    http:
      method: POST
      url: /api/v2/checks
      body:
        type: json
        data: '{}'
    docs: Add new check
  - info:
      name: Retrieve a check
      type: http
    http:
      method: GET
      url: /api/v2/checks/:checkID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
    docs: Retrieve a check
  - info:
      name: Update a check
      type: http
    http:
      method: PUT
      url: /api/v2/checks/:checkID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
      body:
        type: json
        data: '{}'
    docs: Update a check
  - info:
      name: Update a check
      type: http
    http:
      method: PATCH
      url: /api/v2/checks/:checkID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
      body:
        type: json
        data: '{}'
    docs: Update a check
  - info:
      name: Delete a check
      type: http
    http:
      method: DELETE
      url: /api/v2/checks/:checkID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
    docs: Delete a check
  - info:
      name: List all labels for a check
      type: http
    http:
      method: GET
      url: /api/v2/checks/:checkID/labels
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
    docs: List all labels for a check
  - info:
      name: Add a label to a check
      type: http
    http:
      method: POST
      url: /api/v2/checks/:checkID/labels
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
      body:
        type: json
        data: '{}'
    docs: Add a label to a check
  - info:
      name: Delete label from a check
      type: http
    http:
      method: DELETE
      url: /api/v2/checks/:checkID/labels/:labelID
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
      - name: labelID
        value: ''
        type: path
        description: The ID of the label to delete.
    docs: Delete label from a check
  - info:
      name: Retrieve a check query
      type: http
    http:
      method: GET
      url: /api/v2/checks/:checkID/query
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: checkID
        value: ''
        type: path
        description: The check ID.
    docs: Retrieve a check query
- info:
    name: Dashboards
    type: folder
  items:
  - info:
      name: List dashboards
      type: http
    http:
      method: GET
      url: /api/v2/dashboards
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      params:
      - name: offset
        value: ''
        type: query
        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).

          '
      - name: descending
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
        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`.

          '
      - name: owner
        value: ''
        type: query
        description: A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard)
          where the specified user has the `owner` role.
      - name: sortBy
        value: ''
        type: query
        description: The column to sort by.
      - name: id
        value: ''
        type: query
        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.

          '
      - name: orgID
        value: ''
        type: query
        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).

          '
      - name: org
        value: ''
        type: query
        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).

          '
    docs: 'Lists [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard).


      #### Related guides


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

      '
  - info:
      name: Create a dashboard
      type: http
    http:
      method: POST
      url: /api/v2/dashboards
      headers:
      - name: Zap-Trace-Span
        value: '[object Object]'
      body:
        type: json
        data: '{}'
    docs: Create a dashbo

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