diff --git a/api-docs/influxdb/cloud/v2/ref.yml b/api-docs/influxdb/cloud/v2/ref.yml
index 925601e9c..0458a253d 100644
--- a/api-docs/influxdb/cloud/v2/ref.yml
+++ b/api-docs/influxdb/cloud/v2/ref.yml
@@ -99,7 +99,6 @@ tags:
x-traitTag: true
- name: Config
- name: Dashboards
- - name: Data I/O endpoints
- description: |
The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/#database)
and [retention policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).
@@ -208,7 +207,7 @@ tags:
- name: Ping
- description: |
Retrieve data, analyze queries, and get query suggestions.
- name: Query
+ name: Query data
- description: |
See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets, and querying data.
@@ -326,7 +325,7 @@ tags:
- name: Views
- description: |
Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket).
- name: Write
+ name: Write data
paths:
/api/v2:
get:
@@ -4008,7 +4007,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Delete data
tags:
- - Data I/O endpoints
- Delete
x-codeSamples:
- label: cURL
@@ -6186,8 +6184,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Query data
tags:
- - Data I/O endpoints
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -6332,7 +6329,7 @@ paths:
type: string
summary: Analyze a Flux query
tags:
- - Query
+ - Query data
x-codeSamples:
- label: 'cURL: Analyze a Flux query'
lang: Shell
@@ -6777,7 +6774,7 @@ paths:
description: Internal server error.
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- - Query
+ - Query data
x-codeSamples:
- label: 'cURL: Analyze and generate AST for the query'
lang: Shell
@@ -7441,7 +7438,7 @@ paths:
description: Internal server error.
summary: List Flux query suggestions
tags:
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -7513,7 +7510,7 @@ paths:
The value passed for _`name`_ may have been misspelled.
summary: Retrieve a query suggestion for a branching suggestion
tags:
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -7639,7 +7636,6 @@ paths:
description: Unexpected error.
summary: List scripts
tags:
- - Data I/O endpoints
- Invokable Scripts
x-codeSamples:
- label: 'cURL: retrieves the first 100 scripts.'
@@ -7835,7 +7831,6 @@ paths:
description: Internal server error.
summary: Retrieve a script
tags:
- - Data I/O endpoints
- Invokable Scripts
patch:
description: |
@@ -8048,7 +8043,6 @@ paths:
description: Unexpected error.
summary: Invoke a script
tags:
- - Data I/O endpoints
- Invokable Scripts
x-codeSamples:
- label: cURL
@@ -8935,7 +8929,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: List all tasks
tags:
- - Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: all tasks, basic output'
@@ -9054,7 +9047,6 @@ paths:
description: Unexpected error
summary: Create a task
tags:
- - Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: create a Flux script task'
@@ -9161,7 +9153,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Retrieve a task
tags:
- - Data I/O endpoints
- Tasks
patch:
description: |
@@ -9803,7 +9794,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Start a task run, overriding the schedule
tags:
- - Data I/O endpoints
- Tasks
/api/v2/tasks/{taskID}/runs/{runID}:
delete:
@@ -11832,8 +11822,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Write data
tags:
- - Data I/O endpoints
- - Write
+ - Write data
/legacy/authorizations:
get:
operationId: GetLegacyAuthorizations
@@ -19069,6 +19058,36 @@ components:
in: header
name: Authorization
type: apiKey
+ QuerystringAuthentication:
+ description: |
+ Use the query string authentication scheme with InfluxDB v1-compatible API operations.
+ Pass your InfluxDB Cloud email address and API token as query parameters using `u` for username and `p` for password (API token).
+
+ ### Syntax
+
+ `?u=EMAIL_ADDRESS&p=INFLUX_API_TOKEN`
+
+ ### Example
+
+ ```sh
+ curl --get "INFLUX_URL/query" \
+ --data-urlencode "u=EMAIL_ADDRESS" \
+ --data-urlencode "p=INFLUX_API_TOKEN" \
+ --data-urlencode "q=SHOW DATABASES"
+ ```
+
+ Replace the following:
+
+ - *`INFLUX_URL`*: your InfluxDB Cloud URL
+ - *`EMAIL_ADDRESS`*: your InfluxDB Cloud email address
+ - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token)
+
+ > [!Warning]
+ > Query string authentication exposes your credentials in the URL and server logs.
+ > Use [Token authentication](#section/Authentication/TokenAuthentication) for production environments.
+ in: query
+ name: u
+ type: apiKey
x-tagGroups:
- name: Using the InfluxDB HTTP API
tags:
@@ -19099,7 +19118,7 @@ x-tagGroups:
- NotificationRules
- Organizations
- Ping
- - Query
+ - Query data
- Resources
- Routes
- Rules
@@ -19115,4 +19134,4 @@ x-tagGroups:
- Users
- Variables
- Views
- - Write
+ - Write data
diff --git a/api-docs/influxdb/v2/v2/ref.yml b/api-docs/influxdb/v2/v2/ref.yml
index 1c8347ac3..2d285d440 100644
--- a/api-docs/influxdb/v2/v2/ref.yml
+++ b/api-docs/influxdb/v2/v2/ref.yml
@@ -100,7 +100,6 @@ tags:
- [Manage v1-compatible users and permissions](#tag/Authorizations-(v1-compatible))
- name: Config
- name: Dashboards
- - name: Data I/O endpoints
- description: |
The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/#database)
and [retention policies](/influxdb/v2/reference/glossary/#retention-policy-rp).
@@ -200,7 +199,7 @@ tags:
- name: Ping
- description: |
Retrieve data, analyze queries, and get query suggestions.
- name: Query
+ name: Query data
- name: Query data (v1-compatible)
- description: |
See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)
@@ -321,7 +320,7 @@ tags:
- name: Views
- description: |
Write time series data to [buckets](/influxdb/v2/reference/glossary/#bucket).
- name: Write
+ name: Write data
- name: Write data (v1-compatible)
paths:
/api/v2:
@@ -4490,7 +4489,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Delete data
tags:
- - Data I/O endpoints
- Delete
x-codeSamples:
- label: cURL
@@ -6690,8 +6688,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Query data
tags:
- - Data I/O endpoints
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -6836,7 +6833,7 @@ paths:
type: string
summary: Analyze a Flux query
tags:
- - Query
+ - Query data
x-codeSamples:
- label: 'cURL: Analyze a Flux query'
lang: Shell
@@ -7281,7 +7278,7 @@ paths:
description: Internal server error.
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- - Query
+ - Query data
x-codeSamples:
- label: 'cURL: Analyze and generate AST for the query'
lang: Shell
@@ -7945,7 +7942,7 @@ paths:
description: Internal server error.
summary: List Flux query suggestions
tags:
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -8017,7 +8014,7 @@ paths:
The value passed for _`name`_ may have been misspelled.
summary: Retrieve a query suggestion for a branching suggestion
tags:
- - Query
+ - Query data
x-codeSamples:
- label: cURL
lang: Shell
@@ -9930,7 +9927,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: List tasks
tags:
- - Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: all tasks, basic output'
@@ -10001,7 +9997,6 @@ paths:
description: Unexpected error
summary: Create a task
tags:
- - Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: create a task'
@@ -10086,7 +10081,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Retrieve a task
tags:
- - Data I/O endpoints
- Tasks
patch:
description: |
@@ -10680,7 +10674,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Start a task run, overriding the schedule
tags:
- - Data I/O endpoints
- Tasks
/api/v2/tasks/{taskID}/runs/{runID}:
delete:
@@ -12809,8 +12802,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Write data
tags:
- - Data I/O endpoints
- - Write
+ - Write data
/legacy/authorizations:
get:
operationId: GetLegacyAuthorizations
@@ -20173,6 +20165,36 @@ components:
in: header
name: Authorization
type: apiKey
+ QuerystringAuthentication:
+ description: |
+ Use the query string authentication scheme with InfluxDB v1-compatible API operations.
+ Pass your InfluxDB username and API token as query parameters using `u` for username and `p` for password (API token).
+
+ ### Syntax
+
+ `?u=USERNAME&p=INFLUX_API_TOKEN`
+
+ ### Example
+
+ ```sh
+ curl --get "INFLUX_URL/query" \
+ --data-urlencode "u=USERNAME" \
+ --data-urlencode "p=INFLUX_API_TOKEN" \
+ --data-urlencode "q=SHOW DATABASES"
+ ```
+
+ Replace the following:
+
+ - *`INFLUX_URL`*: your InfluxDB URL
+ - *`USERNAME`*: your InfluxDB username
+ - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/v2/reference/glossary/#token)
+
+ > [!Warning]
+ > Query string authentication exposes your credentials in the URL and server logs.
+ > Use [Token authentication](#section/Authentication/TokenAuthentication) for production environments.
+ in: query
+ name: u
+ type: apiKey
x-tagGroups:
- name: Using the InfluxDB HTTP API
tags:
@@ -20204,7 +20226,7 @@ x-tagGroups:
- NotificationRules
- Organizations
- Ping
- - Query
+ - Query data
- Query data (v1-compatible)
- Ready
- RemoteConnections
@@ -20226,5 +20248,5 @@ x-tagGroups:
- Users
- Variables
- Views
- - Write
+ - Write data
- Write data (v1-compatible)
diff --git a/data/article_data/influxdb/cloud-v2/articles.json b/data/article_data/influxdb/cloud-v2/articles.json
index d73f39996..37fddd8b7 100644
--- a/data/article_data/influxdb/cloud-v2/articles.json
+++ b/data/article_data/influxdb/cloud-v2/articles.json
@@ -1,20 +1,2293 @@
{
"articles": [
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/authorizations",
+ "/api/v2/authorizations/{authID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/authorizations",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetAuthorizations",
+ "method": "GET",
+ "path": "/api/v2/authorizations",
+ "summary": "List authorizations",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostAuthorizations",
+ "method": "POST",
+ "path": "/api/v2/authorizations",
+ "summary": "Create an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetAuthorizationsID",
+ "method": "GET",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Retrieve an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ],
+ "externalDocs": {
+ "description": "View tokens",
+ "url": "https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/"
+ }
+ },
+ {
+ "operationId": "PatchAuthorizationsID",
+ "method": "PATCH",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Update an API token to be active or inactive",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteAuthorizationsID",
+ "method": "DELETE",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Delete an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ }
+ ],
+ "related": [
+ "https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/"
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-authorizations.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-authorizations.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/buckets",
+ "/api/v2/buckets/{bucketID}",
+ "/api/v2/buckets/{bucketID}/labels",
+ "/api/v2/buckets/{bucketID}/labels/{labelID}",
+ "/api/v2/buckets/{bucketID}/members",
+ "/api/v2/buckets/{bucketID}/members/{userID}",
+ "/api/v2/buckets/{bucketID}/owners",
+ "/api/v2/buckets/{bucketID}/owners/{userID}",
+ "/api/v2/buckets/{bucketID}/schema/measurements",
+ "/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/buckets",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetBuckets",
+ "method": "GET",
+ "path": "/api/v2/buckets",
+ "summary": "List buckets",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBuckets",
+ "method": "POST",
+ "path": "/api/v2/buckets",
+ "summary": "Create a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsID",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Retrieve a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PatchBucketsID",
+ "method": "PATCH",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Update a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Delete a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/labels",
+ "summary": "List all labels for a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/labels",
+ "summary": "Add a label to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/labels/{labelID}",
+ "summary": "Delete a label from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/members",
+ "summary": "List all users with member privileges for a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/members",
+ "summary": "Add a member to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/members/{userID}",
+ "summary": "Remove a member from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/owners",
+ "summary": "List all owners of a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/owners",
+ "summary": "Add an owner to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/owners/{userID}",
+ "summary": "Remove an owner from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "getMeasurementSchemas",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/schema/measurements",
+ "summary": "List measurement schemas of a bucket",
+ "tags": [
+ "Bucket Schemas"
+ ]
+ },
+ {
+ "operationId": "createMeasurementSchema",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/schema/measurements",
+ "summary": "Create a measurement schema for a bucket",
+ "tags": [
+ "Bucket Schemas"
+ ]
+ },
+ {
+ "operationId": "getMeasurementSchema",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}",
+ "summary": "Retrieve a measurement schema",
+ "tags": [
+ "Bucket Schemas"
+ ]
+ },
+ {
+ "operationId": "updateMeasurementSchema",
+ "method": "PATCH",
+ "path": "/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}",
+ "summary": "Update a measurement schema",
+ "tags": [
+ "Bucket Schemas"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-buckets.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-buckets.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/checks",
+ "/api/v2/checks/{checkID}",
+ "/api/v2/checks/{checkID}/labels",
+ "/api/v2/checks/{checkID}/labels/{labelID}",
+ "/api/v2/checks/{checkID}/query"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/checks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetChecks",
+ "method": "GET",
+ "path": "/api/v2/checks",
+ "summary": "List all checks",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "CreateCheck",
+ "method": "POST",
+ "path": "/api/v2/checks",
+ "summary": "Add new check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksID",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Retrieve a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PutChecksID",
+ "method": "PUT",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Update a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PatchChecksID",
+ "method": "PATCH",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Update a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "DeleteChecksID",
+ "method": "DELETE",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Delete a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksIDLabels",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}/labels",
+ "summary": "List all labels for a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PostChecksIDLabels",
+ "method": "POST",
+ "path": "/api/v2/checks/{checkID}/labels",
+ "summary": "Add a label to a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "DeleteChecksIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/checks/{checkID}/labels/{labelID}",
+ "summary": "Delete label from a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksIDQuery",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}/query",
+ "summary": "Retrieve a check query",
+ "tags": [
+ "Checks"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-checks.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-checks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/dashboards",
+ "/api/v2/dashboards/{dashboardID}",
+ "/api/v2/dashboards/{dashboardID}/cells",
+ "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "/api/v2/dashboards/{dashboardID}/labels",
+ "/api/v2/dashboards/{dashboardID}/labels/{labelID}",
+ "/api/v2/dashboards/{dashboardID}/members",
+ "/api/v2/dashboards/{dashboardID}/members/{userID}",
+ "/api/v2/dashboards/{dashboardID}/owners",
+ "/api/v2/dashboards/{dashboardID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/dashboards",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDashboards",
+ "method": "GET",
+ "path": "/api/v2/dashboards",
+ "summary": "List dashboards",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboards",
+ "method": "POST",
+ "path": "/api/v2/dashboards",
+ "summary": "Create a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsID",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Retrieve a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsID",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Update a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Delete a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDCells",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/cells",
+ "summary": "Create a dashboard cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PutDashboardsIDCells",
+ "method": "PUT",
+ "path": "/api/v2/dashboards/{dashboardID}/cells",
+ "summary": "Replace cells in a dashboard",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsIDCellsID",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "summary": "Update the non-positional information related to a cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDCellsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "summary": "Delete a dashboard cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDCellsIDView",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "summary": "Retrieve the view for a cell",
+ "tags": [
+ "Cells",
+ "Dashboards",
+ "Views"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsIDCellsIDView",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "summary": "Update the view for a cell",
+ "tags": [
+ "Cells",
+ "Dashboards",
+ "Views"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/labels",
+ "summary": "List all labels for a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/labels",
+ "summary": "Add a label to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/labels/{labelID}",
+ "summary": "Delete a label from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/members",
+ "summary": "List all dashboard members",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/members",
+ "summary": "Add a member to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/members/{userID}",
+ "summary": "Remove a member from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/owners",
+ "summary": "List all dashboard owners",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/owners",
+ "summary": "Add an owner to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/owners/{userID}",
+ "summary": "Remove an owner from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dashboards.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dashboards.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/dbrps",
+ "/api/v2/dbrps/{dbrpID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/dbrps",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDBRPs",
+ "method": "GET",
+ "path": "/api/v2/dbrps",
+ "summary": "List database retention policy mappings",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "PostDBRP",
+ "method": "POST",
+ "path": "/api/v2/dbrps",
+ "summary": "Add a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "GetDBRPsID",
+ "method": "GET",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Retrieve a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "PatchDBRPID",
+ "method": "PATCH",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Update a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "DeleteDBRPID",
+ "method": "DELETE",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Delete a database retention policy",
+ "tags": [
+ "DBRPs"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dbrps.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dbrps.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/delete"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/delete",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostDelete",
+ "method": "POST",
+ "path": "/api/v2/delete",
+ "summary": "Delete data",
+ "tags": [
+ "Delete"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-delete.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-delete.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/flags"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/flags",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetFlags",
+ "method": "GET",
+ "path": "/api/v2/flags",
+ "summary": "Retrieve feature flags",
+ "tags": [
+ "Config"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-flags.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-flags.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/labels",
+ "/api/v2/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/labels",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetLabels",
+ "method": "GET",
+ "path": "/api/v2/labels",
+ "summary": "List all labels",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "PostLabels",
+ "method": "POST",
+ "path": "/api/v2/labels",
+ "summary": "Create a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "GetLabelsID",
+ "method": "GET",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Retrieve a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "PatchLabelsID",
+ "method": "PATCH",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Update a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "DeleteLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Delete a label",
+ "tags": [
+ "Labels"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-labels.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-labels.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/maps/mapToken"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/maps",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "getMapboxToken",
+ "method": "GET",
+ "path": "/api/v2/maps/mapToken",
+ "summary": "Get a mapbox token",
+ "tags": []
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-maps.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-maps.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/me",
+ "/api/v2/me/password"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/me",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetMe",
+ "method": "GET",
+ "path": "/api/v2/me",
+ "summary": "Retrieve the currently authenticated user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PutMePassword",
+ "method": "PUT",
+ "path": "/api/v2/me/password",
+ "summary": "Update a password",
+ "tags": [
+ "Users"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-me.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-me.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/notificationEndpoints",
+ "/api/v2/notificationEndpoints/{endpointID}",
+ "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/notificationEndpoints",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetNotificationEndpoints",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints",
+ "summary": "List all notification endpoints",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "CreateNotificationEndpoint",
+ "method": "POST",
+ "path": "/api/v2/notificationEndpoints",
+ "summary": "Add a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "GetNotificationEndpointsID",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Retrieve a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PutNotificationEndpointsID",
+ "method": "PUT",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Update a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PatchNotificationEndpointsID",
+ "method": "PATCH",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Update a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationEndpointsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Delete a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "GetNotificationEndpointsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "summary": "List all labels for a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PostNotificationEndpointIDLabels",
+ "method": "POST",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "summary": "Add a label to a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationEndpointsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}",
+ "summary": "Delete a label from a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationEndpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationEndpoints.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/notificationRules",
+ "/api/v2/notificationRules/{ruleID}",
+ "/api/v2/notificationRules/{ruleID}/labels",
+ "/api/v2/notificationRules/{ruleID}/labels/{labelID}",
+ "/api/v2/notificationRules/{ruleID}/query"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/notificationRules",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetNotificationRules",
+ "method": "GET",
+ "path": "/api/v2/notificationRules",
+ "summary": "List all notification rules",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "CreateNotificationRule",
+ "method": "POST",
+ "path": "/api/v2/notificationRules",
+ "summary": "Add a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesID",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Retrieve a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PutNotificationRulesID",
+ "method": "PUT",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Update a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PatchNotificationRulesID",
+ "method": "PATCH",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Update a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationRulesID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Delete a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesIDLabels",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}/labels",
+ "summary": "List all labels for a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PostNotificationRuleIDLabels",
+ "method": "POST",
+ "path": "/api/v2/notificationRules/{ruleID}/labels",
+ "summary": "Add a label to a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationRulesIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationRules/{ruleID}/labels/{labelID}",
+ "summary": "Delete label from a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesIDQuery",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}/query",
+ "summary": "Retrieve a notification rule query",
+ "tags": [
+ "Rules"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationRules.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationRules.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/orgs",
+ "/api/v2/orgs/{orgID}",
+ "/api/v2/orgs/{orgID}/limits",
+ "/api/v2/orgs/{orgID}/members",
+ "/api/v2/orgs/{orgID}/members/{userID}",
+ "/api/v2/orgs/{orgID}/owners",
+ "/api/v2/orgs/{orgID}/owners/{userID}",
+ "/api/v2/orgs/{orgID}/secrets",
+ "/api/v2/orgs/{orgID}/secrets/delete",
+ "/api/v2/orgs/{orgID}/secrets/{secretID}",
+ "/api/v2/orgs/{orgID}/usage"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/orgs",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetOrgs",
+ "method": "GET",
+ "path": "/api/v2/orgs",
+ "summary": "List organizations",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgs",
+ "method": "POST",
+ "path": "/api/v2/orgs",
+ "summary": "Create an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "GetOrgsID",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Retrieve an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PatchOrgsID",
+ "method": "PATCH",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Update an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Delete an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "GetOrgLimitsID",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/limits",
+ "summary": "Retrieve limits for an organization",
+ "tags": [
+ "Limits"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/members",
+ "summary": "List all members of an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/members",
+ "summary": "Add a member to an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/members/{userID}",
+ "summary": "Remove a member from an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/owners",
+ "summary": "List all owners of an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/owners",
+ "summary": "Add an owner to an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/owners/{userID}",
+ "summary": "Remove an owner from an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDSecrets",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/secrets",
+ "summary": "List all secret keys for an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PatchOrgsIDSecrets",
+ "method": "PATCH",
+ "path": "/api/v2/orgs/{orgID}/secrets",
+ "summary": "Update secrets in an organization",
+ "tags": [
+ "Secrets"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDSecrets",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/secrets/delete",
+ "summary": "Delete secrets from an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDSecretsID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/secrets/{secretID}",
+ "summary": "Delete a secret from an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetOrgUsageID",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/usage",
+ "summary": "Retrieve usage for an organization",
+ "tags": [
+ "Usage"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-orgs.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-orgs.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/query",
+ "/api/v2/query/analyze",
+ "/api/v2/query/ast",
+ "/api/v2/query/suggestions",
+ "/api/v2/query/suggestions/{name}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/query",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostQuery",
+ "method": "POST",
+ "path": "/api/v2/query",
+ "summary": "Query data",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "PostQueryAnalyze",
+ "method": "POST",
+ "path": "/api/v2/query/analyze",
+ "summary": "Analyze a Flux query",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "PostQueryAst",
+ "method": "POST",
+ "path": "/api/v2/query/ast",
+ "summary": "Generate a query Abstract Syntax Tree (AST)",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "GetQuerySuggestions",
+ "method": "GET",
+ "path": "/api/v2/query/suggestions",
+ "summary": "List Flux query suggestions",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "GetQuerySuggestionsName",
+ "method": "GET",
+ "path": "/api/v2/query/suggestions/{name}",
+ "summary": "Retrieve a query suggestion for a branching suggestion",
+ "tags": [
+ "Query data"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-query.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-query.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/resources"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/resources",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetResources",
+ "method": "GET",
+ "path": "/api/v2/resources",
+ "summary": "List all known resources",
+ "tags": [
+ "Resources",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-resources.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-resources.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/scripts",
+ "/api/v2/scripts/{scriptID}",
+ "/api/v2/scripts/{scriptID}/invoke",
+ "/api/v2/scripts/{scriptID}/params"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/scripts",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetScripts",
+ "method": "GET",
+ "path": "/api/v2/scripts",
+ "summary": "List scripts",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "PostScripts",
+ "method": "POST",
+ "path": "/api/v2/scripts",
+ "summary": "Create a script",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "GetScriptsID",
+ "method": "GET",
+ "path": "/api/v2/scripts/{scriptID}",
+ "summary": "Retrieve a script",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "PatchScriptsID",
+ "method": "PATCH",
+ "path": "/api/v2/scripts/{scriptID}",
+ "summary": "Update a script",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "DeleteScriptsID",
+ "method": "DELETE",
+ "path": "/api/v2/scripts/{scriptID}",
+ "summary": "Delete a script",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "PostScriptsIDInvoke",
+ "method": "POST",
+ "path": "/api/v2/scripts/{scriptID}/invoke",
+ "summary": "Invoke a script",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ },
+ {
+ "operationId": "GetScriptsIDParams",
+ "method": "GET",
+ "path": "/api/v2/scripts/{scriptID}/params",
+ "summary": "Find script parameters.",
+ "tags": [
+ "Invokable Scripts"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-scripts.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-scripts.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/setup",
+ "/api/v2/setup/user"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/setup",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetSetup",
+ "method": "GET",
+ "path": "/api/v2/setup",
+ "summary": "Retrieve setup status",
+ "tags": [
+ "Setup"
+ ]
+ },
+ {
+ "operationId": "PostSetup",
+ "method": "POST",
+ "path": "/api/v2/setup",
+ "summary": "Create an initial user, organization, and bucket",
+ "tags": [
+ "Setup"
+ ]
+ },
+ {
+ "operationId": "PostSetupUser",
+ "method": "POST",
+ "path": "/api/v2/setup/user",
+ "summary": "Create a new user, organization, and bucket",
+ "tags": [
+ "Setup"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-setup.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-setup.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/signin"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/signin",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostSignin",
+ "method": "POST",
+ "path": "/api/v2/signin",
+ "summary": "Create a user session.",
+ "tags": [
+ "Security and access endpoints",
+ "Signin"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signin.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signin.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/signout"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/signout",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostSignout",
+ "method": "POST",
+ "path": "/api/v2/signout",
+ "summary": "Expire a user session",
+ "tags": [
+ "Security and access endpoints",
+ "Signout"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signout.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signout.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/stacks",
+ "/api/v2/stacks/{stack_id}",
+ "/api/v2/stacks/{stack_id}/uninstall"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/stacks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "ListStacks",
+ "method": "GET",
+ "path": "/api/v2/stacks",
+ "summary": "List installed stacks",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "CreateStack",
+ "method": "POST",
+ "path": "/api/v2/stacks",
+ "summary": "Create a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "ReadStack",
+ "method": "GET",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Retrieve a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "UpdateStack",
+ "method": "PATCH",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Update a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "DeleteStack",
+ "method": "DELETE",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Delete a stack and associated resources",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "UninstallStack",
+ "method": "POST",
+ "path": "/api/v2/stacks/{stack_id}/uninstall",
+ "summary": "Uninstall a stack",
+ "tags": [
+ "Templates"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-stacks.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-stacks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/tasks",
+ "/api/v2/tasks/{taskID}",
+ "/api/v2/tasks/{taskID}/labels",
+ "/api/v2/tasks/{taskID}/labels/{labelID}",
+ "/api/v2/tasks/{taskID}/logs",
+ "/api/v2/tasks/{taskID}/members",
+ "/api/v2/tasks/{taskID}/members/{userID}",
+ "/api/v2/tasks/{taskID}/owners",
+ "/api/v2/tasks/{taskID}/owners/{userID}",
+ "/api/v2/tasks/{taskID}/runs",
+ "/api/v2/tasks/{taskID}/runs/{runID}",
+ "/api/v2/tasks/{taskID}/runs/{runID}/logs",
+ "/api/v2/tasks/{taskID}/runs/{runID}/retry"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/tasks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTasks",
+ "method": "GET",
+ "path": "/api/v2/tasks",
+ "summary": "List all tasks",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasks",
+ "method": "POST",
+ "path": "/api/v2/tasks",
+ "summary": "Create a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksID",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Retrieve a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PatchTasksID",
+ "method": "PATCH",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Update a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Delete a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDLabels",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/labels",
+ "summary": "List labels for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDLabels",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/labels",
+ "summary": "Add a label to a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/labels/{labelID}",
+ "summary": "Delete a label from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDLogs",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/logs",
+ "summary": "Retrieve all logs for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDMembers",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/members",
+ "summary": "List all task members",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDMembers",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/members",
+ "summary": "Add a member to a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/members/{userID}",
+ "summary": "Remove a member from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDOwners",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/owners",
+ "summary": "List all owners of a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDOwners",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/owners",
+ "summary": "Add an owner for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/owners/{userID}",
+ "summary": "Remove an owner from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRuns",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs",
+ "summary": "List runs for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDRuns",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/runs",
+ "summary": "Start a task run, overriding the schedule",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRunsID",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}",
+ "summary": "Retrieve a run for a task.",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDRunsID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}",
+ "summary": "Cancel a running task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRunsIDLogs",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}/logs",
+ "summary": "Retrieve all logs for a run",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDRunsIDRetry",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}/retry",
+ "summary": "Retry a task run",
+ "tags": [
+ "Tasks"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-tasks.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-tasks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/telegraf/plugins"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/telegraf",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTelegrafPlugins",
+ "method": "GET",
+ "path": "/api/v2/telegraf/plugins",
+ "summary": "List all Telegraf plugins",
+ "tags": [
+ "Telegraf Plugins"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegraf.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegraf.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/telegrafs",
+ "/api/v2/telegrafs/{telegrafID}",
+ "/api/v2/telegrafs/{telegrafID}/labels",
+ "/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
+ "/api/v2/telegrafs/{telegrafID}/members",
+ "/api/v2/telegrafs/{telegrafID}/members/{userID}",
+ "/api/v2/telegrafs/{telegrafID}/owners",
+ "/api/v2/telegrafs/{telegrafID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/telegrafs",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTelegrafs",
+ "method": "GET",
+ "path": "/api/v2/telegrafs",
+ "summary": "List all Telegraf configurations",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafs",
+ "method": "POST",
+ "path": "/api/v2/telegrafs",
+ "summary": "Create a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsID",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Retrieve a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PutTelegrafsID",
+ "method": "PUT",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Update a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Delete a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels",
+ "summary": "List all labels for a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels",
+ "summary": "Add a label to a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
+ "summary": "Delete a label from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/members",
+ "summary": "List all users with member privileges for a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/members",
+ "summary": "Add a member to a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/members/{userID}",
+ "summary": "Remove a member from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners",
+ "summary": "List all owners of a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners",
+ "summary": "Add an owner to a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners/{userID}",
+ "summary": "Remove an owner from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegrafs.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegrafs.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/templates/apply",
+ "/api/v2/templates/export"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/templates",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "ApplyTemplate",
+ "method": "POST",
+ "path": "/api/v2/templates/apply",
+ "summary": "Apply or dry-run a template",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "ExportTemplate",
+ "method": "POST",
+ "path": "/api/v2/templates/export",
+ "summary": "Export a new template",
+ "tags": [
+ "Templates"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-templates.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-templates.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/users",
+ "/api/v2/users/{userID}",
+ "/api/v2/users/{userID}/password"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/users",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetUsers",
+ "method": "GET",
+ "path": "/api/v2/users",
+ "summary": "List users",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PostUsers",
+ "method": "POST",
+ "path": "/api/v2/users",
+ "summary": "Create a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "GetUsersID",
+ "method": "GET",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Retrieve a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PatchUsersID",
+ "method": "PATCH",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Update a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "DeleteUsersID",
+ "method": "DELETE",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Delete a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PostUsersIDPassword",
+ "method": "POST",
+ "path": "/api/v2/users/{userID}/password",
+ "summary": "Update a password",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PutUsersIDPassword",
+ "method": "PUT",
+ "path": "/api/v2/users/{userID}/password",
+ "summary": "Update a password",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-users.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-users.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/variables",
+ "/api/v2/variables/{variableID}",
+ "/api/v2/variables/{variableID}/labels",
+ "/api/v2/variables/{variableID}/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/variables",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetVariables",
+ "method": "GET",
+ "path": "/api/v2/variables",
+ "summary": "List all variables",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PostVariables",
+ "method": "POST",
+ "path": "/api/v2/variables",
+ "summary": "Create a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "GetVariablesID",
+ "method": "GET",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Retrieve a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PutVariablesID",
+ "method": "PUT",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Replace a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PatchVariablesID",
+ "method": "PATCH",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Update a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "DeleteVariablesID",
+ "method": "DELETE",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Delete a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "GetVariablesIDLabels",
+ "method": "GET",
+ "path": "/api/v2/variables/{variableID}/labels",
+ "summary": "List all labels for a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PostVariablesIDLabels",
+ "method": "POST",
+ "path": "/api/v2/variables/{variableID}/labels",
+ "summary": "Add a label to a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "DeleteVariablesIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/variables/{variableID}/labels/{labelID}",
+ "summary": "Delete a label from a variable",
+ "tags": [
+ "Variables"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-variables.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-variables.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/write"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/write",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostWrite",
+ "method": "POST",
+ "path": "/api/v2/write",
+ "summary": "Write data",
+ "tags": [
+ "Write data"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-write.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-write.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetRoutes",
+ "method": "GET",
+ "path": "/api/v2",
+ "summary": "List all top level routes",
+ "tags": [
+ "Routes",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2.yaml"
+ }
+ },
{
"path": "api/authentication",
"fields": {
"name": "Authentication",
"describes": [],
"title": "Authentication",
- "description": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- [Token authentication](#section/Authentication/TokenAuthentication)\n- [Basic authentication](#section/Authentication/BasicAuthentication)\n- [Querystring authentication](#section/Authentication/QuerystringAuthentication)\n\n",
+ "description": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- Token authentication\n- Basic authentication\n- Querystring authentication",
"tag": "Authentication",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- [Token authentication](#section/Authentication/TokenAuthentication)\n- [Basic authentication](#section/Authentication/BasicAuthentication)\n- [Querystring authentication](#section/Authentication/QuerystringAuthentication)\n\n",
+ "tagDescription": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- Token authentication\n- Basic authentication\n- Querystring authentication",
"showSecuritySchemes": true,
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authentication.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authentication.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authentication.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authentication.yaml"
}
},
{
@@ -26,7 +2299,7 @@
"/api/v2/authorizations/{authID}"
],
"title": "Authorizations (API tokens)",
- "description": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend the following for managing your tokens:\n\n- Create a generic user to create and manage tokens for writing data.\n- Store your tokens in a secure password vault for future access.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf the user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/).\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related endpoints\n\n- [Signin](#tag/Signin)\n- [Signout](#tag/Signout)\n\n### Related guides\n\n- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication)\n- [Manage API tokens](/influxdb/cloud/security/tokens/)\n- [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/)\n",
+ "description": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend the following for managing your tokens:\n\n- Create a generic user to create and manage tokens for writing data.\n- Store your tokens in a secure password vault for future access.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf the user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/).\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related endpoints\n\n- Signin\n- Signout\n\n### Related guides\n\n- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/)\n- [Manage API tokens](/influxdb/cloud/security/tokens/)\n- [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/)",
"tag": "Authorizations (API tokens)",
"isConceptual": false,
"menuGroup": "Other",
@@ -81,12 +2354,12 @@
]
}
],
- "tagDescription": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend the following for managing your tokens:\n\n- Create a generic user to create and manage tokens for writing data.\n- Store your tokens in a secure password vault for future access.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf the user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/).\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related endpoints\n\n- [Signin](#tag/Signin)\n- [Signout](#tag/Signout)\n\n### Related guides\n\n- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication)\n- [Manage API tokens](/influxdb/cloud/security/tokens/)\n- [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/)\n",
+ "tagDescription": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend the following for managing your tokens:\n\n- Create a generic user to create and manage tokens for writing data.\n- Store your tokens in a secure password vault for future access.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf the user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/).\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related endpoints\n\n- Signin\n- Signout\n\n### Related guides\n\n- [Authorize API requests](/influxdb/cloud/api-guide/api_intro/)\n- [Manage API tokens](/influxdb/cloud/security/tokens/)\n- [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/)",
"related": [
"https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/"
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml"
}
},
{
@@ -140,8 +2413,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-bucket-schemas.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-bucket-schemas.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-bucket-schemas.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-bucket-schemas.yaml"
}
},
{
@@ -159,7 +2432,7 @@
"/api/v2/buckets/{bucketID}/owners/{userID}"
],
"title": "Buckets",
- "description": "Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/#bucket).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/cloud/reference/glossary/#retention-period),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/cloud/organizations/buckets/)\n",
+ "description": "Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/cloud/reference/glossary/),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/cloud/organizations/buckets/)",
"tag": "Buckets",
"isConceptual": false,
"menuGroup": "Other",
@@ -291,9 +2564,9 @@
]
}
],
- "tagDescription": "Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/#bucket).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/cloud/reference/glossary/#retention-period),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/cloud/organizations/buckets/)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-buckets.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-buckets.yaml"
+ "tagDescription": "Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/cloud/reference/glossary/),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/cloud/organizations/buckets/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-buckets.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-buckets.yaml"
}
},
{
@@ -366,8 +2639,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-cells.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-cells.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-cells.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-cells.yaml"
}
},
{
@@ -478,8 +2751,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-checks.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-checks.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-checks.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-checks.yaml"
}
},
{
@@ -488,14 +2761,14 @@
"name": "Common parameters",
"describes": [],
"title": "Common parameters",
- "description": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n",
+ "description": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |",
"tag": "Common parameters",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-common-parameters.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-common-parameters.yaml"
+ "tagDescription": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). |",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-common-parameters.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-common-parameters.yaml"
}
},
{
@@ -521,8 +2794,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-config.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-config.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-config.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-config.yaml"
}
},
{
@@ -729,124 +3002,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dashboards.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dashboards.yaml"
- }
- },
- {
- "path": "api/data-i-o-endpoints",
- "fields": {
- "name": "Data I/O endpoints",
- "describes": [
- "/api/v2/delete",
- "/api/v2/query",
- "/api/v2/scripts",
- "/api/v2/scripts/{scriptID}",
- "/api/v2/scripts/{scriptID}/invoke",
- "/api/v2/tasks",
- "/api/v2/tasks/{taskID}",
- "/api/v2/tasks/{taskID}/runs",
- "/api/v2/write"
- ],
- "title": "Data I/O endpoints",
- "description": "API reference for Data I/O endpoints",
- "tag": "Data I/O endpoints",
- "isConceptual": false,
- "menuGroup": "Other",
- "operations": [
- {
- "operationId": "PostDelete",
- "method": "POST",
- "path": "/api/v2/delete",
- "summary": "Delete data",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostQuery",
- "method": "POST",
- "path": "/api/v2/query",
- "summary": "Query data",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetScripts",
- "method": "GET",
- "path": "/api/v2/scripts",
- "summary": "List scripts",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetScriptsID",
- "method": "GET",
- "path": "/api/v2/scripts/{scriptID}",
- "summary": "Retrieve a script",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostScriptsIDInvoke",
- "method": "POST",
- "path": "/api/v2/scripts/{scriptID}/invoke",
- "summary": "Invoke a script",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetTasks",
- "method": "GET",
- "path": "/api/v2/tasks",
- "summary": "List all tasks",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostTasks",
- "method": "POST",
- "path": "/api/v2/tasks",
- "summary": "Create a task",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetTasksID",
- "method": "GET",
- "path": "/api/v2/tasks/{taskID}",
- "summary": "Retrieve a task",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostTasksIDRuns",
- "method": "POST",
- "path": "/api/v2/tasks/{taskID}/runs",
- "summary": "Start a task run, overriding the schedule",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostWrite",
- "method": "POST",
- "path": "/api/v2/write",
- "summary": "Write data",
- "tags": [
- "Data I/O endpoints"
- ]
- }
- ],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-data-i-o-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-data-i-o-endpoints.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dashboards.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dashboards.yaml"
}
},
{
@@ -858,7 +3015,7 @@
"/api/v2/dbrps/{dbrpID}"
],
"title": "DBRPs",
- "description": "The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/#database)\nand [retention policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in 1.x compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n",
+ "description": "The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/)\nand [retention policies](/influxdb/cloud/reference/glossary/).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in 1.x compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)",
"tag": "DBRPs",
"isConceptual": false,
"menuGroup": "Other",
@@ -909,9 +3066,9 @@
]
}
],
- "tagDescription": "The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/#database)\nand [retention policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in 1.x compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dbrps.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dbrps.yaml"
+ "tagDescription": "The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/)\nand [retention policies](/influxdb/cloud/reference/glossary/).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in 1.x compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dbrps.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dbrps.yaml"
}
},
{
@@ -922,7 +3079,7 @@
"/api/v2/delete"
],
"title": "Delete",
- "description": "Delete data from an InfluxDB bucket.\n",
+ "description": "Delete data from an InfluxDB bucket.",
"tag": "Delete",
"isConceptual": false,
"menuGroup": "Other",
@@ -937,9 +3094,9 @@
]
}
],
- "tagDescription": "Delete data from an InfluxDB bucket.\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-delete.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-delete.yaml"
+ "tagDescription": "Delete data from an InfluxDB bucket.",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-delete.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-delete.yaml"
}
},
{
@@ -948,14 +3105,14 @@
"name": "Headers",
"describes": [],
"title": "Headers",
- "description": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/cloud/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
+ "description": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/cloud/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |",
"tag": "Headers",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/cloud/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-headers.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-headers.yaml"
+ "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/cloud/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-headers.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-headers.yaml"
}
},
{
@@ -969,7 +3126,7 @@
"/api/v2/scripts/{scriptID}/params"
],
"title": "Invokable Scripts",
- "description": "Store, manage, and execute scripts in InfluxDB.\nA script stores your custom Flux script and provides an invokable\nendpoint that accepts runtime parameters.\nIn a script, you can specify custom runtime parameters\n(`params`)--for example, `params.myparameter`.\nOnce you create a script, InfluxDB generates an\n[`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke)\nfor your organization.\nYou can run the script from API requests and tasks, defining parameter\nvalues for each run.\nWhen the script runs, InfluxDB replaces `params` references in the\nscript with the runtime parameter values you define.\n\nUse the `/api/v2/scripts` endpoints to create and manage scripts.\nSee related guides to learn how to define parameters and execute scripts.\n\n### Related guides\n\n- [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests.\n- [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script)\n",
+ "description": "Store, manage, and execute scripts in InfluxDB.\nA script stores your custom Flux script and provides an invokable\nendpoint that accepts runtime parameters.\nIn a script, you can specify custom runtime parameters\n(`params`)--for example, `params.myparameter`.\nOnce you create a script, InfluxDB generates an\n`/api/v2/scripts/SCRIPT_ID/invoke` endpoint\nfor your organization.\nYou can run the script from API requests and tasks, defining parameter\nvalues for each run.\nWhen the script runs, InfluxDB replaces `params` references in the\nscript with the runtime parameter values you define.\n\nUse the `/api/v2/scripts` endpoints to create and manage scripts.\nSee related guides to learn how to define parameters and execute scripts.\n\n### Related guides\n\n- [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests.\n- [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/)",
"tag": "Invokable Scripts",
"isConceptual": false,
"menuGroup": "Other",
@@ -1038,9 +3195,9 @@
]
}
],
- "tagDescription": "Store, manage, and execute scripts in InfluxDB.\nA script stores your custom Flux script and provides an invokable\nendpoint that accepts runtime parameters.\nIn a script, you can specify custom runtime parameters\n(`params`)--for example, `params.myparameter`.\nOnce you create a script, InfluxDB generates an\n[`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke)\nfor your organization.\nYou can run the script from API requests and tasks, defining parameter\nvalues for each run.\nWhen the script runs, InfluxDB replaces `params` references in the\nscript with the runtime parameter values you define.\n\nUse the `/api/v2/scripts` endpoints to create and manage scripts.\nSee related guides to learn how to define parameters and execute scripts.\n\n### Related guides\n\n- [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests.\n- [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-invokable-scripts.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-invokable-scripts.yaml"
+ "tagDescription": "Store, manage, and execute scripts in InfluxDB.\nA script stores your custom Flux script and provides an invokable\nendpoint that accepts runtime parameters.\nIn a script, you can specify custom runtime parameters\n(`params`)--for example, `params.myparameter`.\nOnce you create a script, InfluxDB generates an\n`/api/v2/scripts/SCRIPT_ID/invoke` endpoint\nfor your organization.\nYou can run the script from API requests and tasks, defining parameter\nvalues for each run.\nWhen the script runs, InfluxDB replaces `params` references in the\nscript with the runtime parameter values you define.\n\nUse the `/api/v2/scripts` endpoints to create and manage scripts.\nSee related guides to learn how to define parameters and execute scripts.\n\n### Related guides\n\n- [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests.\n- [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-invokable-scripts.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-invokable-scripts.yaml"
}
},
{
@@ -1103,8 +3260,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-labels.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-labels.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-labels.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-labels.yaml"
}
},
{
@@ -1177,8 +3334,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-authorizations.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-authorizations.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-authorizations.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-authorizations.yaml"
}
},
{
@@ -1204,8 +3361,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-query.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-query.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-query.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-query.yaml"
}
},
{
@@ -1231,8 +3388,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-write.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-write.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-write.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-write.yaml"
}
},
{
@@ -1258,8 +3415,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-limits.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-limits.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-limits.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-limits.yaml"
}
},
{
@@ -1360,8 +3517,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationendpoints.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationendpoints.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationendpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationendpoints.yaml"
}
},
{
@@ -1462,8 +3619,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationrules.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationrules.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationrules.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationrules.yaml"
}
},
{
@@ -1479,7 +3636,7 @@
"/api/v2/orgs/{orgID}/owners/{userID}"
],
"title": "Organizations",
- "description": "Manage your [organization](/influxdb/cloud/reference/glossary/#organization).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to view and manage organizations.\n",
+ "description": "Manage your [organization](/influxdb/cloud/reference/glossary/).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to view and manage organizations.",
"tag": "Organizations",
"isConceptual": false,
"menuGroup": "Other",
@@ -1584,9 +3741,9 @@
]
}
],
- "tagDescription": "Manage your [organization](/influxdb/cloud/reference/glossary/#organization).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to view and manage organizations.\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-organizations.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-organizations.yaml"
+ "tagDescription": "Manage your [organization](/influxdb/cloud/reference/glossary/).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to view and manage organizations.",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-organizations.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-organizations.yaml"
}
},
{
@@ -1595,14 +3752,14 @@
"name": "Pagination",
"describes": [],
"title": "Pagination",
- "description": "Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results:\n\n | Query parameter | Value type | Description |\n |:------------------------ |:--------------------- |:-------------------------------------------|\n | `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n | `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n ### Limitations\n\n - For specific endpoint parameters and examples, see the endpoint definition.\n - If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```\n",
+ "description": "Some InfluxDB API list operations may support the following query parameters for paginating results:\n\n | Query parameter | Value type | Description |\n |:------------------------ |:--------------------- |:-------------------------------------------|\n | `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n | `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n ### Limitations\n\n - For specific endpoint parameters and examples, see the endpoint definition.\n - If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```",
"tag": "Pagination",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results:\n\n | Query parameter | Value type | Description |\n |:------------------------ |:--------------------- |:-------------------------------------------|\n | `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n | `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n ### Limitations\n\n - For specific endpoint parameters and examples, see the endpoint definition.\n - If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-pagination.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-pagination.yaml"
+ "tagDescription": "Some InfluxDB API list operations may support the following query parameters for paginating results:\n\n | Query parameter | Value type | Description |\n |:------------------------ |:--------------------- |:-------------------------------------------|\n | `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n | `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n ### Limitations\n\n - For specific endpoint parameters and examples, see the endpoint definition.\n - If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-pagination.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-pagination.yaml"
}
},
{
@@ -1637,14 +3794,14 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-ping.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-ping.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-ping.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-ping.yaml"
}
},
{
- "path": "api/query",
+ "path": "api/query-data",
"fields": {
- "name": "Query",
+ "name": "Query data",
"describes": [
"/api/v2/query",
"/api/v2/query/analyze",
@@ -1652,11 +3809,11 @@
"/api/v2/query/suggestions",
"/api/v2/query/suggestions/{name}"
],
- "title": "Query",
- "description": "Retrieve data, analyze queries, and get query suggestions.\n",
- "tag": "Query",
+ "title": "Query data",
+ "description": "Retrieve data, analyze queries, and get query suggestions.",
+ "tag": "Query data",
"isConceptual": false,
- "menuGroup": "Other",
+ "menuGroup": "Data Operations",
"operations": [
{
"operationId": "PostQuery",
@@ -1664,7 +3821,7 @@
"path": "/api/v2/query",
"summary": "Query data",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1673,7 +3830,7 @@
"path": "/api/v2/query/analyze",
"summary": "Analyze a Flux query",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1682,7 +3839,7 @@
"path": "/api/v2/query/ast",
"summary": "Generate a query Abstract Syntax Tree (AST)",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1691,7 +3848,7 @@
"path": "/api/v2/query/suggestions",
"summary": "List Flux query suggestions",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1700,13 +3857,40 @@
"path": "/api/v2/query/suggestions/{name}",
"summary": "Retrieve a query suggestion for a branching suggestion",
"tags": [
- "Query"
+ "Query data"
]
}
],
- "tagDescription": "Retrieve data, analyze queries, and get query suggestions.\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-query.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-query.yaml"
+ "tagDescription": "Retrieve data, analyze queries, and get query suggestions.",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query-data.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query-data.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/query"
+ ],
+ "title": "",
+ "description": "API reference for /query",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetLegacyQuery",
+ "method": "GET",
+ "path": "/query",
+ "summary": "Query with the 1.x compatibility API",
+ "tags": [
+ "Legacy Query"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query.yaml"
}
},
{
@@ -1715,14 +3899,14 @@
"name": "Quick start",
"describes": [],
"title": "Quick start",
- "description": "See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.\n",
+ "description": "See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.",
"tag": "Quick start",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-quick-start.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-quick-start.yaml"
+ "tagDescription": "See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-quick-start.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-quick-start.yaml"
}
},
{
@@ -1748,8 +3932,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-resources.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-resources.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-resources.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-resources.yaml"
}
},
{
@@ -1758,14 +3942,14 @@
"name": "Response codes",
"describes": [],
"title": "Response codes",
- "description": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. |\n| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: - Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your [_monitoring bucket](/influxdb/cloud/reference/internals/system-buckets/#_monitoring-system-bucket).
- `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/cloud/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |\n",
+ "description": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. |\n| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: - Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your [_monitoring bucket](/influxdb/cloud/reference/internals/system-buckets/).
- `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/cloud/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |",
"tag": "Response codes",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. |\n| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: - Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your [_monitoring bucket](/influxdb/cloud/reference/internals/system-buckets/#_monitoring-system-bucket).
- `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/cloud/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-response-codes.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-response-codes.yaml"
+ "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | No content | For a `POST` request, `204` indicates that InfluxDB accepted the request and request data is valid. Asynchronous operations, such as `write`, might not have completed yet. |\n| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: - Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your [_monitoring bucket](/influxdb/cloud/reference/internals/system-buckets/).
- `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/cloud/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-response-codes.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-response-codes.yaml"
}
},
{
@@ -1791,8 +3975,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-routes.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-routes.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-routes.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-routes.yaml"
}
},
{
@@ -1818,8 +4002,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-rules.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-rules.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-rules.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-rules.yaml"
}
},
{
@@ -1874,8 +4058,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-secrets.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-secrets.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-secrets.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-secrets.yaml"
}
},
{
@@ -2084,8 +4268,8 @@
"related": [
"https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/"
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml"
}
},
{
@@ -2130,8 +4314,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-setup.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-setup.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-setup.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-setup.yaml"
}
},
{
@@ -2157,8 +4341,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signin.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signin.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signin.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signin.yaml"
}
},
{
@@ -2184,8 +4368,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signout.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signout.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signout.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signout.yaml"
}
},
{
@@ -2194,14 +4378,14 @@
"name": "Supported operations",
"describes": [],
"title": "Supported operations",
- "description": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n",
+ "description": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |",
"tag": "Supported operations",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-supported-operations.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-supported-operations.yaml"
+ "tagDescription": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-supported-operations.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-supported-operations.yaml"
}
},
{
@@ -2247,8 +4431,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-system-information-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-system-information-endpoints.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-system-information-endpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-system-information-endpoints.yaml"
}
},
{
@@ -2271,7 +4455,7 @@
"/api/v2/tasks/{taskID}/runs/{runID}/retry"
],
"title": "Tasks",
- "description": "Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/#task)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks).\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in this object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/cloud/process-data/get-started/)\n- [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/)\n- [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script)\n",
+ "description": "Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the `POST /api/v2/tasks` endpoint.\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in this object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/cloud/process-data/get-started/)\n- [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/)\n- [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/)",
"tag": "Tasks",
"isConceptual": false,
"menuGroup": "Other",
@@ -2466,9 +4650,9 @@
]
}
],
- "tagDescription": "Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/#task)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks).\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in this object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/cloud/process-data/get-started/)\n- [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/)\n- [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-tasks.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-tasks.yaml"
+ "tagDescription": "Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the `POST /api/v2/tasks` endpoint.\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in this object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/cloud/process-data/get-started/)\n- [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/)\n- [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-tasks.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-tasks.yaml"
}
},
{
@@ -2494,8 +4678,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegraf-plugins.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegraf-plugins.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegraf-plugins.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegraf-plugins.yaml"
}
},
{
@@ -2645,8 +4829,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegrafs.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegrafs.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegrafs.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegrafs.yaml"
}
},
{
@@ -2661,7 +4845,7 @@
"/api/v2/templates/export"
],
"title": "Templates",
- "description": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for resources.\nUse InfluxDB templates to configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/cloud/influxdb-templates/)\n",
+ "description": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for resources.\nUse InfluxDB templates to configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/cloud/influxdb-templates/)",
"tag": "Templates",
"isConceptual": false,
"menuGroup": "Other",
@@ -2739,9 +4923,9 @@
]
}
],
- "tagDescription": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for resources.\nUse InfluxDB templates to configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/cloud/influxdb-templates/)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-templates.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-templates.yaml"
+ "tagDescription": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for resources.\nUse InfluxDB templates to configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/cloud/influxdb-templates/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-templates.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-templates.yaml"
}
},
{
@@ -2767,8 +4951,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-usage.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-usage.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-usage.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-usage.yaml"
}
},
{
@@ -2783,7 +4967,7 @@
"/api/v2/users/{userID}/password"
],
"title": "Users",
- "description": "Retrieve specific users.\n\nInfluxDB Cloud lets you invite and collaborate with multiple users in your organization.\nTo invite and remove users from your organization, use the InfluxDB Cloud user interface (UI);\nyou can't use the InfluxDB API to manage users in InfluxDB Cloud.\nOnce a user is added to your organization, you can use the\n`GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to\nview specific members.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related guides\n\n- [Manage users](/influxdb/cloud/organizations/users/)\n",
+ "description": "Retrieve specific users.\n\nInfluxDB Cloud lets you invite and collaborate with multiple users in your organization.\nTo invite and remove users from your organization, use the InfluxDB Cloud user interface (UI);\nyou can't use the InfluxDB API to manage users in InfluxDB Cloud.\nOnce a user is added to your organization, you can use the\n`GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to\nview specific members.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related guides\n\n- [Manage users](/influxdb/cloud/organizations/users/)",
"tag": "Users",
"isConceptual": false,
"menuGroup": "Other",
@@ -2870,9 +5054,9 @@
]
}
],
- "tagDescription": "Retrieve specific users.\n\nInfluxDB Cloud lets you invite and collaborate with multiple users in your organization.\nTo invite and remove users from your organization, use the InfluxDB Cloud user interface (UI);\nyou can't use the InfluxDB API to manage users in InfluxDB Cloud.\nOnce a user is added to your organization, you can use the\n`GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to\nview specific members.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related guides\n\n- [Manage users](/influxdb/cloud/organizations/users/)\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-users.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-users.yaml"
+ "tagDescription": "Retrieve specific users.\n\nInfluxDB Cloud lets you invite and collaborate with multiple users in your organization.\nTo invite and remove users from your organization, use the InfluxDB Cloud user interface (UI);\nyou can't use the InfluxDB API to manage users in InfluxDB Cloud.\nOnce a user is added to your organization, you can use the\n`GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to\nview specific members.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related guides\n\n- [Manage users](/influxdb/cloud/organizations/users/)",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-users.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-users.yaml"
}
},
{
@@ -2973,8 +5157,8 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-variables.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-variables.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-variables.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-variables.yaml"
}
},
{
@@ -3009,22 +5193,22 @@
]
}
],
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-views.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-views.yaml"
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-views.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-views.yaml"
}
},
{
- "path": "api/write",
+ "path": "api/write-data",
"fields": {
- "name": "Write",
+ "name": "Write data",
"describes": [
"/api/v2/write"
],
- "title": "Write",
- "description": "Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket).\n",
- "tag": "Write",
+ "title": "Write data",
+ "description": "Write time series data to [buckets](/influxdb/cloud/reference/glossary/).",
+ "tag": "Write data",
"isConceptual": false,
- "menuGroup": "Other",
+ "menuGroup": "Data Operations",
"operations": [
{
"operationId": "PostWrite",
@@ -3032,13 +5216,40 @@
"path": "/api/v2/write",
"summary": "Write data",
"tags": [
- "Write"
+ "Write data"
]
}
],
- "tagDescription": "Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket).\n",
- "source": "static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-write.yaml",
- "staticFilePath": "/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-write.yaml"
+ "tagDescription": "Write time series data to [buckets](/influxdb/cloud/reference/glossary/).",
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write-data.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write-data.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/write"
+ ],
+ "title": "",
+ "description": "API reference for /write",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostLegacyWrite",
+ "method": "POST",
+ "path": "/write",
+ "summary": "Write time series data into InfluxDB in a V1-compatible format",
+ "tags": [
+ "Legacy Write"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write.yaml",
+ "staticFilePath": "/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write.yaml"
}
}
]
diff --git a/data/article_data/influxdb/cloud-v2/articles.yml b/data/article_data/influxdb/cloud-v2/articles.yml
index 3465541c9..c9a291a97 100644
--- a/data/article_data/influxdb/cloud-v2/articles.yml
+++ b/data/article_data/influxdb/cloud-v2/articles.yml
@@ -1,42 +1,1638 @@
articles:
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/authorizations
+ - /api/v2/authorizations/{authID}
+ title: ''
+ description: API reference for /api/v2/authorizations
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetAuthorizations
+ method: GET
+ path: /api/v2/authorizations
+ summary: List authorizations
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: PostAuthorizations
+ method: POST
+ path: /api/v2/authorizations
+ summary: Create an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: GetAuthorizationsID
+ method: GET
+ path: /api/v2/authorizations/{authID}
+ summary: Retrieve an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ externalDocs:
+ description: View tokens
+ url: >-
+ https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/
+ - operationId: PatchAuthorizationsID
+ method: PATCH
+ path: /api/v2/authorizations/{authID}
+ summary: Update an API token to be active or inactive
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: DeleteAuthorizationsID
+ method: DELETE
+ path: /api/v2/authorizations/{authID}
+ summary: Delete an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ related:
+ - >-
+ https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-authorizations.yaml
+ staticFilePath: >-
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-authorizations.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/buckets
+ - /api/v2/buckets/{bucketID}
+ - /api/v2/buckets/{bucketID}/labels
+ - /api/v2/buckets/{bucketID}/labels/{labelID}
+ - /api/v2/buckets/{bucketID}/members
+ - /api/v2/buckets/{bucketID}/members/{userID}
+ - /api/v2/buckets/{bucketID}/owners
+ - /api/v2/buckets/{bucketID}/owners/{userID}
+ - /api/v2/buckets/{bucketID}/schema/measurements
+ - /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
+ title: ''
+ description: API reference for /api/v2/buckets
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetBuckets
+ method: GET
+ path: /api/v2/buckets
+ summary: List buckets
+ tags:
+ - Buckets
+ - operationId: PostBuckets
+ method: POST
+ path: /api/v2/buckets
+ summary: Create a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsID
+ method: GET
+ path: /api/v2/buckets/{bucketID}
+ summary: Retrieve a bucket
+ tags:
+ - Buckets
+ - operationId: PatchBucketsID
+ method: PATCH
+ path: /api/v2/buckets/{bucketID}
+ summary: Update a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}
+ summary: Delete a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDLabels
+ method: GET
+ path: /api/v2/buckets/{bucketID}/labels
+ summary: List all labels for a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDLabels
+ method: POST
+ path: /api/v2/buckets/{bucketID}/labels
+ summary: Add a label to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDLabelsID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/labels/{labelID}
+ summary: Delete a label from a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDMembers
+ method: GET
+ path: /api/v2/buckets/{bucketID}/members
+ summary: List all users with member privileges for a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDMembers
+ method: POST
+ path: /api/v2/buckets/{bucketID}/members
+ summary: Add a member to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDMembersID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/members/{userID}
+ summary: Remove a member from a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDOwners
+ method: GET
+ path: /api/v2/buckets/{bucketID}/owners
+ summary: List all owners of a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDOwners
+ method: POST
+ path: /api/v2/buckets/{bucketID}/owners
+ summary: Add an owner to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDOwnersID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/owners/{userID}
+ summary: Remove an owner from a bucket
+ tags:
+ - Buckets
+ - operationId: getMeasurementSchemas
+ method: GET
+ path: /api/v2/buckets/{bucketID}/schema/measurements
+ summary: List measurement schemas of a bucket
+ tags:
+ - Bucket Schemas
+ - operationId: createMeasurementSchema
+ method: POST
+ path: /api/v2/buckets/{bucketID}/schema/measurements
+ summary: Create a measurement schema for a bucket
+ tags:
+ - Bucket Schemas
+ - operationId: getMeasurementSchema
+ method: GET
+ path: /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
+ summary: Retrieve a measurement schema
+ tags:
+ - Bucket Schemas
+ - operationId: updateMeasurementSchema
+ method: PATCH
+ path: /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
+ summary: Update a measurement schema
+ tags:
+ - Bucket Schemas
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-buckets.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/checks
+ - /api/v2/checks/{checkID}
+ - /api/v2/checks/{checkID}/labels
+ - /api/v2/checks/{checkID}/labels/{labelID}
+ - /api/v2/checks/{checkID}/query
+ title: ''
+ description: API reference for /api/v2/checks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetChecks
+ method: GET
+ path: /api/v2/checks
+ summary: List all checks
+ tags:
+ - Checks
+ - operationId: CreateCheck
+ method: POST
+ path: /api/v2/checks
+ summary: Add new check
+ tags:
+ - Checks
+ - operationId: GetChecksID
+ method: GET
+ path: /api/v2/checks/{checkID}
+ summary: Retrieve a check
+ tags:
+ - Checks
+ - operationId: PutChecksID
+ method: PUT
+ path: /api/v2/checks/{checkID}
+ summary: Update a check
+ tags:
+ - Checks
+ - operationId: PatchChecksID
+ method: PATCH
+ path: /api/v2/checks/{checkID}
+ summary: Update a check
+ tags:
+ - Checks
+ - operationId: DeleteChecksID
+ method: DELETE
+ path: /api/v2/checks/{checkID}
+ summary: Delete a check
+ tags:
+ - Checks
+ - operationId: GetChecksIDLabels
+ method: GET
+ path: /api/v2/checks/{checkID}/labels
+ summary: List all labels for a check
+ tags:
+ - Checks
+ - operationId: PostChecksIDLabels
+ method: POST
+ path: /api/v2/checks/{checkID}/labels
+ summary: Add a label to a check
+ tags:
+ - Checks
+ - operationId: DeleteChecksIDLabelsID
+ method: DELETE
+ path: /api/v2/checks/{checkID}/labels/{labelID}
+ summary: Delete label from a check
+ tags:
+ - Checks
+ - operationId: GetChecksIDQuery
+ method: GET
+ path: /api/v2/checks/{checkID}/query
+ summary: Retrieve a check query
+ tags:
+ - Checks
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-checks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/dashboards
+ - /api/v2/dashboards/{dashboardID}
+ - /api/v2/dashboards/{dashboardID}/cells
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ - /api/v2/dashboards/{dashboardID}/labels
+ - /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ - /api/v2/dashboards/{dashboardID}/members
+ - /api/v2/dashboards/{dashboardID}/members/{userID}
+ - /api/v2/dashboards/{dashboardID}/owners
+ - /api/v2/dashboards/{dashboardID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/dashboards
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDashboards
+ method: GET
+ path: /api/v2/dashboards
+ summary: List dashboards
+ tags:
+ - Dashboards
+ - operationId: PostDashboards
+ method: POST
+ path: /api/v2/dashboards
+ summary: Create a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsID
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Retrieve a dashboard
+ tags:
+ - Dashboards
+ - operationId: PatchDashboardsID
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Update a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Delete a dashboard
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDCells
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/cells
+ summary: Create a dashboard cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: PutDashboardsIDCells
+ method: PUT
+ path: /api/v2/dashboards/{dashboardID}/cells
+ summary: Replace cells in a dashboard
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: PatchDashboardsIDCellsID
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ summary: Update the non-positional information related to a cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: DeleteDashboardsIDCellsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ summary: Delete a dashboard cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: GetDashboardsIDCellsIDView
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ summary: Retrieve the view for a cell
+ tags:
+ - Cells
+ - Dashboards
+ - Views
+ - operationId: PatchDashboardsIDCellsIDView
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ summary: Update the view for a cell
+ tags:
+ - Cells
+ - Dashboards
+ - Views
+ - operationId: GetDashboardsIDLabels
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/labels
+ summary: List all labels for a dashboard
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDLabels
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/labels
+ summary: Add a label to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDLabelsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ summary: Delete a label from a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsIDMembers
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/members
+ summary: List all dashboard members
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDMembers
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/members
+ summary: Add a member to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDMembersID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/members/{userID}
+ summary: Remove a member from a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsIDOwners
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/owners
+ summary: List all dashboard owners
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDOwners
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/owners
+ summary: Add an owner to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDOwnersID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/owners/{userID}
+ summary: Remove an owner from a dashboard
+ tags:
+ - Dashboards
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dashboards.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/dbrps
+ - /api/v2/dbrps/{dbrpID}
+ title: ''
+ description: API reference for /api/v2/dbrps
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDBRPs
+ method: GET
+ path: /api/v2/dbrps
+ summary: List database retention policy mappings
+ tags:
+ - DBRPs
+ - operationId: PostDBRP
+ method: POST
+ path: /api/v2/dbrps
+ summary: Add a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: GetDBRPsID
+ method: GET
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Retrieve a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: PatchDBRPID
+ method: PATCH
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Update a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: DeleteDBRPID
+ method: DELETE
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Delete a database retention policy
+ tags:
+ - DBRPs
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-dbrps.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/delete
+ title: ''
+ description: API reference for /api/v2/delete
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostDelete
+ method: POST
+ path: /api/v2/delete
+ summary: Delete data
+ tags:
+ - Delete
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-delete.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/flags
+ title: ''
+ description: API reference for /api/v2/flags
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetFlags
+ method: GET
+ path: /api/v2/flags
+ summary: Retrieve feature flags
+ tags:
+ - Config
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-flags.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-flags.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/labels
+ - /api/v2/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/labels
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetLabels
+ method: GET
+ path: /api/v2/labels
+ summary: List all labels
+ tags:
+ - Labels
+ - operationId: PostLabels
+ method: POST
+ path: /api/v2/labels
+ summary: Create a label
+ tags:
+ - Labels
+ - operationId: GetLabelsID
+ method: GET
+ path: /api/v2/labels/{labelID}
+ summary: Retrieve a label
+ tags:
+ - Labels
+ - operationId: PatchLabelsID
+ method: PATCH
+ path: /api/v2/labels/{labelID}
+ summary: Update a label
+ tags:
+ - Labels
+ - operationId: DeleteLabelsID
+ method: DELETE
+ path: /api/v2/labels/{labelID}
+ summary: Delete a label
+ tags:
+ - Labels
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-labels.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/maps/mapToken
+ title: ''
+ description: API reference for /api/v2/maps
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: getMapboxToken
+ method: GET
+ path: /api/v2/maps/mapToken
+ summary: Get a mapbox token
+ tags: []
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-maps.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-maps.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/me
+ - /api/v2/me/password
+ title: ''
+ description: API reference for /api/v2/me
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetMe
+ method: GET
+ path: /api/v2/me
+ summary: Retrieve the currently authenticated user
+ tags:
+ - Users
+ - operationId: PutMePassword
+ method: PUT
+ path: /api/v2/me/password
+ summary: Update a password
+ tags:
+ - Users
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-me.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-me.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/notificationEndpoints
+ - /api/v2/notificationEndpoints/{endpointID}
+ - /api/v2/notificationEndpoints/{endpointID}/labels
+ - /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/notificationEndpoints
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetNotificationEndpoints
+ method: GET
+ path: /api/v2/notificationEndpoints
+ summary: List all notification endpoints
+ tags:
+ - NotificationEndpoints
+ - operationId: CreateNotificationEndpoint
+ method: POST
+ path: /api/v2/notificationEndpoints
+ summary: Add a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: GetNotificationEndpointsID
+ method: GET
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Retrieve a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PutNotificationEndpointsID
+ method: PUT
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Update a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PatchNotificationEndpointsID
+ method: PATCH
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Update a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: DeleteNotificationEndpointsID
+ method: DELETE
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Delete a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: GetNotificationEndpointsIDLabels
+ method: GET
+ path: /api/v2/notificationEndpoints/{endpointID}/labels
+ summary: List all labels for a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PostNotificationEndpointIDLabels
+ method: POST
+ path: /api/v2/notificationEndpoints/{endpointID}/labels
+ summary: Add a label to a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: DeleteNotificationEndpointsIDLabelsID
+ method: DELETE
+ path: /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ summary: Delete a label from a notification endpoint
+ tags:
+ - NotificationEndpoints
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationEndpoints.yaml
+ staticFilePath: >-
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationEndpoints.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/notificationRules
+ - /api/v2/notificationRules/{ruleID}
+ - /api/v2/notificationRules/{ruleID}/labels
+ - /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ - /api/v2/notificationRules/{ruleID}/query
+ title: ''
+ description: API reference for /api/v2/notificationRules
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetNotificationRules
+ method: GET
+ path: /api/v2/notificationRules
+ summary: List all notification rules
+ tags:
+ - NotificationRules
+ - operationId: CreateNotificationRule
+ method: POST
+ path: /api/v2/notificationRules
+ summary: Add a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesID
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Retrieve a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PutNotificationRulesID
+ method: PUT
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Update a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PatchNotificationRulesID
+ method: PATCH
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Update a notification rule
+ tags:
+ - NotificationRules
+ - operationId: DeleteNotificationRulesID
+ method: DELETE
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Delete a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesIDLabels
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}/labels
+ summary: List all labels for a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PostNotificationRuleIDLabels
+ method: POST
+ path: /api/v2/notificationRules/{ruleID}/labels
+ summary: Add a label to a notification rule
+ tags:
+ - NotificationRules
+ - operationId: DeleteNotificationRulesIDLabelsID
+ method: DELETE
+ path: /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ summary: Delete label from a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesIDQuery
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}/query
+ summary: Retrieve a notification rule query
+ tags:
+ - Rules
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationRules.yaml
+ staticFilePath: >-
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-notificationRules.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/orgs
+ - /api/v2/orgs/{orgID}
+ - /api/v2/orgs/{orgID}/limits
+ - /api/v2/orgs/{orgID}/members
+ - /api/v2/orgs/{orgID}/members/{userID}
+ - /api/v2/orgs/{orgID}/owners
+ - /api/v2/orgs/{orgID}/owners/{userID}
+ - /api/v2/orgs/{orgID}/secrets
+ - /api/v2/orgs/{orgID}/secrets/delete
+ - /api/v2/orgs/{orgID}/secrets/{secretID}
+ - /api/v2/orgs/{orgID}/usage
+ title: ''
+ description: API reference for /api/v2/orgs
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetOrgs
+ method: GET
+ path: /api/v2/orgs
+ summary: List organizations
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgs
+ method: POST
+ path: /api/v2/orgs
+ summary: Create an organization
+ tags:
+ - Organizations
+ - operationId: GetOrgsID
+ method: GET
+ path: /api/v2/orgs/{orgID}
+ summary: Retrieve an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PatchOrgsID
+ method: PATCH
+ path: /api/v2/orgs/{orgID}
+ summary: Update an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}
+ summary: Delete an organization
+ tags:
+ - Organizations
+ - operationId: GetOrgLimitsID
+ method: GET
+ path: /api/v2/orgs/{orgID}/limits
+ summary: Retrieve limits for an organization
+ tags:
+ - Limits
+ - operationId: GetOrgsIDMembers
+ method: GET
+ path: /api/v2/orgs/{orgID}/members
+ summary: List all members of an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgsIDMembers
+ method: POST
+ path: /api/v2/orgs/{orgID}/members
+ summary: Add a member to an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsIDMembersID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/members/{userID}
+ summary: Remove a member from an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: GetOrgsIDOwners
+ method: GET
+ path: /api/v2/orgs/{orgID}/owners
+ summary: List all owners of an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgsIDOwners
+ method: POST
+ path: /api/v2/orgs/{orgID}/owners
+ summary: Add an owner to an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsIDOwnersID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/owners/{userID}
+ summary: Remove an owner from an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: GetOrgsIDSecrets
+ method: GET
+ path: /api/v2/orgs/{orgID}/secrets
+ summary: List all secret keys for an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ - operationId: PatchOrgsIDSecrets
+ method: PATCH
+ path: /api/v2/orgs/{orgID}/secrets
+ summary: Update secrets in an organization
+ tags:
+ - Secrets
+ - operationId: PostOrgsIDSecrets
+ method: POST
+ path: /api/v2/orgs/{orgID}/secrets/delete
+ summary: Delete secrets from an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ - operationId: DeleteOrgsIDSecretsID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/secrets/{secretID}
+ summary: Delete a secret from an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ - operationId: GetOrgUsageID
+ method: GET
+ path: /api/v2/orgs/{orgID}/usage
+ summary: Retrieve usage for an organization
+ tags:
+ - Usage
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-orgs.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-orgs.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/query
+ - /api/v2/query/analyze
+ - /api/v2/query/ast
+ - /api/v2/query/suggestions
+ - /api/v2/query/suggestions/{name}
+ title: ''
+ description: API reference for /api/v2/query
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostQuery
+ method: POST
+ path: /api/v2/query
+ summary: Query data
+ tags:
+ - Query data
+ - operationId: PostQueryAnalyze
+ method: POST
+ path: /api/v2/query/analyze
+ summary: Analyze a Flux query
+ tags:
+ - Query data
+ - operationId: PostQueryAst
+ method: POST
+ path: /api/v2/query/ast
+ summary: Generate a query Abstract Syntax Tree (AST)
+ tags:
+ - Query data
+ - operationId: GetQuerySuggestions
+ method: GET
+ path: /api/v2/query/suggestions
+ summary: List Flux query suggestions
+ tags:
+ - Query data
+ - operationId: GetQuerySuggestionsName
+ method: GET
+ path: /api/v2/query/suggestions/{name}
+ summary: Retrieve a query suggestion for a branching suggestion
+ tags:
+ - Query data
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-query.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-query.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/resources
+ title: ''
+ description: API reference for /api/v2/resources
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetResources
+ method: GET
+ path: /api/v2/resources
+ summary: List all known resources
+ tags:
+ - Resources
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-resources.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/scripts
+ - /api/v2/scripts/{scriptID}
+ - /api/v2/scripts/{scriptID}/invoke
+ - /api/v2/scripts/{scriptID}/params
+ title: ''
+ description: API reference for /api/v2/scripts
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetScripts
+ method: GET
+ path: /api/v2/scripts
+ summary: List scripts
+ tags:
+ - Invokable Scripts
+ - operationId: PostScripts
+ method: POST
+ path: /api/v2/scripts
+ summary: Create a script
+ tags:
+ - Invokable Scripts
+ - operationId: GetScriptsID
+ method: GET
+ path: /api/v2/scripts/{scriptID}
+ summary: Retrieve a script
+ tags:
+ - Invokable Scripts
+ - operationId: PatchScriptsID
+ method: PATCH
+ path: /api/v2/scripts/{scriptID}
+ summary: Update a script
+ tags:
+ - Invokable Scripts
+ - operationId: DeleteScriptsID
+ method: DELETE
+ path: /api/v2/scripts/{scriptID}
+ summary: Delete a script
+ tags:
+ - Invokable Scripts
+ - operationId: PostScriptsIDInvoke
+ method: POST
+ path: /api/v2/scripts/{scriptID}/invoke
+ summary: Invoke a script
+ tags:
+ - Invokable Scripts
+ - operationId: GetScriptsIDParams
+ method: GET
+ path: /api/v2/scripts/{scriptID}/params
+ summary: Find script parameters.
+ tags:
+ - Invokable Scripts
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-scripts.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-scripts.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/setup
+ - /api/v2/setup/user
+ title: ''
+ description: API reference for /api/v2/setup
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetSetup
+ method: GET
+ path: /api/v2/setup
+ summary: Retrieve setup status
+ tags:
+ - Setup
+ - operationId: PostSetup
+ method: POST
+ path: /api/v2/setup
+ summary: Create an initial user, organization, and bucket
+ tags:
+ - Setup
+ - operationId: PostSetupUser
+ method: POST
+ path: /api/v2/setup/user
+ summary: Create a new user, organization, and bucket
+ tags:
+ - Setup
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-setup.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/signin
+ title: ''
+ description: API reference for /api/v2/signin
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostSignin
+ method: POST
+ path: /api/v2/signin
+ summary: Create a user session.
+ tags:
+ - Security and access endpoints
+ - Signin
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signin.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/signout
+ title: ''
+ description: API reference for /api/v2/signout
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostSignout
+ method: POST
+ path: /api/v2/signout
+ summary: Expire a user session
+ tags:
+ - Security and access endpoints
+ - Signout
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-signout.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/stacks
+ - /api/v2/stacks/{stack_id}
+ - /api/v2/stacks/{stack_id}/uninstall
+ title: ''
+ description: API reference for /api/v2/stacks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: ListStacks
+ method: GET
+ path: /api/v2/stacks
+ summary: List installed stacks
+ tags:
+ - Templates
+ - operationId: CreateStack
+ method: POST
+ path: /api/v2/stacks
+ summary: Create a stack
+ tags:
+ - Templates
+ - operationId: ReadStack
+ method: GET
+ path: /api/v2/stacks/{stack_id}
+ summary: Retrieve a stack
+ tags:
+ - Templates
+ - operationId: UpdateStack
+ method: PATCH
+ path: /api/v2/stacks/{stack_id}
+ summary: Update a stack
+ tags:
+ - Templates
+ - operationId: DeleteStack
+ method: DELETE
+ path: /api/v2/stacks/{stack_id}
+ summary: Delete a stack and associated resources
+ tags:
+ - Templates
+ - operationId: UninstallStack
+ method: POST
+ path: /api/v2/stacks/{stack_id}/uninstall
+ summary: Uninstall a stack
+ tags:
+ - Templates
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-stacks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-stacks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/tasks
+ - /api/v2/tasks/{taskID}
+ - /api/v2/tasks/{taskID}/labels
+ - /api/v2/tasks/{taskID}/labels/{labelID}
+ - /api/v2/tasks/{taskID}/logs
+ - /api/v2/tasks/{taskID}/members
+ - /api/v2/tasks/{taskID}/members/{userID}
+ - /api/v2/tasks/{taskID}/owners
+ - /api/v2/tasks/{taskID}/owners/{userID}
+ - /api/v2/tasks/{taskID}/runs
+ - /api/v2/tasks/{taskID}/runs/{runID}
+ - /api/v2/tasks/{taskID}/runs/{runID}/logs
+ - /api/v2/tasks/{taskID}/runs/{runID}/retry
+ title: ''
+ description: API reference for /api/v2/tasks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTasks
+ method: GET
+ path: /api/v2/tasks
+ summary: List all tasks
+ tags:
+ - Tasks
+ - operationId: PostTasks
+ method: POST
+ path: /api/v2/tasks
+ summary: Create a task
+ tags:
+ - Tasks
+ - operationId: GetTasksID
+ method: GET
+ path: /api/v2/tasks/{taskID}
+ summary: Retrieve a task
+ tags:
+ - Tasks
+ - operationId: PatchTasksID
+ method: PATCH
+ path: /api/v2/tasks/{taskID}
+ summary: Update a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}
+ summary: Delete a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDLabels
+ method: GET
+ path: /api/v2/tasks/{taskID}/labels
+ summary: List labels for a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDLabels
+ method: POST
+ path: /api/v2/tasks/{taskID}/labels
+ summary: Add a label to a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDLabelsID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/labels/{labelID}
+ summary: Delete a label from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDLogs
+ method: GET
+ path: /api/v2/tasks/{taskID}/logs
+ summary: Retrieve all logs for a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDMembers
+ method: GET
+ path: /api/v2/tasks/{taskID}/members
+ summary: List all task members
+ tags:
+ - Tasks
+ - operationId: PostTasksIDMembers
+ method: POST
+ path: /api/v2/tasks/{taskID}/members
+ summary: Add a member to a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDMembersID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/members/{userID}
+ summary: Remove a member from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDOwners
+ method: GET
+ path: /api/v2/tasks/{taskID}/owners
+ summary: List all owners of a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDOwners
+ method: POST
+ path: /api/v2/tasks/{taskID}/owners
+ summary: Add an owner for a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDOwnersID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/owners/{userID}
+ summary: Remove an owner from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRuns
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs
+ summary: List runs for a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDRuns
+ method: POST
+ path: /api/v2/tasks/{taskID}/runs
+ summary: Start a task run, overriding the schedule
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRunsID
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs/{runID}
+ summary: Retrieve a run for a task.
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDRunsID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/runs/{runID}
+ summary: Cancel a running task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRunsIDLogs
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs/{runID}/logs
+ summary: Retrieve all logs for a run
+ tags:
+ - Tasks
+ - operationId: PostTasksIDRunsIDRetry
+ method: POST
+ path: /api/v2/tasks/{taskID}/runs/{runID}/retry
+ summary: Retry a task run
+ tags:
+ - Tasks
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-tasks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/telegraf/plugins
+ title: ''
+ description: API reference for /api/v2/telegraf
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTelegrafPlugins
+ method: GET
+ path: /api/v2/telegraf/plugins
+ summary: List all Telegraf plugins
+ tags:
+ - Telegraf Plugins
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegraf.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegraf.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/telegrafs
+ - /api/v2/telegrafs/{telegrafID}
+ - /api/v2/telegrafs/{telegrafID}/labels
+ - /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ - /api/v2/telegrafs/{telegrafID}/members
+ - /api/v2/telegrafs/{telegrafID}/members/{userID}
+ - /api/v2/telegrafs/{telegrafID}/owners
+ - /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/telegrafs
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTelegrafs
+ method: GET
+ path: /api/v2/telegrafs
+ summary: List all Telegraf configurations
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafs
+ method: POST
+ path: /api/v2/telegrafs
+ summary: Create a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsID
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Retrieve a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: PutTelegrafsID
+ method: PUT
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Update a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Delete a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDLabels
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/labels
+ summary: List all labels for a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDLabels
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/labels
+ summary: Add a label to a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDLabelsID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ summary: Delete a label from a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDMembers
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/members
+ summary: List all users with member privileges for a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDMembers
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/members
+ summary: Add a member to a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDMembersID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/members/{userID}
+ summary: Remove a member from a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDOwners
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/owners
+ summary: List all owners of a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDOwners
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/owners
+ summary: Add an owner to a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDOwnersID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ summary: Remove an owner from a Telegraf config
+ tags:
+ - Telegrafs
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-telegrafs.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/templates/apply
+ - /api/v2/templates/export
+ title: ''
+ description: API reference for /api/v2/templates
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: ApplyTemplate
+ method: POST
+ path: /api/v2/templates/apply
+ summary: Apply or dry-run a template
+ tags:
+ - Templates
+ - operationId: ExportTemplate
+ method: POST
+ path: /api/v2/templates/export
+ summary: Export a new template
+ tags:
+ - Templates
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-templates.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/users
+ - /api/v2/users/{userID}
+ - /api/v2/users/{userID}/password
+ title: ''
+ description: API reference for /api/v2/users
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetUsers
+ method: GET
+ path: /api/v2/users
+ summary: List users
+ tags:
+ - Security and access endpoints
+ - Users
+ - operationId: PostUsers
+ method: POST
+ path: /api/v2/users
+ summary: Create a user
+ tags:
+ - Users
+ - operationId: GetUsersID
+ method: GET
+ path: /api/v2/users/{userID}
+ summary: Retrieve a user
+ tags:
+ - Users
+ - operationId: PatchUsersID
+ method: PATCH
+ path: /api/v2/users/{userID}
+ summary: Update a user
+ tags:
+ - Users
+ - operationId: DeleteUsersID
+ method: DELETE
+ path: /api/v2/users/{userID}
+ summary: Delete a user
+ tags:
+ - Users
+ - operationId: PostUsersIDPassword
+ method: POST
+ path: /api/v2/users/{userID}/password
+ summary: Update a password
+ tags:
+ - Security and access endpoints
+ - Users
+ - operationId: PutUsersIDPassword
+ method: PUT
+ path: /api/v2/users/{userID}/password
+ summary: Update a password
+ tags:
+ - Security and access endpoints
+ - Users
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-users.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-users.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/variables
+ - /api/v2/variables/{variableID}
+ - /api/v2/variables/{variableID}/labels
+ - /api/v2/variables/{variableID}/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/variables
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetVariables
+ method: GET
+ path: /api/v2/variables
+ summary: List all variables
+ tags:
+ - Variables
+ - operationId: PostVariables
+ method: POST
+ path: /api/v2/variables
+ summary: Create a variable
+ tags:
+ - Variables
+ - operationId: GetVariablesID
+ method: GET
+ path: /api/v2/variables/{variableID}
+ summary: Retrieve a variable
+ tags:
+ - Variables
+ - operationId: PutVariablesID
+ method: PUT
+ path: /api/v2/variables/{variableID}
+ summary: Replace a variable
+ tags:
+ - Variables
+ - operationId: PatchVariablesID
+ method: PATCH
+ path: /api/v2/variables/{variableID}
+ summary: Update a variable
+ tags:
+ - Variables
+ - operationId: DeleteVariablesID
+ method: DELETE
+ path: /api/v2/variables/{variableID}
+ summary: Delete a variable
+ tags:
+ - Variables
+ - operationId: GetVariablesIDLabels
+ method: GET
+ path: /api/v2/variables/{variableID}/labels
+ summary: List all labels for a variable
+ tags:
+ - Variables
+ - operationId: PostVariablesIDLabels
+ method: POST
+ path: /api/v2/variables/{variableID}/labels
+ summary: Add a label to a variable
+ tags:
+ - Variables
+ - operationId: DeleteVariablesIDLabelsID
+ method: DELETE
+ path: /api/v2/variables/{variableID}/labels/{labelID}
+ summary: Delete a label from a variable
+ tags:
+ - Variables
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-variables.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/write
+ title: ''
+ description: API reference for /api/v2/write
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostWrite
+ method: POST
+ path: /api/v2/write
+ summary: Write data
+ tags:
+ - Write data
+ source: >-
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-write.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2-write.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2
+ title: ''
+ description: API reference for /api/v2
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetRoutes
+ method: GET
+ path: /api/v2
+ summary: List all top level routes
+ tags:
+ - Routes
+ - System information endpoints
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-api-v2.yaml
- path: api/authentication
fields:
name: Authentication
describes: []
title: Authentication
- description: >
+ description: |-
Use one of the following schemes to authenticate to the InfluxDB API:
-
- - [Token authentication](#section/Authentication/TokenAuthentication)
-
- - [Basic authentication](#section/Authentication/BasicAuthentication)
-
- - [Querystring
- authentication](#section/Authentication/QuerystringAuthentication)
-
-
+ - Token authentication
+ - Basic authentication
+ - Querystring authentication
tag: Authentication
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: |-
Use one of the following schemes to authenticate to the InfluxDB API:
-
- - [Token authentication](#section/Authentication/TokenAuthentication)
-
- - [Basic authentication](#section/Authentication/BasicAuthentication)
-
- - [Querystring
- authentication](#section/Authentication/QuerystringAuthentication)
-
-
+ - Token authentication
+ - Basic authentication
+ - Querystring authentication
showSecuritySchemes: true
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authentication.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authentication.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authentication.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authentication.yaml
- path: api/authorizations-api-tokens
fields:
name: Authorizations (API tokens)
@@ -44,7 +1640,7 @@ articles:
- /api/v2/authorizations
- /api/v2/authorizations/{authID}
title: Authorizations (API tokens)
- description: >
+ description: >-
Create and manage authorizations (API tokens).
@@ -80,23 +1676,21 @@ articles:
For more information, see [how to assign a token to a specific
user](/influxdb/cloud/security/tokens/create-token/).
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related endpoints
- - [Signin](#tag/Signin)
+ - Signin
- - [Signout](#tag/Signout)
+ - Signout
### Related guides
- - [Authorize API
- requests](/influxdb/cloud/api-guide/api_intro/#authentication)
+ - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/)
- [Manage API tokens](/influxdb/cloud/security/tokens/)
@@ -140,7 +1734,7 @@ articles:
summary: Delete an authorization
tags:
- Authorizations (API tokens)
- tagDescription: >
+ tagDescription: >-
Create and manage authorizations (API tokens).
@@ -176,23 +1770,21 @@ articles:
For more information, see [how to assign a token to a specific
user](/influxdb/cloud/security/tokens/create-token/).
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related endpoints
- - [Signin](#tag/Signin)
+ - Signin
- - [Signout](#tag/Signout)
+ - Signout
### Related guides
- - [Authorize API
- requests](/influxdb/cloud/api-guide/api_intro/#authentication)
+ - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/)
- [Manage API tokens](/influxdb/cloud/security/tokens/)
@@ -202,9 +1794,9 @@ articles:
- >-
https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-authorizations-api-tokens.yaml
- path: api/bucket-schemas
fields:
name: Bucket Schemas
@@ -242,9 +1834,8 @@ articles:
tags:
- Bucket Schemas
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-bucket-schemas.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-bucket-schemas.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-bucket-schemas.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-bucket-schemas.yaml
- path: api/buckets
fields:
name: Buckets
@@ -258,15 +1849,14 @@ articles:
- /api/v2/buckets/{bucketID}/owners
- /api/v2/buckets/{bucketID}/owners/{userID}
title: Buckets
- description: >
+ description: >-
Store your data in InfluxDB
- [buckets](/influxdb/cloud/reference/glossary/#bucket).
+ [buckets](/influxdb/cloud/reference/glossary/).
A bucket is a named location where time series data is stored. All
buckets
- have a [retention
- period](/influxdb/cloud/reference/glossary/#retention-period),
+ have a [retention period](/influxdb/cloud/reference/glossary/),
a duration of time that each data point persists. InfluxDB drops all
@@ -367,15 +1957,14 @@ articles:
summary: Remove an owner from a bucket
tags:
- Buckets
- tagDescription: >
+ tagDescription: >-
Store your data in InfluxDB
- [buckets](/influxdb/cloud/reference/glossary/#bucket).
+ [buckets](/influxdb/cloud/reference/glossary/).
A bucket is a named location where time series data is stored. All
buckets
- have a [retention
- period](/influxdb/cloud/reference/glossary/#retention-period),
+ have a [retention period](/influxdb/cloud/reference/glossary/),
a duration of time that each data point persists. InfluxDB drops all
@@ -388,9 +1977,8 @@ articles:
- [Manage buckets](/influxdb/cloud/organizations/buckets/)
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-buckets.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-buckets.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-buckets.yaml
- path: api/cells
fields:
name: Cells
@@ -440,8 +2028,8 @@ articles:
summary: Update the view for a cell
tags:
- Cells
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-cells.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-cells.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-cells.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-cells.yaml
- path: api/checks
fields:
name: Checks
@@ -517,14 +2105,14 @@ articles:
summary: Retrieve a check query
tags:
- Checks
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-checks.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-checks.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-checks.yaml
- path: api/common-parameters
fields:
name: Common parameters
describes: []
title: Common parameters
- description: >
+ description: >-
To specify resources, some InfluxDB API endpoints require parameters or
properties in the request--for example,
@@ -559,7 +2147,7 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
+ tagDescription: >-
To specify resources, some InfluxDB API endpoints require parameters or
properties in the request--for example,
@@ -591,9 +2179,8 @@ articles:
| `orgID` | 16-byte string | The organization ID
([find your organization](/influxdb/cloud/organizations/view-orgs/). |
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-common-parameters.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-common-parameters.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-common-parameters.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-common-parameters.yaml
- path: api/config
fields:
name: Config
@@ -611,8 +2198,8 @@ articles:
summary: Retrieve feature flags
tags:
- Config
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-config.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-config.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-config.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-config.yaml
- path: api/dashboards
fields:
name: Dashboards
@@ -754,92 +2341,8 @@ articles:
summary: Remove an owner from a dashboard
tags:
- Dashboards
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dashboards.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dashboards.yaml
- - path: api/data-i-o-endpoints
- fields:
- name: Data I/O endpoints
- describes:
- - /api/v2/delete
- - /api/v2/query
- - /api/v2/scripts
- - /api/v2/scripts/{scriptID}
- - /api/v2/scripts/{scriptID}/invoke
- - /api/v2/tasks
- - /api/v2/tasks/{taskID}
- - /api/v2/tasks/{taskID}/runs
- - /api/v2/write
- title: Data I/O endpoints
- description: API reference for Data I/O endpoints
- tag: Data I/O endpoints
- isConceptual: false
- menuGroup: Other
- operations:
- - operationId: PostDelete
- method: POST
- path: /api/v2/delete
- summary: Delete data
- tags:
- - Data I/O endpoints
- - operationId: PostQuery
- method: POST
- path: /api/v2/query
- summary: Query data
- tags:
- - Data I/O endpoints
- - operationId: GetScripts
- method: GET
- path: /api/v2/scripts
- summary: List scripts
- tags:
- - Data I/O endpoints
- - operationId: GetScriptsID
- method: GET
- path: /api/v2/scripts/{scriptID}
- summary: Retrieve a script
- tags:
- - Data I/O endpoints
- - operationId: PostScriptsIDInvoke
- method: POST
- path: /api/v2/scripts/{scriptID}/invoke
- summary: Invoke a script
- tags:
- - Data I/O endpoints
- - operationId: GetTasks
- method: GET
- path: /api/v2/tasks
- summary: List all tasks
- tags:
- - Data I/O endpoints
- - operationId: PostTasks
- method: POST
- path: /api/v2/tasks
- summary: Create a task
- tags:
- - Data I/O endpoints
- - operationId: GetTasksID
- method: GET
- path: /api/v2/tasks/{taskID}
- summary: Retrieve a task
- tags:
- - Data I/O endpoints
- - operationId: PostTasksIDRuns
- method: POST
- path: /api/v2/tasks/{taskID}/runs
- summary: Start a task run, overriding the schedule
- tags:
- - Data I/O endpoints
- - operationId: PostWrite
- method: POST
- path: /api/v2/write
- summary: Write data
- tags:
- - Data I/O endpoints
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-data-i-o-endpoints.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-data-i-o-endpoints.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dashboards.yaml
- path: api/dbrps
fields:
name: DBRPs
@@ -847,12 +2350,11 @@ articles:
- /api/v2/dbrps
- /api/v2/dbrps/{dbrpID}
title: DBRPs
- description: >
+ description: >-
The InfluxDB 1.x data model includes
- [databases](/influxdb/cloud/reference/glossary/#database)
+ [databases](/influxdb/cloud/reference/glossary/)
- and [retention
- policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).
+ and [retention policies](/influxdb/cloud/reference/glossary/).
InfluxDB 2.x replaces databases and retention policies with buckets.
@@ -907,12 +2409,11 @@ articles:
summary: Delete a database retention policy
tags:
- DBRPs
- tagDescription: >
+ tagDescription: >-
The InfluxDB 1.x data model includes
- [databases](/influxdb/cloud/reference/glossary/#database)
+ [databases](/influxdb/cloud/reference/glossary/)
- and [retention
- policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).
+ and [retention policies](/influxdb/cloud/reference/glossary/).
InfluxDB 2.x replaces databases and retention policies with buckets.
@@ -933,16 +2434,15 @@ articles:
- [Database and retention policy
mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dbrps.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-dbrps.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-dbrps.yaml
- path: api/delete
fields:
name: Delete
describes:
- /api/v2/delete
title: Delete
- description: |
- Delete data from an InfluxDB bucket.
+ description: Delete data from an InfluxDB bucket.
tag: Delete
isConceptual: false
menuGroup: Other
@@ -953,16 +2453,15 @@ articles:
summary: Delete data
tags:
- Delete
- tagDescription: |
- Delete data from an InfluxDB bucket.
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-delete.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-delete.yaml
+ tagDescription: Delete data from an InfluxDB bucket.
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-delete.yaml
- path: api/headers
fields:
name: Headers
describes: []
title: Headers
- description: >
+ description: >-
InfluxDB HTTP API endpoints use standard HTTP request and response
headers.
@@ -998,7 +2497,7 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
+ tagDescription: >-
InfluxDB HTTP API endpoints use standard HTTP request and response
headers.
@@ -1030,9 +2529,8 @@ articles:
| `Content-Type` | string | The format of the
data in the request body. |
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-headers.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-headers.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-headers.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-headers.yaml
- path: api/invokable-scripts
fields:
name: Invokable Scripts
@@ -1042,7 +2540,7 @@ articles:
- /api/v2/scripts/{scriptID}/invoke
- /api/v2/scripts/{scriptID}/params
title: Invokable Scripts
- description: >
+ description: >-
Store, manage, and execute scripts in InfluxDB.
A script stores your custom Flux script and provides an invokable
@@ -1055,8 +2553,7 @@ articles:
Once you create a script, InfluxDB generates an
- [`/api/v2/scripts/SCRIPT_ID/invoke`
- endpoint](#operation/PostScriptsIDInvoke)
+ `/api/v2/scripts/SCRIPT_ID/invoke` endpoint
for your organization.
@@ -1083,7 +2580,7 @@ articles:
requests.
- [Create a task that references a
- script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script)
+ script](/influxdb/cloud/process-data/manage-tasks/create-task/)
tag: Invokable Scripts
isConceptual: false
menuGroup: Other
@@ -1130,7 +2627,7 @@ articles:
summary: Find script parameters.
tags:
- Invokable Scripts
- tagDescription: >
+ tagDescription: >-
Store, manage, and execute scripts in InfluxDB.
A script stores your custom Flux script and provides an invokable
@@ -1143,8 +2640,7 @@ articles:
Once you create a script, InfluxDB generates an
- [`/api/v2/scripts/SCRIPT_ID/invoke`
- endpoint](#operation/PostScriptsIDInvoke)
+ `/api/v2/scripts/SCRIPT_ID/invoke` endpoint
for your organization.
@@ -1171,11 +2667,10 @@ articles:
requests.
- [Create a task that references a
- script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script)
+ script](/influxdb/cloud/process-data/manage-tasks/create-task/)
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-invokable-scripts.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-invokable-scripts.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-invokable-scripts.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-invokable-scripts.yaml
- path: api/labels
fields:
name: Labels
@@ -1218,8 +2713,8 @@ articles:
summary: Delete a label
tags:
- Labels
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-labels.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-labels.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-labels.yaml
- path: api/legacy-authorizations
fields:
name: Legacy Authorizations
@@ -1270,9 +2765,9 @@ articles:
tags:
- Legacy Authorizations
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-authorizations.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-authorizations.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-authorizations.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-authorizations.yaml
- path: api/legacy-query
fields:
name: Legacy Query
@@ -1291,8 +2786,8 @@ articles:
tags:
- Legacy Query
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-query.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-query.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-query.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-query.yaml
- path: api/legacy-write
fields:
name: Legacy Write
@@ -1311,8 +2806,8 @@ articles:
tags:
- Legacy Write
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-write.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-legacy-write.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-write.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-legacy-write.yaml
- path: api/limits
fields:
name: Limits
@@ -1330,8 +2825,8 @@ articles:
summary: Retrieve limits for an organization
tags:
- Limits
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-limits.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-limits.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-limits.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-limits.yaml
- path: api/notificationendpoints
fields:
name: NotificationEndpoints
@@ -1401,9 +2896,9 @@ articles:
tags:
- NotificationEndpoints
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationendpoints.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationendpoints.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationendpoints.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationendpoints.yaml
- path: api/notificationrules
fields:
name: NotificationRules
@@ -1473,9 +2968,8 @@ articles:
tags:
- NotificationRules
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationrules.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-notificationrules.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationrules.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-notificationrules.yaml
- path: api/organizations
fields:
name: Organizations
@@ -1487,9 +2981,8 @@ articles:
- /api/v2/orgs/{orgID}/owners
- /api/v2/orgs/{orgID}/owners/{userID}
title: Organizations
- description: >
- Manage your
- [organization](/influxdb/cloud/reference/glossary/#organization).
+ description: >-
+ Manage your [organization](/influxdb/cloud/reference/glossary/).
An organization is a workspace for a group of users. Organizations can
be
@@ -1570,9 +3063,8 @@ articles:
summary: Remove an owner from an organization
tags:
- Organizations
- tagDescription: >
- Manage your
- [organization](/influxdb/cloud/reference/glossary/#organization).
+ tagDescription: >-
+ Manage your [organization](/influxdb/cloud/reference/glossary/).
An organization is a workspace for a group of users. Organizations can
be
@@ -1584,17 +3076,16 @@ articles:
Use the `/api/v2/orgs` endpoints to view and manage organizations.
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-organizations.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-organizations.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-organizations.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-organizations.yaml
- path: api/pagination
fields:
name: Pagination
describes: []
title: Pagination
- description: >
- Some InfluxDB API [list operations](#tag/SupportedOperations) may
- support the following query parameters for paginating results:
+ description: >-
+ Some InfluxDB API list operations may support the following query
+ parameters for paginating results:
| Query parameter | Value type | Description |
|:------------------------ |:--------------------- |:-------------------------------------------|
@@ -1632,9 +3123,9 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
- Some InfluxDB API [list operations](#tag/SupportedOperations) may
- support the following query parameters for paginating results:
+ tagDescription: >-
+ Some InfluxDB API list operations may support the following query
+ parameters for paginating results:
| Query parameter | Value type | Description |
|:------------------------ |:--------------------- |:-------------------------------------------|
@@ -1668,9 +3159,8 @@ articles:
"buckets": []
}
```
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-pagination.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-pagination.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-pagination.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-pagination.yaml
- path: api/ping
fields:
name: Ping
@@ -1694,64 +3184,81 @@ articles:
summary: Get the status of the instance
tags:
- Ping
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-ping.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-ping.yaml
- - path: api/query
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-ping.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-ping.yaml
+ - path: api/query-data
fields:
- name: Query
+ name: Query data
describes:
- /api/v2/query
- /api/v2/query/analyze
- /api/v2/query/ast
- /api/v2/query/suggestions
- /api/v2/query/suggestions/{name}
- title: Query
- description: |
- Retrieve data, analyze queries, and get query suggestions.
- tag: Query
+ title: Query data
+ description: Retrieve data, analyze queries, and get query suggestions.
+ tag: Query data
isConceptual: false
- menuGroup: Other
+ menuGroup: Data Operations
operations:
- operationId: PostQuery
method: POST
path: /api/v2/query
summary: Query data
tags:
- - Query
+ - Query data
- operationId: PostQueryAnalyze
method: POST
path: /api/v2/query/analyze
summary: Analyze a Flux query
tags:
- - Query
+ - Query data
- operationId: PostQueryAst
method: POST
path: /api/v2/query/ast
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- - Query
+ - Query data
- operationId: GetQuerySuggestions
method: GET
path: /api/v2/query/suggestions
summary: List Flux query suggestions
tags:
- - Query
+ - Query data
- operationId: GetQuerySuggestionsName
method: GET
path: /api/v2/query/suggestions/{name}
summary: Retrieve a query suggestion for a branching suggestion
tags:
- - Query
- tagDescription: |
- Retrieve data, analyze queries, and get query suggestions.
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-query.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-query.yaml
+ - Query data
+ tagDescription: Retrieve data, analyze queries, and get query suggestions.
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query-data.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query-data.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /query
+ title: ''
+ description: API reference for /query
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetLegacyQuery
+ method: GET
+ path: /query
+ summary: Query with the 1.x compatibility API
+ tags:
+ - Legacy Query
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-query.yaml
- path: api/quick-start
fields:
name: Quick start
describes: []
title: Quick start
- description: >
+ description: >-
See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets,
@@ -1767,7 +3274,7 @@ articles:
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: >-
See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets,
@@ -1779,9 +3286,8 @@ articles:
are available for popular languages and ready to import into your
application.
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-quick-start.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-quick-start.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-quick-start.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-quick-start.yaml
- path: api/resources
fields:
name: Resources
@@ -1799,15 +3305,14 @@ articles:
summary: List all known resources
tags:
- Resources
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-resources.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-resources.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-resources.yaml
- path: api/response-codes
fields:
name: Response codes
describes: []
title: Response codes
- description: >
+ description: >-
InfluxDB HTTP API endpoints use standard HTTP status codes for success
and failure responses.
@@ -1840,7 +3345,7 @@ articles:
points written and the number of points rejected are also included. For
more information, check the `rejected_points` measurement in your
[_monitoring
- bucket](/influxdb/cloud/reference/internals/system-buckets/#_monitoring-system-bucket).`Authorization`
+ bucket](/influxdb/cloud/reference/internals/system-buckets/).`Authorization`
header is missing or malformed or the API token doesn't have permission
for the operation. |
@@ -1879,7 +3384,7 @@ articles:
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: >-
InfluxDB HTTP API endpoints use standard HTTP status codes for success
and failure responses.
@@ -1912,7 +3417,7 @@ articles:
points written and the number of points rejected are also included. For
more information, check the `rejected_points` measurement in your
[_monitoring
- bucket](/influxdb/cloud/reference/internals/system-buckets/#_monitoring-system-bucket).`Authorization`
+ bucket](/influxdb/cloud/reference/internals/system-buckets/).`Authorization`
header is missing or malformed or the API token doesn't have permission
for the operation. |
@@ -1948,9 +3453,8 @@ articles:
unavailable to process the request. The `Retry-After` header describes
when to try the request again. |
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-response-codes.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-response-codes.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-response-codes.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-response-codes.yaml
- path: api/routes
fields:
name: Routes
@@ -1968,8 +3472,8 @@ articles:
summary: List all top level routes
tags:
- Routes
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-routes.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-routes.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-routes.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-routes.yaml
- path: api/rules
fields:
name: Rules
@@ -1987,8 +3491,8 @@ articles:
summary: Retrieve a notification rule query
tags:
- Rules
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-rules.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-rules.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-rules.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-rules.yaml
- path: api/secrets
fields:
name: Secrets
@@ -2026,9 +3530,8 @@ articles:
summary: Delete secrets from an organization
tags:
- Secrets
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-secrets.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-secrets.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-secrets.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-secrets.yaml
- path: api/security-and-access-endpoints
fields:
name: Security and access endpoints
@@ -2176,9 +3679,9 @@ articles:
- >-
https://docs.influxdata.com/influxdb/cloud/security/tokens/view-tokens/
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-security-and-access-endpoints.yaml
- path: api/setup
fields:
name: Setup
@@ -2209,8 +3712,8 @@ articles:
summary: Create a new user, organization, and bucket
tags:
- Setup
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-setup.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-setup.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-setup.yaml
- path: api/signin
fields:
name: Signin
@@ -2228,8 +3731,8 @@ articles:
summary: Create a user session.
tags:
- Signin
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signin.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signin.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signin.yaml
- path: api/signout
fields:
name: Signout
@@ -2247,24 +3750,23 @@ articles:
summary: Expire a user session
tags:
- Signout
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signout.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-signout.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-signout.yaml
- path: api/supported-operations
fields:
name: Supported operations
describes: []
title: Supported operations
- description: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n"
+ description: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |"
tag: Supported operations
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n"
+ tagDescription: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |"
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-supported-operations.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-supported-operations.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-supported-operations.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-supported-operations.yaml
- path: api/system-information-endpoints
fields:
name: System information endpoints
@@ -2297,9 +3799,9 @@ articles:
tags:
- System information endpoints
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-system-information-endpoints.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-system-information-endpoints.yaml
staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-system-information-endpoints.yaml
+ /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-system-information-endpoints.yaml
- path: api/tasks
fields:
name: Tasks
@@ -2318,9 +3820,9 @@ articles:
- /api/v2/tasks/{taskID}/runs/{runID}/logs
- /api/v2/tasks/{taskID}/runs/{runID}/retry
title: Tasks
- description: >
+ description: >-
Process and analyze your data with
- [tasks](/influxdb/cloud/reference/glossary/#task)
+ [tasks](/influxdb/cloud/reference/glossary/)
in the InfluxDB task engine.
@@ -2331,8 +3833,8 @@ articles:
To configure a task, provide the script and the schedule to run the
task.
- For examples, see how to create a task with the [`POST /api/v2/tasks`
- endpoint](#operation/PostTasks).
+ For examples, see how to create a task with the `POST /api/v2/tasks`
+ endpoint.
@@ -2358,8 +3860,7 @@ articles:
- [Common data processing
tasks](/influxdb/cloud/process-data/common-tasks/)
- - [Create a
- script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script)
+ - [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/)
tag: Tasks
isConceptual: false
menuGroup: Other
@@ -2490,9 +3991,9 @@ articles:
summary: Retry a task run
tags:
- Tasks
- tagDescription: >
+ tagDescription: >-
Process and analyze your data with
- [tasks](/influxdb/cloud/reference/glossary/#task)
+ [tasks](/influxdb/cloud/reference/glossary/)
in the InfluxDB task engine.
@@ -2503,8 +4004,8 @@ articles:
To configure a task, provide the script and the schedule to run the
task.
- For examples, see how to create a task with the [`POST /api/v2/tasks`
- endpoint](#operation/PostTasks).
+ For examples, see how to create a task with the `POST /api/v2/tasks`
+ endpoint.
@@ -2530,10 +4031,9 @@ articles:
- [Common data processing
tasks](/influxdb/cloud/process-data/common-tasks/)
- - [Create a
- script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script)
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-tasks.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-tasks.yaml
+ - [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/)
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-tasks.yaml
- path: api/telegraf-plugins
fields:
name: Telegraf Plugins
@@ -2552,9 +4052,8 @@ articles:
tags:
- Telegraf Plugins
source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegraf-plugins.yaml
- staticFilePath: >-
- /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegraf-plugins.yaml
+ static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegraf-plugins.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegraf-plugins.yaml
- path: api/telegrafs
fields:
name: Telegrafs
@@ -2657,9 +4156,8 @@ articles:
summary: Remove an owner from a Telegraf config
tags:
- Telegrafs
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegrafs.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-telegrafs.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-telegrafs.yaml
- path: api/templates
fields:
name: Templates
@@ -2670,7 +4168,7 @@ articles:
- /api/v2/templates/apply
- /api/v2/templates/export
title: Templates
- description: >
+ description: >-
Export and apply InfluxDB **templates**.
Manage **stacks** of templated InfluxDB resources.
@@ -2761,7 +4259,7 @@ articles:
summary: Export a new template
tags:
- Templates
- tagDescription: >
+ tagDescription: >-
Export and apply InfluxDB **templates**.
Manage **stacks** of templated InfluxDB resources.
@@ -2800,9 +4298,8 @@ articles:
- [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/)
- [InfluxDB templates](/influxdb/cloud/influxdb-templates/)
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-templates.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-templates.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-templates.yaml
- path: api/usage
fields:
name: Usage
@@ -2820,8 +4317,8 @@ articles:
summary: Retrieve usage for an organization
tags:
- Usage
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-usage.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-usage.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-usage.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-usage.yaml
- path: api/users
fields:
name: Users
@@ -2832,7 +4329,7 @@ articles:
- /api/v2/users/{userID}
- /api/v2/users/{userID}/password
title: Users
- description: >
+ description: >-
Retrieve specific users.
@@ -2863,8 +4360,7 @@ articles:
the session carries the permissions granted by all the user's
authorizations.
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related guides
@@ -2929,7 +4425,7 @@ articles:
summary: Update a password
tags:
- Users
- tagDescription: >
+ tagDescription: >-
Retrieve specific users.
@@ -2960,16 +4456,15 @@ articles:
the session carries the permissions granted by all the user's
authorizations.
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related guides
- [Manage users](/influxdb/cloud/organizations/users/)
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-users.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-users.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-users.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-users.yaml
- path: api/variables
fields:
name: Variables
@@ -3038,9 +4533,8 @@ articles:
summary: Delete a label from a variable
tags:
- Variables
- source: >-
- static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-variables.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-variables.yaml
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-variables.yaml
- path: api/views
fields:
name: Views
@@ -3064,29 +4558,48 @@ articles:
summary: Update the view for a cell
tags:
- Views
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-views.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-views.yaml
- - path: api/write
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-views.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-views.yaml
+ - path: api/write-data
fields:
- name: Write
+ name: Write data
describes:
- /api/v2/write
- title: Write
- description: >
+ title: Write data
+ description: >-
Write time series data to
- [buckets](/influxdb/cloud/reference/glossary/#bucket).
- tag: Write
+ [buckets](/influxdb/cloud/reference/glossary/).
+ tag: Write data
isConceptual: false
- menuGroup: Other
+ menuGroup: Data Operations
operations:
- operationId: PostWrite
method: POST
path: /api/v2/write
summary: Write data
tags:
- - Write
- tagDescription: >
+ - Write data
+ tagDescription: >-
Write time series data to
- [buckets](/influxdb/cloud/reference/glossary/#bucket).
- source: static/openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-write.yaml
- staticFilePath: /openapi/influxdb-cloud-v2/tags/tags/influxdb-cloud-v2-write.yaml
+ [buckets](/influxdb/cloud/reference/glossary/).
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write-data.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write-data.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /write
+ title: ''
+ description: API reference for /write
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostLegacyWrite
+ method: POST
+ path: /write
+ summary: Write time series data into InfluxDB in a V1-compatible format
+ tags:
+ - Legacy Write
+ source: static/openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write.yaml
+ staticFilePath: /openapi/influxdb-cloud-v2/tags/influxdb-cloud-v2-write.yaml
diff --git a/data/article_data/influxdb/oss-v2/articles.json b/data/article_data/influxdb/oss-v2/articles.json
index 528778021..13b0f5cd1 100644
--- a/data/article_data/influxdb/oss-v2/articles.json
+++ b/data/article_data/influxdb/oss-v2/articles.json
@@ -1,20 +1,2658 @@
{
"articles": [
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/authorizations",
+ "/api/v2/authorizations/{authID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/authorizations",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetAuthorizations",
+ "method": "GET",
+ "path": "/api/v2/authorizations",
+ "summary": "List authorizations",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostAuthorizations",
+ "method": "POST",
+ "path": "/api/v2/authorizations",
+ "summary": "Create an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetAuthorizationsID",
+ "method": "GET",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Retrieve an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ],
+ "externalDocs": {
+ "description": "View tokens",
+ "url": "https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/"
+ }
+ },
+ {
+ "operationId": "PatchAuthorizationsID",
+ "method": "PATCH",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Update an API token to be active or inactive",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteAuthorizationsID",
+ "method": "DELETE",
+ "path": "/api/v2/authorizations/{authID}",
+ "summary": "Delete an authorization",
+ "tags": [
+ "Authorizations (API tokens)",
+ "Security and access endpoints"
+ ]
+ }
+ ],
+ "related": [
+ "https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/"
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-authorizations.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-authorizations.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/backup/kv",
+ "/api/v2/backup/metadata",
+ "/api/v2/backup/shards/{shardID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/backup",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetBackupKV",
+ "method": "GET",
+ "path": "/api/v2/backup/kv",
+ "summary": "Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x.",
+ "tags": [
+ "Backup"
+ ]
+ },
+ {
+ "operationId": "GetBackupMetadata",
+ "method": "GET",
+ "path": "/api/v2/backup/metadata",
+ "summary": "Download snapshot of all metadata in the server",
+ "tags": [
+ "Backup"
+ ]
+ },
+ {
+ "operationId": "GetBackupShardId",
+ "method": "GET",
+ "path": "/api/v2/backup/shards/{shardID}",
+ "summary": "Download snapshot of all TSM data in a shard",
+ "tags": [
+ "Backup"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-backup.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-backup.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/buckets",
+ "/api/v2/buckets/{bucketID}",
+ "/api/v2/buckets/{bucketID}/labels",
+ "/api/v2/buckets/{bucketID}/labels/{labelID}",
+ "/api/v2/buckets/{bucketID}/members",
+ "/api/v2/buckets/{bucketID}/members/{userID}",
+ "/api/v2/buckets/{bucketID}/owners",
+ "/api/v2/buckets/{bucketID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/buckets",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetBuckets",
+ "method": "GET",
+ "path": "/api/v2/buckets",
+ "summary": "List buckets",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBuckets",
+ "method": "POST",
+ "path": "/api/v2/buckets",
+ "summary": "Create a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsID",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Retrieve a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PatchBucketsID",
+ "method": "PATCH",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Update a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}",
+ "summary": "Delete a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/labels",
+ "summary": "List all labels for a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/labels",
+ "summary": "Add a label to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/labels/{labelID}",
+ "summary": "Delete a label from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/members",
+ "summary": "List all users with member privileges for a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/members",
+ "summary": "Add a member to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/members/{userID}",
+ "summary": "Remove a member from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetBucketsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/buckets/{bucketID}/owners",
+ "summary": "List all owners of a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "PostBucketsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/buckets/{bucketID}/owners",
+ "summary": "Add an owner to a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "DeleteBucketsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/buckets/{bucketID}/owners/{userID}",
+ "summary": "Remove an owner from a bucket",
+ "tags": [
+ "Buckets"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-buckets.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-buckets.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/checks",
+ "/api/v2/checks/{checkID}",
+ "/api/v2/checks/{checkID}/labels",
+ "/api/v2/checks/{checkID}/labels/{labelID}",
+ "/api/v2/checks/{checkID}/query"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/checks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetChecks",
+ "method": "GET",
+ "path": "/api/v2/checks",
+ "summary": "List all checks",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "CreateCheck",
+ "method": "POST",
+ "path": "/api/v2/checks",
+ "summary": "Add new check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksID",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Retrieve a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PutChecksID",
+ "method": "PUT",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Update a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PatchChecksID",
+ "method": "PATCH",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Update a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "DeleteChecksID",
+ "method": "DELETE",
+ "path": "/api/v2/checks/{checkID}",
+ "summary": "Delete a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksIDLabels",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}/labels",
+ "summary": "List all labels for a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "PostChecksIDLabels",
+ "method": "POST",
+ "path": "/api/v2/checks/{checkID}/labels",
+ "summary": "Add a label to a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "DeleteChecksIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/checks/{checkID}/labels/{labelID}",
+ "summary": "Delete label from a check",
+ "tags": [
+ "Checks"
+ ]
+ },
+ {
+ "operationId": "GetChecksIDQuery",
+ "method": "GET",
+ "path": "/api/v2/checks/{checkID}/query",
+ "summary": "Retrieve a check query",
+ "tags": [
+ "Checks"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-checks.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-checks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/config"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/config",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetConfig",
+ "method": "GET",
+ "path": "/api/v2/config",
+ "summary": "Retrieve runtime configuration",
+ "tags": [
+ "Config",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-config.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-config.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/dashboards",
+ "/api/v2/dashboards/{dashboardID}",
+ "/api/v2/dashboards/{dashboardID}/cells",
+ "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "/api/v2/dashboards/{dashboardID}/labels",
+ "/api/v2/dashboards/{dashboardID}/labels/{labelID}",
+ "/api/v2/dashboards/{dashboardID}/members",
+ "/api/v2/dashboards/{dashboardID}/members/{userID}",
+ "/api/v2/dashboards/{dashboardID}/owners",
+ "/api/v2/dashboards/{dashboardID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/dashboards",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDashboards",
+ "method": "GET",
+ "path": "/api/v2/dashboards",
+ "summary": "List dashboards",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboards",
+ "method": "POST",
+ "path": "/api/v2/dashboards",
+ "summary": "Create a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsID",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Retrieve a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsID",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Update a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}",
+ "summary": "Delete a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDCells",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/cells",
+ "summary": "Create a dashboard cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PutDashboardsIDCells",
+ "method": "PUT",
+ "path": "/api/v2/dashboards/{dashboardID}/cells",
+ "summary": "Replace cells in a dashboard",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsIDCellsID",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "summary": "Update the non-positional information related to a cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDCellsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}",
+ "summary": "Delete a dashboard cell",
+ "tags": [
+ "Cells",
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDCellsIDView",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "summary": "Retrieve the view for a cell",
+ "tags": [
+ "Cells",
+ "Dashboards",
+ "Views"
+ ]
+ },
+ {
+ "operationId": "PatchDashboardsIDCellsIDView",
+ "method": "PATCH",
+ "path": "/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
+ "summary": "Update the view for a cell",
+ "tags": [
+ "Cells",
+ "Dashboards",
+ "Views"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/labels",
+ "summary": "List all labels for a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/labels",
+ "summary": "Add a label to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/labels/{labelID}",
+ "summary": "Delete a label from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/members",
+ "summary": "List all dashboard members",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/members",
+ "summary": "Add a member to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/members/{userID}",
+ "summary": "Remove a member from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "GetDashboardsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/dashboards/{dashboardID}/owners",
+ "summary": "List all dashboard owners",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "PostDashboardsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/dashboards/{dashboardID}/owners",
+ "summary": "Add an owner to a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ },
+ {
+ "operationId": "DeleteDashboardsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/dashboards/{dashboardID}/owners/{userID}",
+ "summary": "Remove an owner from a dashboard",
+ "tags": [
+ "Dashboards"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dashboards.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dashboards.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/dbrps",
+ "/api/v2/dbrps/{dbrpID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/dbrps",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDBRPs",
+ "method": "GET",
+ "path": "/api/v2/dbrps",
+ "summary": "List database retention policy mappings",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "PostDBRP",
+ "method": "POST",
+ "path": "/api/v2/dbrps",
+ "summary": "Add a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "GetDBRPsID",
+ "method": "GET",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Retrieve a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "PatchDBRPID",
+ "method": "PATCH",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Update a database retention policy mapping",
+ "tags": [
+ "DBRPs"
+ ]
+ },
+ {
+ "operationId": "DeleteDBRPID",
+ "method": "DELETE",
+ "path": "/api/v2/dbrps/{dbrpID}",
+ "summary": "Delete a database retention policy",
+ "tags": [
+ "DBRPs"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dbrps.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dbrps.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/delete"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/delete",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostDelete",
+ "method": "POST",
+ "path": "/api/v2/delete",
+ "summary": "Delete data",
+ "tags": [
+ "Delete"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-delete.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-delete.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/flags"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/flags",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetFlags",
+ "method": "GET",
+ "path": "/api/v2/flags",
+ "summary": "Retrieve feature flags",
+ "tags": [
+ "Config"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-flags.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-flags.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/labels",
+ "/api/v2/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/labels",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetLabels",
+ "method": "GET",
+ "path": "/api/v2/labels",
+ "summary": "List all labels",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "PostLabels",
+ "method": "POST",
+ "path": "/api/v2/labels",
+ "summary": "Create a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "GetLabelsID",
+ "method": "GET",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Retrieve a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "PatchLabelsID",
+ "method": "PATCH",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Update a label",
+ "tags": [
+ "Labels"
+ ]
+ },
+ {
+ "operationId": "DeleteLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/labels/{labelID}",
+ "summary": "Delete a label",
+ "tags": [
+ "Labels"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-labels.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-labels.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/maps/mapToken"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/maps",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "getMapboxToken",
+ "method": "GET",
+ "path": "/api/v2/maps/mapToken",
+ "summary": "Get a mapbox token",
+ "tags": []
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-maps.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-maps.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/me",
+ "/api/v2/me/password"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/me",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetMe",
+ "method": "GET",
+ "path": "/api/v2/me",
+ "summary": "Retrieve the currently authenticated user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PutMePassword",
+ "method": "PUT",
+ "path": "/api/v2/me/password",
+ "summary": "Update a password",
+ "tags": [
+ "Users"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-me.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-me.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/notificationEndpoints",
+ "/api/v2/notificationEndpoints/{endpointID}",
+ "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/notificationEndpoints",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetNotificationEndpoints",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints",
+ "summary": "List all notification endpoints",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "CreateNotificationEndpoint",
+ "method": "POST",
+ "path": "/api/v2/notificationEndpoints",
+ "summary": "Add a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "GetNotificationEndpointsID",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Retrieve a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PutNotificationEndpointsID",
+ "method": "PUT",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Update a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PatchNotificationEndpointsID",
+ "method": "PATCH",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Update a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationEndpointsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationEndpoints/{endpointID}",
+ "summary": "Delete a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "GetNotificationEndpointsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "summary": "List all labels for a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "PostNotificationEndpointIDLabels",
+ "method": "POST",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels",
+ "summary": "Add a label to a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationEndpointsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}",
+ "summary": "Delete a label from a notification endpoint",
+ "tags": [
+ "NotificationEndpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationEndpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationEndpoints.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/notificationRules",
+ "/api/v2/notificationRules/{ruleID}",
+ "/api/v2/notificationRules/{ruleID}/labels",
+ "/api/v2/notificationRules/{ruleID}/labels/{labelID}",
+ "/api/v2/notificationRules/{ruleID}/query"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/notificationRules",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetNotificationRules",
+ "method": "GET",
+ "path": "/api/v2/notificationRules",
+ "summary": "List all notification rules",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "CreateNotificationRule",
+ "method": "POST",
+ "path": "/api/v2/notificationRules",
+ "summary": "Add a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesID",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Retrieve a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PutNotificationRulesID",
+ "method": "PUT",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Update a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PatchNotificationRulesID",
+ "method": "PATCH",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Update a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationRulesID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationRules/{ruleID}",
+ "summary": "Delete a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesIDLabels",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}/labels",
+ "summary": "List all labels for a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "PostNotificationRuleIDLabels",
+ "method": "POST",
+ "path": "/api/v2/notificationRules/{ruleID}/labels",
+ "summary": "Add a label to a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "DeleteNotificationRulesIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/notificationRules/{ruleID}/labels/{labelID}",
+ "summary": "Delete label from a notification rule",
+ "tags": [
+ "NotificationRules"
+ ]
+ },
+ {
+ "operationId": "GetNotificationRulesIDQuery",
+ "method": "GET",
+ "path": "/api/v2/notificationRules/{ruleID}/query",
+ "summary": "Retrieve a notification rule query",
+ "tags": [
+ "Rules"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationRules.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationRules.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/orgs",
+ "/api/v2/orgs/{orgID}",
+ "/api/v2/orgs/{orgID}/members",
+ "/api/v2/orgs/{orgID}/members/{userID}",
+ "/api/v2/orgs/{orgID}/owners",
+ "/api/v2/orgs/{orgID}/owners/{userID}",
+ "/api/v2/orgs/{orgID}/secrets",
+ "/api/v2/orgs/{orgID}/secrets/delete",
+ "/api/v2/orgs/{orgID}/secrets/{secretID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/orgs",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetOrgs",
+ "method": "GET",
+ "path": "/api/v2/orgs",
+ "summary": "List organizations",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgs",
+ "method": "POST",
+ "path": "/api/v2/orgs",
+ "summary": "Create an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "GetOrgsID",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Retrieve an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PatchOrgsID",
+ "method": "PATCH",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Update an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}",
+ "summary": "Delete an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/members",
+ "summary": "List all members of an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/members",
+ "summary": "Add a member to an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/members/{userID}",
+ "summary": "Remove a member from an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/owners",
+ "summary": "List all owners of an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/owners",
+ "summary": "Add an owner to an organization",
+ "tags": [
+ "Organizations"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/owners/{userID}",
+ "summary": "Remove an owner from an organization",
+ "tags": [
+ "Organizations",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "GetOrgsIDSecrets",
+ "method": "GET",
+ "path": "/api/v2/orgs/{orgID}/secrets",
+ "summary": "List all secret keys for an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "PatchOrgsIDSecrets",
+ "method": "PATCH",
+ "path": "/api/v2/orgs/{orgID}/secrets",
+ "summary": "Update secrets in an organization",
+ "tags": [
+ "Secrets"
+ ]
+ },
+ {
+ "operationId": "PostOrgsIDSecrets",
+ "method": "POST",
+ "path": "/api/v2/orgs/{orgID}/secrets/delete",
+ "summary": "Delete secrets from an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ },
+ {
+ "operationId": "DeleteOrgsIDSecretsID",
+ "method": "DELETE",
+ "path": "/api/v2/orgs/{orgID}/secrets/{secretID}",
+ "summary": "Delete a secret from an organization",
+ "tags": [
+ "Secrets",
+ "Security and access endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-orgs.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-orgs.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/query",
+ "/api/v2/query/analyze",
+ "/api/v2/query/ast",
+ "/api/v2/query/suggestions",
+ "/api/v2/query/suggestions/{name}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/query",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostQuery",
+ "method": "POST",
+ "path": "/api/v2/query",
+ "summary": "Query data",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "PostQueryAnalyze",
+ "method": "POST",
+ "path": "/api/v2/query/analyze",
+ "summary": "Analyze a Flux query",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "PostQueryAst",
+ "method": "POST",
+ "path": "/api/v2/query/ast",
+ "summary": "Generate a query Abstract Syntax Tree (AST)",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "GetQuerySuggestions",
+ "method": "GET",
+ "path": "/api/v2/query/suggestions",
+ "summary": "List Flux query suggestions",
+ "tags": [
+ "Query data"
+ ]
+ },
+ {
+ "operationId": "GetQuerySuggestionsName",
+ "method": "GET",
+ "path": "/api/v2/query/suggestions/{name}",
+ "summary": "Retrieve a query suggestion for a branching suggestion",
+ "tags": [
+ "Query data"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-query.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-query.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/remotes",
+ "/api/v2/remotes/{remoteID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/remotes",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetRemoteConnections",
+ "method": "GET",
+ "path": "/api/v2/remotes",
+ "summary": "List all remote connections",
+ "tags": [
+ "RemoteConnections"
+ ]
+ },
+ {
+ "operationId": "PostRemoteConnection",
+ "method": "POST",
+ "path": "/api/v2/remotes",
+ "summary": "Register a new remote connection",
+ "tags": [
+ "RemoteConnections"
+ ]
+ },
+ {
+ "operationId": "GetRemoteConnectionByID",
+ "method": "GET",
+ "path": "/api/v2/remotes/{remoteID}",
+ "summary": "Retrieve a remote connection",
+ "tags": [
+ "RemoteConnections"
+ ]
+ },
+ {
+ "operationId": "PatchRemoteConnectionByID",
+ "method": "PATCH",
+ "path": "/api/v2/remotes/{remoteID}",
+ "summary": "Update a remote connection",
+ "tags": [
+ "RemoteConnections"
+ ]
+ },
+ {
+ "operationId": "DeleteRemoteConnectionByID",
+ "method": "DELETE",
+ "path": "/api/v2/remotes/{remoteID}",
+ "summary": "Delete a remote connection",
+ "tags": [
+ "RemoteConnections"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-remotes.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-remotes.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/replications",
+ "/api/v2/replications/{replicationID}",
+ "/api/v2/replications/{replicationID}/validate"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/replications",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetReplications",
+ "method": "GET",
+ "path": "/api/v2/replications",
+ "summary": "List all replications",
+ "tags": [
+ "Replications"
+ ]
+ },
+ {
+ "operationId": "PostReplication",
+ "method": "POST",
+ "path": "/api/v2/replications",
+ "summary": "Register a new replication",
+ "tags": [
+ "Replications"
+ ]
+ },
+ {
+ "operationId": "GetReplicationByID",
+ "method": "GET",
+ "path": "/api/v2/replications/{replicationID}",
+ "summary": "Retrieve a replication",
+ "tags": [
+ "Replications"
+ ]
+ },
+ {
+ "operationId": "PatchReplicationByID",
+ "method": "PATCH",
+ "path": "/api/v2/replications/{replicationID}",
+ "summary": "Update a replication",
+ "tags": [
+ "Replications"
+ ]
+ },
+ {
+ "operationId": "DeleteReplicationByID",
+ "method": "DELETE",
+ "path": "/api/v2/replications/{replicationID}",
+ "summary": "Delete a replication",
+ "tags": [
+ "Replications"
+ ]
+ },
+ {
+ "operationId": "PostValidateReplicationByID",
+ "method": "POST",
+ "path": "/api/v2/replications/{replicationID}/validate",
+ "summary": "Validate a replication",
+ "tags": [
+ "Replications"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-replications.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-replications.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/resources"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/resources",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetResources",
+ "method": "GET",
+ "path": "/api/v2/resources",
+ "summary": "List all known resources",
+ "tags": [
+ "Resources",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-resources.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-resources.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/restore/bucket/{bucketID}",
+ "/api/v2/restore/bucketMetadata",
+ "/api/v2/restore/kv",
+ "/api/v2/restore/shards/{shardID}",
+ "/api/v2/restore/sql"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/restore",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostRestoreBucketID",
+ "method": "POST",
+ "path": "/api/v2/restore/bucket/{bucketID}",
+ "summary": "Overwrite storage metadata for a bucket with shard info from a backup.",
+ "tags": [
+ "Restore"
+ ]
+ },
+ {
+ "operationId": "PostRestoreBucketMetadata",
+ "method": "POST",
+ "path": "/api/v2/restore/bucketMetadata",
+ "summary": "Create a new bucket pre-seeded with shard info from a backup.",
+ "tags": [
+ "Restore"
+ ]
+ },
+ {
+ "operationId": "PostRestoreKV",
+ "method": "POST",
+ "path": "/api/v2/restore/kv",
+ "summary": "Overwrite the embedded KV store on the server with a backed-up snapshot.",
+ "tags": [
+ "Restore"
+ ]
+ },
+ {
+ "operationId": "PostRestoreShardId",
+ "method": "POST",
+ "path": "/api/v2/restore/shards/{shardID}",
+ "summary": "Restore a TSM snapshot into a shard.",
+ "tags": [
+ "Restore"
+ ]
+ },
+ {
+ "operationId": "PostRestoreSQL",
+ "method": "POST",
+ "path": "/api/v2/restore/sql",
+ "summary": "Overwrite the embedded SQL store on the server with a backed-up snapshot.",
+ "tags": [
+ "Restore"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-restore.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-restore.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/scrapers",
+ "/api/v2/scrapers/{scraperTargetID}",
+ "/api/v2/scrapers/{scraperTargetID}/labels",
+ "/api/v2/scrapers/{scraperTargetID}/labels/{labelID}",
+ "/api/v2/scrapers/{scraperTargetID}/members",
+ "/api/v2/scrapers/{scraperTargetID}/members/{userID}",
+ "/api/v2/scrapers/{scraperTargetID}/owners",
+ "/api/v2/scrapers/{scraperTargetID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/scrapers",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetScrapers",
+ "method": "GET",
+ "path": "/api/v2/scrapers",
+ "summary": "List all scraper targets",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "PostScrapers",
+ "method": "POST",
+ "path": "/api/v2/scrapers",
+ "summary": "Create a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "GetScrapersID",
+ "method": "GET",
+ "path": "/api/v2/scrapers/{scraperTargetID}",
+ "summary": "Retrieve a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "PatchScrapersID",
+ "method": "PATCH",
+ "path": "/api/v2/scrapers/{scraperTargetID}",
+ "summary": "Update a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "DeleteScrapersID",
+ "method": "DELETE",
+ "path": "/api/v2/scrapers/{scraperTargetID}",
+ "summary": "Delete a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "GetScrapersIDLabels",
+ "method": "GET",
+ "path": "/api/v2/scrapers/{scraperTargetID}/labels",
+ "summary": "List all labels for a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "PostScrapersIDLabels",
+ "method": "POST",
+ "path": "/api/v2/scrapers/{scraperTargetID}/labels",
+ "summary": "Add a label to a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "DeleteScrapersIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/scrapers/{scraperTargetID}/labels/{labelID}",
+ "summary": "Delete a label from a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "GetScrapersIDMembers",
+ "method": "GET",
+ "path": "/api/v2/scrapers/{scraperTargetID}/members",
+ "summary": "List all users with member privileges for a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "PostScrapersIDMembers",
+ "method": "POST",
+ "path": "/api/v2/scrapers/{scraperTargetID}/members",
+ "summary": "Add a member to a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "DeleteScrapersIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/scrapers/{scraperTargetID}/members/{userID}",
+ "summary": "Remove a member from a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "GetScrapersIDOwners",
+ "method": "GET",
+ "path": "/api/v2/scrapers/{scraperTargetID}/owners",
+ "summary": "List all owners of a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "PostScrapersIDOwners",
+ "method": "POST",
+ "path": "/api/v2/scrapers/{scraperTargetID}/owners",
+ "summary": "Add an owner to a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ },
+ {
+ "operationId": "DeleteScrapersIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/scrapers/{scraperTargetID}/owners/{userID}",
+ "summary": "Remove an owner from a scraper target",
+ "tags": [
+ "Scraper Targets"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-scrapers.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-scrapers.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/setup"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/setup",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetSetup",
+ "method": "GET",
+ "path": "/api/v2/setup",
+ "summary": "Check if database has default user, org, bucket",
+ "tags": [
+ "Setup"
+ ]
+ },
+ {
+ "operationId": "PostSetup",
+ "method": "POST",
+ "path": "/api/v2/setup",
+ "summary": "Set up initial user, org and bucket",
+ "tags": [
+ "Setup"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-setup.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-setup.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/signin"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/signin",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostSignin",
+ "method": "POST",
+ "path": "/api/v2/signin",
+ "summary": "Create a user session.",
+ "tags": [
+ "Security and access endpoints",
+ "Signin"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signin.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signin.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/signout"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/signout",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostSignout",
+ "method": "POST",
+ "path": "/api/v2/signout",
+ "summary": "Expire a user session",
+ "tags": [
+ "Security and access endpoints",
+ "Signout"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signout.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signout.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/sources",
+ "/api/v2/sources/{sourceID}",
+ "/api/v2/sources/{sourceID}/buckets",
+ "/api/v2/sources/{sourceID}/health"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/sources",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetSources",
+ "method": "GET",
+ "path": "/api/v2/sources",
+ "summary": "List all sources",
+ "tags": [
+ "Sources"
+ ]
+ },
+ {
+ "operationId": "PostSources",
+ "method": "POST",
+ "path": "/api/v2/sources",
+ "summary": "Create a source",
+ "tags": [
+ "Sources"
+ ]
+ },
+ {
+ "operationId": "GetSourcesID",
+ "method": "GET",
+ "path": "/api/v2/sources/{sourceID}",
+ "summary": "Retrieve a source",
+ "tags": [
+ "Sources"
+ ]
+ },
+ {
+ "operationId": "PatchSourcesID",
+ "method": "PATCH",
+ "path": "/api/v2/sources/{sourceID}",
+ "summary": "Update a Source",
+ "tags": [
+ "Sources"
+ ]
+ },
+ {
+ "operationId": "DeleteSourcesID",
+ "method": "DELETE",
+ "path": "/api/v2/sources/{sourceID}",
+ "summary": "Delete a source",
+ "tags": [
+ "Sources"
+ ]
+ },
+ {
+ "operationId": "GetSourcesIDBuckets",
+ "method": "GET",
+ "path": "/api/v2/sources/{sourceID}/buckets",
+ "summary": "Get buckets in a source",
+ "tags": [
+ "Sources",
+ "Buckets"
+ ]
+ },
+ {
+ "operationId": "GetSourcesIDHealth",
+ "method": "GET",
+ "path": "/api/v2/sources/{sourceID}/health",
+ "summary": "Get the health of a source",
+ "tags": [
+ "Sources"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-sources.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-sources.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/stacks",
+ "/api/v2/stacks/{stack_id}",
+ "/api/v2/stacks/{stack_id}/uninstall"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/stacks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "ListStacks",
+ "method": "GET",
+ "path": "/api/v2/stacks",
+ "summary": "List installed stacks",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "CreateStack",
+ "method": "POST",
+ "path": "/api/v2/stacks",
+ "summary": "Create a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "ReadStack",
+ "method": "GET",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Retrieve a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "UpdateStack",
+ "method": "PATCH",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Update a stack",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "DeleteStack",
+ "method": "DELETE",
+ "path": "/api/v2/stacks/{stack_id}",
+ "summary": "Delete a stack and associated resources",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "UninstallStack",
+ "method": "POST",
+ "path": "/api/v2/stacks/{stack_id}/uninstall",
+ "summary": "Uninstall a stack",
+ "tags": [
+ "Templates"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-stacks.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-stacks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/tasks",
+ "/api/v2/tasks/{taskID}",
+ "/api/v2/tasks/{taskID}/labels",
+ "/api/v2/tasks/{taskID}/labels/{labelID}",
+ "/api/v2/tasks/{taskID}/logs",
+ "/api/v2/tasks/{taskID}/members",
+ "/api/v2/tasks/{taskID}/members/{userID}",
+ "/api/v2/tasks/{taskID}/owners",
+ "/api/v2/tasks/{taskID}/owners/{userID}",
+ "/api/v2/tasks/{taskID}/runs",
+ "/api/v2/tasks/{taskID}/runs/{runID}",
+ "/api/v2/tasks/{taskID}/runs/{runID}/logs",
+ "/api/v2/tasks/{taskID}/runs/{runID}/retry"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/tasks",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTasks",
+ "method": "GET",
+ "path": "/api/v2/tasks",
+ "summary": "List tasks",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasks",
+ "method": "POST",
+ "path": "/api/v2/tasks",
+ "summary": "Create a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksID",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Retrieve a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PatchTasksID",
+ "method": "PATCH",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Update a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}",
+ "summary": "Delete a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDLabels",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/labels",
+ "summary": "List labels for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDLabels",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/labels",
+ "summary": "Add a label to a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/labels/{labelID}",
+ "summary": "Delete a label from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDLogs",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/logs",
+ "summary": "Retrieve all logs for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDMembers",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/members",
+ "summary": "List all task members",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDMembers",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/members",
+ "summary": "Add a member to a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/members/{userID}",
+ "summary": "Remove a member from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDOwners",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/owners",
+ "summary": "List all owners of a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDOwners",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/owners",
+ "summary": "Add an owner for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/owners/{userID}",
+ "summary": "Remove an owner from a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRuns",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs",
+ "summary": "List runs for a task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDRuns",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/runs",
+ "summary": "Start a task run, overriding the schedule",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRunsID",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}",
+ "summary": "Retrieve a run for a task.",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "DeleteTasksIDRunsID",
+ "method": "DELETE",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}",
+ "summary": "Cancel a running task",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "GetTasksIDRunsIDLogs",
+ "method": "GET",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}/logs",
+ "summary": "Retrieve all logs for a run",
+ "tags": [
+ "Tasks"
+ ]
+ },
+ {
+ "operationId": "PostTasksIDRunsIDRetry",
+ "method": "POST",
+ "path": "/api/v2/tasks/{taskID}/runs/{runID}/retry",
+ "summary": "Retry a task run",
+ "tags": [
+ "Tasks"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-tasks.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-tasks.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/telegraf/plugins"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/telegraf",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTelegrafPlugins",
+ "method": "GET",
+ "path": "/api/v2/telegraf/plugins",
+ "summary": "List all Telegraf plugins",
+ "tags": [
+ "Telegraf Plugins"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegraf.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegraf.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/telegrafs",
+ "/api/v2/telegrafs/{telegrafID}",
+ "/api/v2/telegrafs/{telegrafID}/labels",
+ "/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
+ "/api/v2/telegrafs/{telegrafID}/members",
+ "/api/v2/telegrafs/{telegrafID}/members/{userID}",
+ "/api/v2/telegrafs/{telegrafID}/owners",
+ "/api/v2/telegrafs/{telegrafID}/owners/{userID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/telegrafs",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetTelegrafs",
+ "method": "GET",
+ "path": "/api/v2/telegrafs",
+ "summary": "List all Telegraf configurations",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafs",
+ "method": "POST",
+ "path": "/api/v2/telegrafs",
+ "summary": "Create a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsID",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Retrieve a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PutTelegrafsID",
+ "method": "PUT",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Update a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}",
+ "summary": "Delete a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDLabels",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels",
+ "summary": "List all labels for a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDLabels",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels",
+ "summary": "Add a label to a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
+ "summary": "Delete a label from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDMembers",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/members",
+ "summary": "List all users with member privileges for a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDMembers",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/members",
+ "summary": "Add a member to a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDMembersID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/members/{userID}",
+ "summary": "Remove a member from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "GetTelegrafsIDOwners",
+ "method": "GET",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners",
+ "summary": "List all owners of a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "PostTelegrafsIDOwners",
+ "method": "POST",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners",
+ "summary": "Add an owner to a Telegraf configuration",
+ "tags": [
+ "Telegrafs"
+ ]
+ },
+ {
+ "operationId": "DeleteTelegrafsIDOwnersID",
+ "method": "DELETE",
+ "path": "/api/v2/telegrafs/{telegrafID}/owners/{userID}",
+ "summary": "Remove an owner from a Telegraf config",
+ "tags": [
+ "Telegrafs"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegrafs.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegrafs.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/templates/apply",
+ "/api/v2/templates/export"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/templates",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "ApplyTemplate",
+ "method": "POST",
+ "path": "/api/v2/templates/apply",
+ "summary": "Apply or dry-run a template",
+ "tags": [
+ "Templates"
+ ]
+ },
+ {
+ "operationId": "ExportTemplate",
+ "method": "POST",
+ "path": "/api/v2/templates/export",
+ "summary": "Export a new template",
+ "tags": [
+ "Templates"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-templates.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-templates.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/users",
+ "/api/v2/users/{userID}",
+ "/api/v2/users/{userID}/password"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/users",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetUsers",
+ "method": "GET",
+ "path": "/api/v2/users",
+ "summary": "List users",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PostUsers",
+ "method": "POST",
+ "path": "/api/v2/users",
+ "summary": "Create a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "GetUsersID",
+ "method": "GET",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Retrieve a user",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PatchUsersID",
+ "method": "PATCH",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Update a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "DeleteUsersID",
+ "method": "DELETE",
+ "path": "/api/v2/users/{userID}",
+ "summary": "Delete a user",
+ "tags": [
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PostUsersIDPassword",
+ "method": "POST",
+ "path": "/api/v2/users/{userID}/password",
+ "summary": "Update a password",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ },
+ {
+ "operationId": "PutUsersIDPassword",
+ "method": "PUT",
+ "path": "/api/v2/users/{userID}/password",
+ "summary": "Update a password",
+ "tags": [
+ "Security and access endpoints",
+ "Users"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-users.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-users.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/variables",
+ "/api/v2/variables/{variableID}",
+ "/api/v2/variables/{variableID}/labels",
+ "/api/v2/variables/{variableID}/labels/{labelID}"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/variables",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetVariables",
+ "method": "GET",
+ "path": "/api/v2/variables",
+ "summary": "List all variables",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PostVariables",
+ "method": "POST",
+ "path": "/api/v2/variables",
+ "summary": "Create a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "GetVariablesID",
+ "method": "GET",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Retrieve a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PutVariablesID",
+ "method": "PUT",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Replace a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PatchVariablesID",
+ "method": "PATCH",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Update a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "DeleteVariablesID",
+ "method": "DELETE",
+ "path": "/api/v2/variables/{variableID}",
+ "summary": "Delete a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "GetVariablesIDLabels",
+ "method": "GET",
+ "path": "/api/v2/variables/{variableID}/labels",
+ "summary": "List all labels for a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "PostVariablesIDLabels",
+ "method": "POST",
+ "path": "/api/v2/variables/{variableID}/labels",
+ "summary": "Add a label to a variable",
+ "tags": [
+ "Variables"
+ ]
+ },
+ {
+ "operationId": "DeleteVariablesIDLabelsID",
+ "method": "DELETE",
+ "path": "/api/v2/variables/{variableID}/labels/{labelID}",
+ "summary": "Delete a label from a variable",
+ "tags": [
+ "Variables"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-variables.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-variables.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2/write"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2/write",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostWrite",
+ "method": "POST",
+ "path": "/api/v2/write",
+ "summary": "Write data",
+ "tags": [
+ "Write data"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-write.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-write.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/api/v2"
+ ],
+ "title": "",
+ "description": "API reference for /api/v2",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetRoutes",
+ "method": "GET",
+ "path": "/api/v2",
+ "summary": "List all top level routes",
+ "tags": [
+ "Routes",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2.yaml"
+ }
+ },
{
"path": "api/authentication",
"fields": {
"name": "Authentication",
"describes": [],
"title": "Authentication",
- "description": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- [Token authentication](#section/Authentication/TokenAuthentication)\n- [Basic authentication](#section/Authentication/BasicAuthentication)\n- [Querystring authentication](#section/Authentication/QuerystringAuthentication)\n\n",
+ "description": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- Token authentication\n- Basic authentication\n- Querystring authentication",
"tag": "Authentication",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- [Token authentication](#section/Authentication/TokenAuthentication)\n- [Basic authentication](#section/Authentication/BasicAuthentication)\n- [Querystring authentication](#section/Authentication/QuerystringAuthentication)\n\n",
+ "tagDescription": "Use one of the following schemes to authenticate to the InfluxDB API:\n\n- Token authentication\n- Basic authentication\n- Querystring authentication",
"showSecuritySchemes": true,
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authentication.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authentication.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authentication.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authentication.yaml"
}
},
{
@@ -26,7 +2664,7 @@
"/api/v2/authorizations/{authID}"
],
"title": "Authorizations (API tokens)",
- "description": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend creating a generic user to create and manage tokens for writing data.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/v2/security/tokens/create-token/).\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related endpoints\n\n- [Signin](#tag/Signin)\n- [Signout](#tag/Signout)\n\n### Related guides\n\n- [Authorize API requests](/influxdb/v2/api-guide/api_intro/#authentication)\n- [Manage API tokens](/influxdb/v2/security/tokens/)\n- [Assign a token to a specific user](/influxdb/v2/security/tokens/create-token/)\n",
+ "description": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend creating a generic user to create and manage tokens for writing data.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/v2/security/tokens/create-token/).\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related endpoints\n\n- Signin\n- Signout\n\n### Related guides\n\n- [Authorize API requests](/influxdb/v2/api-guide/api_intro/)\n- [Manage API tokens](/influxdb/v2/security/tokens/)\n- [Assign a token to a specific user](/influxdb/v2/security/tokens/create-token/)",
"tag": "Authorizations (API tokens)",
"isConceptual": false,
"menuGroup": "Other",
@@ -81,12 +2719,12 @@
]
}
],
- "tagDescription": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend creating a generic user to create and manage tokens for writing data.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/v2/security/tokens/create-token/).\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related endpoints\n\n- [Signin](#tag/Signin)\n- [Signout](#tag/Signout)\n\n### Related guides\n\n- [Authorize API requests](/influxdb/v2/api-guide/api_intro/#authentication)\n- [Manage API tokens](/influxdb/v2/security/tokens/)\n- [Assign a token to a specific user](/influxdb/v2/security/tokens/create-token/)\n",
+ "tagDescription": "Create and manage authorizations (API tokens).\n\nAn _authorization_ contains a list of `read` and `write`\npermissions for organization resources and provides an API token for authentication.\nAn authorization belongs to an organization and only contains permissions for that organization.\n\nWe recommend creating a generic user to create and manage tokens for writing data.\n\n### User sessions with authorizations\n\nOptionally, when creating an authorization, you can scope it to a specific user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nFor more information, see [how to assign a token to a specific user](/influxdb/v2/security/tokens/create-token/).\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related endpoints\n\n- Signin\n- Signout\n\n### Related guides\n\n- [Authorize API requests](/influxdb/v2/api-guide/api_intro/)\n- [Manage API tokens](/influxdb/v2/security/tokens/)\n- [Assign a token to a specific user](/influxdb/v2/security/tokens/create-token/)",
"related": [
"https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/"
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-api-tokens.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-api-tokens.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-api-tokens.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-api-tokens.yaml"
}
},
{
@@ -159,8 +2797,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml"
}
},
{
@@ -206,8 +2844,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-backup.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-backup.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-backup.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-backup.yaml"
}
},
{
@@ -226,7 +2864,7 @@
"/api/v2/sources/{sourceID}/buckets"
],
"title": "Buckets",
- "description": "Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/#bucket).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/v2/reference/glossary/#retention-period),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/v2/organizations/buckets/)\n",
+ "description": "Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/v2/reference/glossary/),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/v2/organizations/buckets/)",
"tag": "Buckets",
"isConceptual": false,
"menuGroup": "Other",
@@ -367,9 +3005,9 @@
]
}
],
- "tagDescription": "Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/#bucket).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/v2/reference/glossary/#retention-period),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/v2/organizations/buckets/)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-buckets.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-buckets.yaml"
+ "tagDescription": "Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/).\nA bucket is a named location where time series data is stored. All buckets\nhave a [retention period](/influxdb/v2/reference/glossary/),\na duration of time that each data point persists. InfluxDB drops all\npoints with timestamps older than the bucket’s retention period.\nA bucket belongs to an organization.\n\n### Related guides\n\n- [Manage buckets](/influxdb/v2/organizations/buckets/)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-buckets.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-buckets.yaml"
}
},
{
@@ -442,8 +3080,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-cells.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-cells.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-cells.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-cells.yaml"
}
},
{
@@ -554,8 +3192,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-checks.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-checks.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-checks.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-checks.yaml"
}
},
{
@@ -564,14 +3202,14 @@
"name": "Common parameters",
"describes": [],
"title": "Common parameters",
- "description": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n",
+ "description": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |",
"tag": "Common parameters",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-common-parameters.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-common-parameters.yaml"
+ "tagDescription": "To specify resources, some InfluxDB API endpoints require parameters or\nproperties in the request--for example,\nwriting to a `bucket` resource in an `org` (_organization_ resource).\n\n### Common parameters\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `bucketID` | string | The bucket ID ([find your bucket](/influxdb/v2/organizations/buckets/view-buckets/). |\n| `org` | string | The organization name or ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |\n| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/v2/organizations/view-orgs/). |",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-common-parameters.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-common-parameters.yaml"
}
},
{
@@ -607,8 +3245,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-config.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-config.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-config.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-config.yaml"
}
},
{
@@ -815,94 +3453,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dashboards.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dashboards.yaml"
- }
- },
- {
- "path": "api/data-i-o-endpoints",
- "fields": {
- "name": "Data I/O endpoints",
- "describes": [
- "/api/v2/delete",
- "/api/v2/query",
- "/api/v2/tasks",
- "/api/v2/tasks/{taskID}",
- "/api/v2/tasks/{taskID}/runs",
- "/api/v2/write"
- ],
- "title": "Data I/O endpoints",
- "description": "API reference for Data I/O endpoints",
- "tag": "Data I/O endpoints",
- "isConceptual": false,
- "menuGroup": "Other",
- "operations": [
- {
- "operationId": "PostDelete",
- "method": "POST",
- "path": "/api/v2/delete",
- "summary": "Delete data",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostQuery",
- "method": "POST",
- "path": "/api/v2/query",
- "summary": "Query data",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetTasks",
- "method": "GET",
- "path": "/api/v2/tasks",
- "summary": "List tasks",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostTasks",
- "method": "POST",
- "path": "/api/v2/tasks",
- "summary": "Create a task",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "GetTasksID",
- "method": "GET",
- "path": "/api/v2/tasks/{taskID}",
- "summary": "Retrieve a task",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostTasksIDRuns",
- "method": "POST",
- "path": "/api/v2/tasks/{taskID}/runs",
- "summary": "Start a task run, overriding the schedule",
- "tags": [
- "Data I/O endpoints"
- ]
- },
- {
- "operationId": "PostWrite",
- "method": "POST",
- "path": "/api/v2/write",
- "summary": "Write data",
- "tags": [
- "Data I/O endpoints"
- ]
- }
- ],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-data-i-o-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-data-i-o-endpoints.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dashboards.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dashboards.yaml"
}
},
{
@@ -914,7 +3466,7 @@
"/api/v2/dbrps/{dbrpID}"
],
"title": "DBRPs",
- "description": "The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/#database)\nand [retention policies](/influxdb/v2/reference/glossary/#retention-policy-rp).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in v1 compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)\n",
+ "description": "The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/)\nand [retention policies](/influxdb/v2/reference/glossary/).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in v1 compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)",
"tag": "DBRPs",
"isConceptual": false,
"menuGroup": "Other",
@@ -965,9 +3517,289 @@
]
}
],
- "tagDescription": "The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/#database)\nand [retention policies](/influxdb/v2/reference/glossary/#retention-policy-rp).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in v1 compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dbrps.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dbrps.yaml"
+ "tagDescription": "The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/)\nand [retention policies](/influxdb/v2/reference/glossary/).\nInfluxDB 2.x replaces databases and retention policies with buckets.\nTo support InfluxDB 1.x query and write patterns in InfluxDB 2.x,\ndatabases and retention policies are mapped to buckets using the\ndatabase and retention policy (DBRP) mapping service.\nThe DBRP mapping service uses the database and retention policy\nspecified in v1 compatibility API requests to route operations to a bucket.\n\n### Related guides\n\n- [Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dbrps.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dbrps.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/all"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/all",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofAllProfiles",
+ "method": "GET",
+ "path": "/debug/pprof/all",
+ "summary": "Retrieve all runtime profiles",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-all.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-all.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/allocs"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/allocs",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofAllocs",
+ "method": "GET",
+ "path": "/debug/pprof/allocs",
+ "summary": "Retrieve the memory allocations runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-allocs.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-allocs.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/block"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/block",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofBlock",
+ "method": "GET",
+ "path": "/debug/pprof/block",
+ "summary": "Retrieve the block runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-block.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-block.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/cmdline"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/cmdline",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofCmdline",
+ "method": "GET",
+ "path": "/debug/pprof/cmdline",
+ "summary": "Retrieve the command line invocation",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-cmdline.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-cmdline.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/goroutine"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/goroutine",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofGoroutine",
+ "method": "GET",
+ "path": "/debug/pprof/goroutine",
+ "summary": "Retrieve the goroutines runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-goroutine.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-goroutine.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/heap"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/heap",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofHeap",
+ "method": "GET",
+ "path": "/debug/pprof/heap",
+ "summary": "Retrieve the heap runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-heap.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-heap.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/mutex"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/mutex",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofMutex",
+ "method": "GET",
+ "path": "/debug/pprof/mutex",
+ "summary": "Retrieve the mutual exclusion (mutex) runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-mutex.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-mutex.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/profile"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/profile",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofProfile",
+ "method": "GET",
+ "path": "/debug/pprof/profile",
+ "summary": "Retrieve the CPU runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-profile.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-profile.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/threadcreate"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/threadcreate",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofThreadCreate",
+ "method": "GET",
+ "path": "/debug/pprof/threadcreate",
+ "summary": "Retrieve the threadcreate runtime profile",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-threadcreate.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-threadcreate.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/debug/pprof/trace"
+ ],
+ "title": "",
+ "description": "API reference for /debug/pprof/trace",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetDebugPprofTrace",
+ "method": "GET",
+ "path": "/debug/pprof/trace",
+ "summary": "Retrieve the runtime execution trace",
+ "tags": [
+ "Debug",
+ "System information endpoints"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-trace.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-trace.yaml"
}
},
{
@@ -987,7 +3819,7 @@
"/debug/pprof/trace"
],
"title": "Debug",
- "description": "Generate profiling and trace reports.\n\nUse routes under `/debug/pprof` to analyze the Go runtime of InfluxDB.\nThese endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof)\nand **trace** reports.\n**Profiles** are collections of stack traces that show call sequences\nleading to instances of a particular event, such as allocation.\n\nFor more information about **pprof profile** and **trace** reports,\nsee the following resources:\n\n- [Google pprof tool](https://github.com/google/pprof)\n- [Golang diagnostics](https://go.dev/doc/diagnostics)\n",
+ "description": "Generate profiling and trace reports.\n\nUse routes under `/debug/pprof` to analyze the Go runtime of InfluxDB.\nThese endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof)\nand **trace** reports.\n**Profiles** are collections of stack traces that show call sequences\nleading to instances of a particular event, such as allocation.\n\nFor more information about **pprof profile** and **trace** reports,\nsee the following resources:\n\n- [Google pprof tool](https://github.com/google/pprof)\n- [Golang diagnostics](https://go.dev/doc/diagnostics)",
"tag": "Debug",
"isConceptual": false,
"menuGroup": "Other",
@@ -1083,9 +3915,9 @@
]
}
],
- "tagDescription": "Generate profiling and trace reports.\n\nUse routes under `/debug/pprof` to analyze the Go runtime of InfluxDB.\nThese endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof)\nand **trace** reports.\n**Profiles** are collections of stack traces that show call sequences\nleading to instances of a particular event, such as allocation.\n\nFor more information about **pprof profile** and **trace** reports,\nsee the following resources:\n\n- [Google pprof tool](https://github.com/google/pprof)\n- [Golang diagnostics](https://go.dev/doc/diagnostics)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-debug.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-debug.yaml"
+ "tagDescription": "Generate profiling and trace reports.\n\nUse routes under `/debug/pprof` to analyze the Go runtime of InfluxDB.\nThese endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof)\nand **trace** reports.\n**Profiles** are collections of stack traces that show call sequences\nleading to instances of a particular event, such as allocation.\n\nFor more information about **pprof profile** and **trace** reports,\nsee the following resources:\n\n- [Google pprof tool](https://github.com/google/pprof)\n- [Golang diagnostics](https://go.dev/doc/diagnostics)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug.yaml"
}
},
{
@@ -1096,7 +3928,7 @@
"/api/v2/delete"
],
"title": "Delete",
- "description": "Delete data from an InfluxDB bucket.\n",
+ "description": "Delete data from an InfluxDB bucket.",
"tag": "Delete",
"isConceptual": false,
"menuGroup": "Other",
@@ -1111,9 +3943,9 @@
]
}
],
- "tagDescription": "Delete data from an InfluxDB bucket.\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-delete.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-delete.yaml"
+ "tagDescription": "Delete data from an InfluxDB bucket.",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-delete.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-delete.yaml"
}
},
{
@@ -1122,14 +3954,14 @@
"name": "Headers",
"describes": [],
"title": "Headers",
- "description": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/v2/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
+ "description": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/v2/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |",
"tag": "Headers",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/v2/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-headers.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-headers.yaml"
+ "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The [authorization scheme and credential](/influxdb/v2/api/authentication/). |\n| `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. |\n| `Content-Type` | string | The format of the data in the request body. |",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-headers.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-headers.yaml"
}
},
{
@@ -1155,8 +3987,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-health.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-health.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-health.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-health.yaml"
}
},
{
@@ -1219,8 +4051,82 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-labels.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-labels.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-labels.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-labels.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/legacy/authorizations",
+ "/legacy/authorizations/{authID}",
+ "/legacy/authorizations/{authID}/password"
+ ],
+ "title": "",
+ "description": "API reference for /legacy/authorizations",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetLegacyAuthorizations",
+ "method": "GET",
+ "path": "/legacy/authorizations",
+ "summary": "List all legacy authorizations",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "PostLegacyAuthorizations",
+ "method": "POST",
+ "path": "/legacy/authorizations",
+ "summary": "Create a legacy authorization",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "GetLegacyAuthorizationsID",
+ "method": "GET",
+ "path": "/legacy/authorizations/{authID}",
+ "summary": "Retrieve a legacy authorization",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "PatchLegacyAuthorizationsID",
+ "method": "PATCH",
+ "path": "/legacy/authorizations/{authID}",
+ "summary": "Update a legacy authorization to be active or inactive",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "DeleteLegacyAuthorizationsID",
+ "method": "DELETE",
+ "path": "/legacy/authorizations/{authID}",
+ "summary": "Delete a legacy authorization",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "PostLegacyAuthorizationsIDPassword",
+ "method": "POST",
+ "path": "/legacy/authorizations/{authID}/password",
+ "summary": "Set a legacy authorization password",
+ "tags": [
+ "Authorizations (v1-compatible)"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-legacy-authorizations.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-legacy-authorizations.yaml"
}
},
{
@@ -1246,8 +4152,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-metrics.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-metrics.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-metrics.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-metrics.yaml"
}
},
{
@@ -1348,8 +4254,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationendpoints.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationendpoints.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationendpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationendpoints.yaml"
}
},
{
@@ -1450,8 +4356,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationrules.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationrules.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationrules.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationrules.yaml"
}
},
{
@@ -1467,7 +4373,7 @@
"/api/v2/orgs/{orgID}/owners/{userID}"
],
"title": "Organizations",
- "description": "Create and manage your [organizations](/influxdb/v2/reference/glossary/#organization).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to create, view, and manage organizations.\n",
+ "description": "Create and manage your [organizations](/influxdb/v2/reference/glossary/).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to create, view, and manage organizations.",
"tag": "Organizations",
"isConceptual": false,
"menuGroup": "Other",
@@ -1572,9 +4478,9 @@
]
}
],
- "tagDescription": "Create and manage your [organizations](/influxdb/v2/reference/glossary/#organization).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to create, view, and manage organizations.\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-organizations.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-organizations.yaml"
+ "tagDescription": "Create and manage your [organizations](/influxdb/v2/reference/glossary/).\nAn organization is a workspace for a group of users. Organizations can be\nused to separate different environments, projects, teams or users within\nInfluxDB.\n\nUse the `/api/v2/orgs` endpoints to create, view, and manage organizations.",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-organizations.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-organizations.yaml"
}
},
{
@@ -1583,14 +4489,14 @@
"name": "Pagination",
"describes": [],
"title": "Pagination",
- "description": "Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results:\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n| `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n| `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n### Limitations\n\n- For specific endpoint parameters and examples, see the endpoint definition.\n- If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```\n",
+ "description": "Some InfluxDB API list operations may support the following query parameters for paginating results:\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n| `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n| `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n### Limitations\n\n- For specific endpoint parameters and examples, see the endpoint definition.\n- If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```",
"tag": "Pagination",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results:\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n| `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n| `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n### Limitations\n\n- For specific endpoint parameters and examples, see the endpoint definition.\n- If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-pagination.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-pagination.yaml"
+ "tagDescription": "Some InfluxDB API list operations may support the following query parameters for paginating results:\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `limit` | integer | The maximum number of records to return (after other parameters are applied). |\n| `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). |\n| `after` | string (resource ID) | Only returns resources created after the specified resource. |\n\n### Limitations\n\n- For specific endpoint parameters and examples, see the endpoint definition.\n- If you specify an `offset` parameter value greater than the total number of records,\n then InfluxDB returns an empty list in the response\n (given `offset` skips the specified number of records).\n\n The following example passes `offset=50` to skip the first 50 results,\n but the user only has 10 buckets:\n\n ```sh\n curl --request GET \"INFLUX_URL/api/v2/buckets?limit=1&offset=50\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n ```\n\n The response contains the following:\n\n ```json\n {\n \"links\": {\n \"prev\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=49\\u0026orgID=ORG_ID\",\n \"self\": \"/api/v2/buckets?descending=false\\u0026limit=1\\u0026offset=50\\u0026orgID=ORG_ID\"\n },\n \"buckets\": []\n }\n ```",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-pagination.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-pagination.yaml"
}
},
{
@@ -1625,8 +4531,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ping.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ping.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ping.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ping.yaml"
}
},
{
@@ -1661,14 +4567,14 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query-data-v1-compatible.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query-data-v1-compatible.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data-v1-compatible.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data-v1-compatible.yaml"
}
},
{
- "path": "api/query",
+ "path": "api/query-data",
"fields": {
- "name": "Query",
+ "name": "Query data",
"describes": [
"/api/v2/query",
"/api/v2/query/analyze",
@@ -1676,11 +4582,11 @@
"/api/v2/query/suggestions",
"/api/v2/query/suggestions/{name}"
],
- "title": "Query",
- "description": "Retrieve data, analyze queries, and get query suggestions.\n",
- "tag": "Query",
+ "title": "Query data",
+ "description": "Retrieve data, analyze queries, and get query suggestions.",
+ "tag": "Query data",
"isConceptual": false,
- "menuGroup": "Other",
+ "menuGroup": "Data Operations",
"operations": [
{
"operationId": "PostQuery",
@@ -1688,7 +4594,7 @@
"path": "/api/v2/query",
"summary": "Query data",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1697,7 +4603,7 @@
"path": "/api/v2/query/analyze",
"summary": "Analyze a Flux query",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1706,7 +4612,7 @@
"path": "/api/v2/query/ast",
"summary": "Generate a query Abstract Syntax Tree (AST)",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1715,7 +4621,7 @@
"path": "/api/v2/query/suggestions",
"summary": "List Flux query suggestions",
"tags": [
- "Query"
+ "Query data"
]
},
{
@@ -1724,13 +4630,49 @@
"path": "/api/v2/query/suggestions/{name}",
"summary": "Retrieve a query suggestion for a branching suggestion",
"tags": [
- "Query"
+ "Query data"
]
}
],
- "tagDescription": "Retrieve data, analyze queries, and get query suggestions.\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query.yaml"
+ "tagDescription": "Retrieve data, analyze queries, and get query suggestions.",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/query"
+ ],
+ "title": "",
+ "description": "API reference for /query",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "GetLegacyQuery",
+ "method": "GET",
+ "path": "/query",
+ "summary": "Execute InfluxQL query (v1-compatible)",
+ "tags": [
+ "Query data (v1-compatible)"
+ ]
+ },
+ {
+ "operationId": "PostQueryV1",
+ "method": "POST",
+ "path": "/query",
+ "summary": "Execute InfluxQL query (v1-compatible)",
+ "tags": [
+ "Query data (v1-compatible)"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query.yaml"
}
},
{
@@ -1739,14 +4681,14 @@
"name": "Quick start",
"describes": [],
"title": "Quick start",
- "description": "See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/v2/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.\n",
+ "description": "See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/v2/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.",
"tag": "Quick start",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/v2/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-quick-start.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-quick-start.yaml"
+ "tagDescription": "See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)\nto get up and running authenticating with tokens, writing to buckets, and querying data.\n\n[**InfluxDB API client libraries**](/influxdb/v2/api-guide/client-libraries/)\nare available for popular languages and ready to import into your application.",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-quick-start.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-quick-start.yaml"
}
},
{
@@ -1772,8 +4714,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ready.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ready.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ready.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ready.yaml"
}
},
{
@@ -1836,8 +4778,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-remoteconnections.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-remoteconnections.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-remoteconnections.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-remoteconnections.yaml"
}
},
{
@@ -1910,8 +4852,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-replications.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-replications.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-replications.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-replications.yaml"
}
},
{
@@ -1937,8 +4879,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-resources.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-resources.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-resources.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-resources.yaml"
}
},
{
@@ -1947,14 +4889,14 @@
"name": "Response codes",
"describes": [],
"title": "Response codes",
- "description": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | Success. No content | InfluxDB doesn't return data for the request. |\n| `400` | Bad request | May indicate one of the following:- the request body is malformed
- `Authorization` header is missing or malformed
- the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |\n",
+ "description": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | Success. No content | InfluxDB doesn't return data for the request. |\n| `400` | Bad request | May indicate one of the following:- the request body is malformed
- `Authorization` header is missing or malformed
- the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |",
"tag": "Response codes",
"isConceptual": true,
"menuGroup": "Concepts",
"operations": [],
- "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | Success. No content | InfluxDB doesn't return data for the request. |\n| `400` | Bad request | May indicate one of the following:- the request body is malformed
- `Authorization` header is missing or malformed
- the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-response-codes.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-response-codes.yaml"
+ "tagDescription": "InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses.\nThe response body may include additional details.\nFor details about a specific operation's response,\nsee **Responses** and **Response Samples** for that operation.\n\nAPI operations may return the following HTTP status codes:\n\n| Code | Status | Description |\n|:-----------:|:------------------------ |:--------------------- |\n| `200` | Success | |\n| `204` | Success. No content | InfluxDB doesn't return data for the request. |\n| `400` | Bad request | May indicate one of the following:- the request body is malformed
- `Authorization` header is missing or malformed
- the API token doesn't have permission for the operation.
|\n| `401` | Unauthorized | May indicate one of the following: - `Authorization: Token` header is missing or malformed
- API token value is missing from the header
- API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)
|\n| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |\n| `413` | Request entity too large | Request payload exceeds the size limit. |\n| `422` | Unprocessable entity | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|\n| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |\n| `500` | Internal server error | |\n| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-response-codes.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-response-codes.yaml"
}
},
{
@@ -2020,8 +4962,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-restore.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-restore.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-restore.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-restore.yaml"
}
},
{
@@ -2047,8 +4989,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-routes.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-routes.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-routes.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-routes.yaml"
}
},
{
@@ -2074,8 +5016,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-rules.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-rules.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-rules.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-rules.yaml"
}
},
{
@@ -2225,8 +5167,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-scraper-targets.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-scraper-targets.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-scraper-targets.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-scraper-targets.yaml"
}
},
{
@@ -2281,8 +5223,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-secrets.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-secrets.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-secrets.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-secrets.yaml"
}
},
{
@@ -2501,8 +5443,8 @@
"related": [
"https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/"
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-security-and-access-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-security-and-access-endpoints.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-security-and-access-endpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-security-and-access-endpoints.yaml"
}
},
{
@@ -2537,8 +5479,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-setup.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-setup.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-setup.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-setup.yaml"
}
},
{
@@ -2564,8 +5506,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signin.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signin.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signin.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signin.yaml"
}
},
{
@@ -2591,8 +5533,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signout.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signout.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signout.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signout.yaml"
}
},
{
@@ -2675,8 +5617,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-sources.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-sources.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-sources.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-sources.yaml"
}
},
{
@@ -2685,14 +5627,14 @@
"name": "Supported operations",
"describes": [],
"title": "Supported operations",
- "description": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n",
+ "description": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |",
"tag": "Supported operations",
"isConceptual": true,
"menuGroup": "Other",
"operations": [],
- "tagDescription": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-supported-operations.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-supported-operations.yaml"
+ "tagDescription": "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-supported-operations.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-supported-operations.yaml"
}
},
{
@@ -2878,8 +5820,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-system-information-endpoints.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-system-information-endpoints.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-system-information-endpoints.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-system-information-endpoints.yaml"
}
},
{
@@ -2902,7 +5844,7 @@
"/api/v2/tasks/{taskID}/runs/{runID}/retry"
],
"title": "Tasks",
- "description": "Process and analyze your data with [tasks](/influxdb/v2/reference/glossary/#task)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks).\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in a `task` object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/v2/process-data/get-started/)\n- [Common data processing tasks](/influxdb/v2/process-data/common-tasks/)\n",
+ "description": "Process and analyze your data with [tasks](/influxdb/v2/reference/glossary/)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the `POST /api/v2/tasks` endpoint.\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in a `task` object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/v2/process-data/get-started/)\n- [Common data processing tasks](/influxdb/v2/process-data/common-tasks/)",
"tag": "Tasks",
"isConceptual": false,
"menuGroup": "Other",
@@ -3097,9 +6039,9 @@
]
}
],
- "tagDescription": "Process and analyze your data with [tasks](/influxdb/v2/reference/glossary/#task)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks).\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in a `task` object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/v2/process-data/get-started/)\n- [Common data processing tasks](/influxdb/v2/process-data/common-tasks/)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-tasks.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-tasks.yaml"
+ "tagDescription": "Process and analyze your data with [tasks](/influxdb/v2/reference/glossary/)\nin the InfluxDB task engine.\nUse the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.\n\nTo configure a task, provide the script and the schedule to run the task.\nFor examples, see how to create a task with the `POST /api/v2/tasks` endpoint.\n\n\n\n### Properties\n\nA `task` object contains information about an InfluxDB task resource.\n\nThe following table defines the properties that appear in a `task` object:\n\n\n\n### Related guides\n\n- [Get started with tasks](/influxdb/v2/process-data/get-started/)\n- [Common data processing tasks](/influxdb/v2/process-data/common-tasks/)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-tasks.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-tasks.yaml"
}
},
{
@@ -3125,8 +6067,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegraf-plugins.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegraf-plugins.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegraf-plugins.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegraf-plugins.yaml"
}
},
{
@@ -3276,8 +6218,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegrafs.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegrafs.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegrafs.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegrafs.yaml"
}
},
{
@@ -3292,7 +6234,7 @@
"/api/v2/templates/export"
],
"title": "Templates",
- "description": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for\neverything from dashboards and Telegraf to notifications and alerts.\nUse InfluxDB templates to quickly configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration with the\nInfluxData community.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/v2/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/v2/influxdb-templates/)\n",
+ "description": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for\neverything from dashboards and Telegraf to notifications and alerts.\nUse InfluxDB templates to quickly configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration with the\nInfluxData community.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/v2/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/v2/influxdb-templates/)",
"tag": "Templates",
"isConceptual": false,
"menuGroup": "Other",
@@ -3370,9 +6312,9 @@
]
}
],
- "tagDescription": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for\neverything from dashboards and Telegraf to notifications and alerts.\nUse InfluxDB templates to quickly configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration with the\nInfluxData community.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/v2/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/v2/influxdb-templates/)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-templates.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-templates.yaml"
+ "tagDescription": "Export and apply InfluxDB **templates**.\nManage **stacks** of templated InfluxDB resources.\n\nInfluxDB templates are prepackaged configurations for\neverything from dashboards and Telegraf to notifications and alerts.\nUse InfluxDB templates to quickly configure a fresh instance of InfluxDB,\nback up your dashboard configuration, or share your configuration with the\nInfluxData community.\n\nUse the `/api/v2/templates` endpoints to export templates and apply templates.\n\n**InfluxDB stacks** are stateful InfluxDB templates that let you\nadd, update, and remove installed template resources over time, avoid duplicating\nresources when applying the same or similar templates more than once, and\napply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.\n\nUse the `/api/v2/stacks` endpoints to manage installed template resources.\n\n### Related guides\n\n- [InfluxDB stacks](/influxdb/v2/influxdb-templates/stacks/)\n- [InfluxDB templates](/influxdb/v2/influxdb-templates/)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-templates.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-templates.yaml"
}
},
{
@@ -3387,7 +6329,7 @@
"/api/v2/users/{userID}/password"
],
"title": "Users",
- "description": "Manage users for your organization.\nUsers are those with access to InfluxDB.\nTo grant a user permission to access data, add them as a member of an\norganization and provide them with an API token.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related guides\n\n- [Manage users](/influxdb/v2/influxdb/v2/users/)\n- [Create a token scoped to a user](/influxdb/v2/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user)\n",
+ "description": "Manage users for your organization.\nUsers are those with access to InfluxDB.\nTo grant a user permission to access data, add them as a member of an\norganization and provide them with an API token.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related guides\n\n- [Manage users](/influxdb/v2/influxdb/v2/users/)\n- [Create a token scoped to a user](/influxdb/v2/latest/security/tokens/create-token/)",
"tag": "Users",
"isConceptual": false,
"menuGroup": "Other",
@@ -3474,9 +6416,9 @@
]
}
],
- "tagDescription": "Manage users for your organization.\nUsers are those with access to InfluxDB.\nTo grant a user permission to access data, add them as a member of an\norganization and provide them with an API token.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin).\n\n### Related guides\n\n- [Manage users](/influxdb/v2/influxdb/v2/users/)\n- [Create a token scoped to a user](/influxdb/v2/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user)\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-users.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-users.yaml"
+ "tagDescription": "Manage users for your organization.\nUsers are those with access to InfluxDB.\nTo grant a user permission to access data, add them as a member of an\norganization and provide them with an API token.\n\n### User sessions with authorizations\n\nOptionally, you can scope an authorization (and its API token) to a user.\nIf a user signs in with username and password, creating a _user session_,\nthe session carries the permissions granted by all the user's authorizations.\nTo create a user session, use the `POST /api/v2/signin` endpoint.\n\n### Related guides\n\n- [Manage users](/influxdb/v2/influxdb/v2/users/)\n- [Create a token scoped to a user](/influxdb/v2/latest/security/tokens/create-token/)",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-users.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-users.yaml"
}
},
{
@@ -3577,8 +6519,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-variables.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-variables.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-variables.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-variables.yaml"
}
},
{
@@ -3613,8 +6555,8 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-views.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-views.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-views.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-views.yaml"
}
},
{
@@ -3640,22 +6582,22 @@
]
}
],
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write-data-v1-compatible.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write-data-v1-compatible.yaml"
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data-v1-compatible.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data-v1-compatible.yaml"
}
},
{
- "path": "api/write",
+ "path": "api/write-data",
"fields": {
- "name": "Write",
+ "name": "Write data",
"describes": [
"/api/v2/write"
],
- "title": "Write",
- "description": "Write time series data to [buckets](/influxdb/v2/reference/glossary/#bucket).\n",
- "tag": "Write",
+ "title": "Write data",
+ "description": "Write time series data to [buckets](/influxdb/v2/reference/glossary/).",
+ "tag": "Write data",
"isConceptual": false,
- "menuGroup": "Other",
+ "menuGroup": "Data Operations",
"operations": [
{
"operationId": "PostWrite",
@@ -3663,13 +6605,40 @@
"path": "/api/v2/write",
"summary": "Write data",
"tags": [
- "Write"
+ "Write data"
]
}
],
- "tagDescription": "Write time series data to [buckets](/influxdb/v2/reference/glossary/#bucket).\n",
- "source": "static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write.yaml",
- "staticFilePath": "/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write.yaml"
+ "tagDescription": "Write time series data to [buckets](/influxdb/v2/reference/glossary/).",
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data.yaml"
+ }
+ },
+ {
+ "path": "api/",
+ "fields": {
+ "name": "",
+ "describes": [
+ "/write"
+ ],
+ "title": "",
+ "description": "API reference for /write",
+ "tag": "",
+ "isConceptual": false,
+ "menuGroup": "Other",
+ "operations": [
+ {
+ "operationId": "PostLegacyWrite",
+ "method": "POST",
+ "path": "/write",
+ "summary": "Write data using a v1-compatible request",
+ "tags": [
+ "Write data (v1-compatible)"
+ ]
+ }
+ ],
+ "source": "static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write.yaml",
+ "staticFilePath": "/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write.yaml"
}
}
]
diff --git a/data/article_data/influxdb/oss-v2/articles.yml b/data/article_data/influxdb/oss-v2/articles.yml
index fdf1a12b1..ce14133d1 100644
--- a/data/article_data/influxdb/oss-v2/articles.yml
+++ b/data/article_data/influxdb/oss-v2/articles.yml
@@ -1,41 +1,1882 @@
articles:
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/authorizations
+ - /api/v2/authorizations/{authID}
+ title: ''
+ description: API reference for /api/v2/authorizations
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetAuthorizations
+ method: GET
+ path: /api/v2/authorizations
+ summary: List authorizations
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: PostAuthorizations
+ method: POST
+ path: /api/v2/authorizations
+ summary: Create an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: GetAuthorizationsID
+ method: GET
+ path: /api/v2/authorizations/{authID}
+ summary: Retrieve an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ externalDocs:
+ description: View tokens
+ url: >-
+ https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/
+ - operationId: PatchAuthorizationsID
+ method: PATCH
+ path: /api/v2/authorizations/{authID}
+ summary: Update an API token to be active or inactive
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ - operationId: DeleteAuthorizationsID
+ method: DELETE
+ path: /api/v2/authorizations/{authID}
+ summary: Delete an authorization
+ tags:
+ - Authorizations (API tokens)
+ - Security and access endpoints
+ related:
+ - https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-authorizations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-authorizations.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/backup/kv
+ - /api/v2/backup/metadata
+ - /api/v2/backup/shards/{shardID}
+ title: ''
+ description: API reference for /api/v2/backup
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetBackupKV
+ method: GET
+ path: /api/v2/backup/kv
+ summary: >-
+ Download snapshot of metadata stored in the server's embedded KV
+ store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x.
+ tags:
+ - Backup
+ - operationId: GetBackupMetadata
+ method: GET
+ path: /api/v2/backup/metadata
+ summary: Download snapshot of all metadata in the server
+ tags:
+ - Backup
+ - operationId: GetBackupShardId
+ method: GET
+ path: /api/v2/backup/shards/{shardID}
+ summary: Download snapshot of all TSM data in a shard
+ tags:
+ - Backup
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-backup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-backup.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/buckets
+ - /api/v2/buckets/{bucketID}
+ - /api/v2/buckets/{bucketID}/labels
+ - /api/v2/buckets/{bucketID}/labels/{labelID}
+ - /api/v2/buckets/{bucketID}/members
+ - /api/v2/buckets/{bucketID}/members/{userID}
+ - /api/v2/buckets/{bucketID}/owners
+ - /api/v2/buckets/{bucketID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/buckets
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetBuckets
+ method: GET
+ path: /api/v2/buckets
+ summary: List buckets
+ tags:
+ - Buckets
+ - operationId: PostBuckets
+ method: POST
+ path: /api/v2/buckets
+ summary: Create a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsID
+ method: GET
+ path: /api/v2/buckets/{bucketID}
+ summary: Retrieve a bucket
+ tags:
+ - Buckets
+ - operationId: PatchBucketsID
+ method: PATCH
+ path: /api/v2/buckets/{bucketID}
+ summary: Update a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}
+ summary: Delete a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDLabels
+ method: GET
+ path: /api/v2/buckets/{bucketID}/labels
+ summary: List all labels for a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDLabels
+ method: POST
+ path: /api/v2/buckets/{bucketID}/labels
+ summary: Add a label to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDLabelsID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/labels/{labelID}
+ summary: Delete a label from a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDMembers
+ method: GET
+ path: /api/v2/buckets/{bucketID}/members
+ summary: List all users with member privileges for a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDMembers
+ method: POST
+ path: /api/v2/buckets/{bucketID}/members
+ summary: Add a member to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDMembersID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/members/{userID}
+ summary: Remove a member from a bucket
+ tags:
+ - Buckets
+ - operationId: GetBucketsIDOwners
+ method: GET
+ path: /api/v2/buckets/{bucketID}/owners
+ summary: List all owners of a bucket
+ tags:
+ - Buckets
+ - operationId: PostBucketsIDOwners
+ method: POST
+ path: /api/v2/buckets/{bucketID}/owners
+ summary: Add an owner to a bucket
+ tags:
+ - Buckets
+ - operationId: DeleteBucketsIDOwnersID
+ method: DELETE
+ path: /api/v2/buckets/{bucketID}/owners/{userID}
+ summary: Remove an owner from a bucket
+ tags:
+ - Buckets
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-buckets.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/checks
+ - /api/v2/checks/{checkID}
+ - /api/v2/checks/{checkID}/labels
+ - /api/v2/checks/{checkID}/labels/{labelID}
+ - /api/v2/checks/{checkID}/query
+ title: ''
+ description: API reference for /api/v2/checks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetChecks
+ method: GET
+ path: /api/v2/checks
+ summary: List all checks
+ tags:
+ - Checks
+ - operationId: CreateCheck
+ method: POST
+ path: /api/v2/checks
+ summary: Add new check
+ tags:
+ - Checks
+ - operationId: GetChecksID
+ method: GET
+ path: /api/v2/checks/{checkID}
+ summary: Retrieve a check
+ tags:
+ - Checks
+ - operationId: PutChecksID
+ method: PUT
+ path: /api/v2/checks/{checkID}
+ summary: Update a check
+ tags:
+ - Checks
+ - operationId: PatchChecksID
+ method: PATCH
+ path: /api/v2/checks/{checkID}
+ summary: Update a check
+ tags:
+ - Checks
+ - operationId: DeleteChecksID
+ method: DELETE
+ path: /api/v2/checks/{checkID}
+ summary: Delete a check
+ tags:
+ - Checks
+ - operationId: GetChecksIDLabels
+ method: GET
+ path: /api/v2/checks/{checkID}/labels
+ summary: List all labels for a check
+ tags:
+ - Checks
+ - operationId: PostChecksIDLabels
+ method: POST
+ path: /api/v2/checks/{checkID}/labels
+ summary: Add a label to a check
+ tags:
+ - Checks
+ - operationId: DeleteChecksIDLabelsID
+ method: DELETE
+ path: /api/v2/checks/{checkID}/labels/{labelID}
+ summary: Delete label from a check
+ tags:
+ - Checks
+ - operationId: GetChecksIDQuery
+ method: GET
+ path: /api/v2/checks/{checkID}/query
+ summary: Retrieve a check query
+ tags:
+ - Checks
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-checks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/config
+ title: ''
+ description: API reference for /api/v2/config
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetConfig
+ method: GET
+ path: /api/v2/config
+ summary: Retrieve runtime configuration
+ tags:
+ - Config
+ - System information endpoints
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-config.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-config.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/dashboards
+ - /api/v2/dashboards/{dashboardID}
+ - /api/v2/dashboards/{dashboardID}/cells
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ - /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ - /api/v2/dashboards/{dashboardID}/labels
+ - /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ - /api/v2/dashboards/{dashboardID}/members
+ - /api/v2/dashboards/{dashboardID}/members/{userID}
+ - /api/v2/dashboards/{dashboardID}/owners
+ - /api/v2/dashboards/{dashboardID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/dashboards
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDashboards
+ method: GET
+ path: /api/v2/dashboards
+ summary: List dashboards
+ tags:
+ - Dashboards
+ - operationId: PostDashboards
+ method: POST
+ path: /api/v2/dashboards
+ summary: Create a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsID
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Retrieve a dashboard
+ tags:
+ - Dashboards
+ - operationId: PatchDashboardsID
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Update a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}
+ summary: Delete a dashboard
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDCells
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/cells
+ summary: Create a dashboard cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: PutDashboardsIDCells
+ method: PUT
+ path: /api/v2/dashboards/{dashboardID}/cells
+ summary: Replace cells in a dashboard
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: PatchDashboardsIDCellsID
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ summary: Update the non-positional information related to a cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: DeleteDashboardsIDCellsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}
+ summary: Delete a dashboard cell
+ tags:
+ - Cells
+ - Dashboards
+ - operationId: GetDashboardsIDCellsIDView
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ summary: Retrieve the view for a cell
+ tags:
+ - Cells
+ - Dashboards
+ - Views
+ - operationId: PatchDashboardsIDCellsIDView
+ method: PATCH
+ path: /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
+ summary: Update the view for a cell
+ tags:
+ - Cells
+ - Dashboards
+ - Views
+ - operationId: GetDashboardsIDLabels
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/labels
+ summary: List all labels for a dashboard
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDLabels
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/labels
+ summary: Add a label to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDLabelsID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/labels/{labelID}
+ summary: Delete a label from a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsIDMembers
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/members
+ summary: List all dashboard members
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDMembers
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/members
+ summary: Add a member to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDMembersID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/members/{userID}
+ summary: Remove a member from a dashboard
+ tags:
+ - Dashboards
+ - operationId: GetDashboardsIDOwners
+ method: GET
+ path: /api/v2/dashboards/{dashboardID}/owners
+ summary: List all dashboard owners
+ tags:
+ - Dashboards
+ - operationId: PostDashboardsIDOwners
+ method: POST
+ path: /api/v2/dashboards/{dashboardID}/owners
+ summary: Add an owner to a dashboard
+ tags:
+ - Dashboards
+ - operationId: DeleteDashboardsIDOwnersID
+ method: DELETE
+ path: /api/v2/dashboards/{dashboardID}/owners/{userID}
+ summary: Remove an owner from a dashboard
+ tags:
+ - Dashboards
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dashboards.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/dbrps
+ - /api/v2/dbrps/{dbrpID}
+ title: ''
+ description: API reference for /api/v2/dbrps
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDBRPs
+ method: GET
+ path: /api/v2/dbrps
+ summary: List database retention policy mappings
+ tags:
+ - DBRPs
+ - operationId: PostDBRP
+ method: POST
+ path: /api/v2/dbrps
+ summary: Add a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: GetDBRPsID
+ method: GET
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Retrieve a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: PatchDBRPID
+ method: PATCH
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Update a database retention policy mapping
+ tags:
+ - DBRPs
+ - operationId: DeleteDBRPID
+ method: DELETE
+ path: /api/v2/dbrps/{dbrpID}
+ summary: Delete a database retention policy
+ tags:
+ - DBRPs
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-dbrps.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/delete
+ title: ''
+ description: API reference for /api/v2/delete
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostDelete
+ method: POST
+ path: /api/v2/delete
+ summary: Delete data
+ tags:
+ - Delete
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-delete.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/flags
+ title: ''
+ description: API reference for /api/v2/flags
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetFlags
+ method: GET
+ path: /api/v2/flags
+ summary: Retrieve feature flags
+ tags:
+ - Config
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-flags.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-flags.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/labels
+ - /api/v2/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/labels
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetLabels
+ method: GET
+ path: /api/v2/labels
+ summary: List all labels
+ tags:
+ - Labels
+ - operationId: PostLabels
+ method: POST
+ path: /api/v2/labels
+ summary: Create a label
+ tags:
+ - Labels
+ - operationId: GetLabelsID
+ method: GET
+ path: /api/v2/labels/{labelID}
+ summary: Retrieve a label
+ tags:
+ - Labels
+ - operationId: PatchLabelsID
+ method: PATCH
+ path: /api/v2/labels/{labelID}
+ summary: Update a label
+ tags:
+ - Labels
+ - operationId: DeleteLabelsID
+ method: DELETE
+ path: /api/v2/labels/{labelID}
+ summary: Delete a label
+ tags:
+ - Labels
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-labels.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/maps/mapToken
+ title: ''
+ description: API reference for /api/v2/maps
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: getMapboxToken
+ method: GET
+ path: /api/v2/maps/mapToken
+ summary: Get a mapbox token
+ tags: []
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-maps.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-maps.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/me
+ - /api/v2/me/password
+ title: ''
+ description: API reference for /api/v2/me
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetMe
+ method: GET
+ path: /api/v2/me
+ summary: Retrieve the currently authenticated user
+ tags:
+ - Users
+ - operationId: PutMePassword
+ method: PUT
+ path: /api/v2/me/password
+ summary: Update a password
+ tags:
+ - Users
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-me.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-me.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/notificationEndpoints
+ - /api/v2/notificationEndpoints/{endpointID}
+ - /api/v2/notificationEndpoints/{endpointID}/labels
+ - /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/notificationEndpoints
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetNotificationEndpoints
+ method: GET
+ path: /api/v2/notificationEndpoints
+ summary: List all notification endpoints
+ tags:
+ - NotificationEndpoints
+ - operationId: CreateNotificationEndpoint
+ method: POST
+ path: /api/v2/notificationEndpoints
+ summary: Add a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: GetNotificationEndpointsID
+ method: GET
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Retrieve a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PutNotificationEndpointsID
+ method: PUT
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Update a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PatchNotificationEndpointsID
+ method: PATCH
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Update a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: DeleteNotificationEndpointsID
+ method: DELETE
+ path: /api/v2/notificationEndpoints/{endpointID}
+ summary: Delete a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: GetNotificationEndpointsIDLabels
+ method: GET
+ path: /api/v2/notificationEndpoints/{endpointID}/labels
+ summary: List all labels for a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: PostNotificationEndpointIDLabels
+ method: POST
+ path: /api/v2/notificationEndpoints/{endpointID}/labels
+ summary: Add a label to a notification endpoint
+ tags:
+ - NotificationEndpoints
+ - operationId: DeleteNotificationEndpointsIDLabelsID
+ method: DELETE
+ path: /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
+ summary: Delete a label from a notification endpoint
+ tags:
+ - NotificationEndpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationEndpoints.yaml
+ staticFilePath: >-
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationEndpoints.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/notificationRules
+ - /api/v2/notificationRules/{ruleID}
+ - /api/v2/notificationRules/{ruleID}/labels
+ - /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ - /api/v2/notificationRules/{ruleID}/query
+ title: ''
+ description: API reference for /api/v2/notificationRules
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetNotificationRules
+ method: GET
+ path: /api/v2/notificationRules
+ summary: List all notification rules
+ tags:
+ - NotificationRules
+ - operationId: CreateNotificationRule
+ method: POST
+ path: /api/v2/notificationRules
+ summary: Add a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesID
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Retrieve a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PutNotificationRulesID
+ method: PUT
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Update a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PatchNotificationRulesID
+ method: PATCH
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Update a notification rule
+ tags:
+ - NotificationRules
+ - operationId: DeleteNotificationRulesID
+ method: DELETE
+ path: /api/v2/notificationRules/{ruleID}
+ summary: Delete a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesIDLabels
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}/labels
+ summary: List all labels for a notification rule
+ tags:
+ - NotificationRules
+ - operationId: PostNotificationRuleIDLabels
+ method: POST
+ path: /api/v2/notificationRules/{ruleID}/labels
+ summary: Add a label to a notification rule
+ tags:
+ - NotificationRules
+ - operationId: DeleteNotificationRulesIDLabelsID
+ method: DELETE
+ path: /api/v2/notificationRules/{ruleID}/labels/{labelID}
+ summary: Delete label from a notification rule
+ tags:
+ - NotificationRules
+ - operationId: GetNotificationRulesIDQuery
+ method: GET
+ path: /api/v2/notificationRules/{ruleID}/query
+ summary: Retrieve a notification rule query
+ tags:
+ - Rules
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationRules.yaml
+ staticFilePath: >-
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-notificationRules.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/orgs
+ - /api/v2/orgs/{orgID}
+ - /api/v2/orgs/{orgID}/members
+ - /api/v2/orgs/{orgID}/members/{userID}
+ - /api/v2/orgs/{orgID}/owners
+ - /api/v2/orgs/{orgID}/owners/{userID}
+ - /api/v2/orgs/{orgID}/secrets
+ - /api/v2/orgs/{orgID}/secrets/delete
+ - /api/v2/orgs/{orgID}/secrets/{secretID}
+ title: ''
+ description: API reference for /api/v2/orgs
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetOrgs
+ method: GET
+ path: /api/v2/orgs
+ summary: List organizations
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgs
+ method: POST
+ path: /api/v2/orgs
+ summary: Create an organization
+ tags:
+ - Organizations
+ - operationId: GetOrgsID
+ method: GET
+ path: /api/v2/orgs/{orgID}
+ summary: Retrieve an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PatchOrgsID
+ method: PATCH
+ path: /api/v2/orgs/{orgID}
+ summary: Update an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}
+ summary: Delete an organization
+ tags:
+ - Organizations
+ - operationId: GetOrgsIDMembers
+ method: GET
+ path: /api/v2/orgs/{orgID}/members
+ summary: List all members of an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgsIDMembers
+ method: POST
+ path: /api/v2/orgs/{orgID}/members
+ summary: Add a member to an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsIDMembersID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/members/{userID}
+ summary: Remove a member from an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: GetOrgsIDOwners
+ method: GET
+ path: /api/v2/orgs/{orgID}/owners
+ summary: List all owners of an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: PostOrgsIDOwners
+ method: POST
+ path: /api/v2/orgs/{orgID}/owners
+ summary: Add an owner to an organization
+ tags:
+ - Organizations
+ - operationId: DeleteOrgsIDOwnersID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/owners/{userID}
+ summary: Remove an owner from an organization
+ tags:
+ - Organizations
+ - Security and access endpoints
+ - operationId: GetOrgsIDSecrets
+ method: GET
+ path: /api/v2/orgs/{orgID}/secrets
+ summary: List all secret keys for an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ - operationId: PatchOrgsIDSecrets
+ method: PATCH
+ path: /api/v2/orgs/{orgID}/secrets
+ summary: Update secrets in an organization
+ tags:
+ - Secrets
+ - operationId: PostOrgsIDSecrets
+ method: POST
+ path: /api/v2/orgs/{orgID}/secrets/delete
+ summary: Delete secrets from an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ - operationId: DeleteOrgsIDSecretsID
+ method: DELETE
+ path: /api/v2/orgs/{orgID}/secrets/{secretID}
+ summary: Delete a secret from an organization
+ tags:
+ - Secrets
+ - Security and access endpoints
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-orgs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-orgs.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/query
+ - /api/v2/query/analyze
+ - /api/v2/query/ast
+ - /api/v2/query/suggestions
+ - /api/v2/query/suggestions/{name}
+ title: ''
+ description: API reference for /api/v2/query
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostQuery
+ method: POST
+ path: /api/v2/query
+ summary: Query data
+ tags:
+ - Query data
+ - operationId: PostQueryAnalyze
+ method: POST
+ path: /api/v2/query/analyze
+ summary: Analyze a Flux query
+ tags:
+ - Query data
+ - operationId: PostQueryAst
+ method: POST
+ path: /api/v2/query/ast
+ summary: Generate a query Abstract Syntax Tree (AST)
+ tags:
+ - Query data
+ - operationId: GetQuerySuggestions
+ method: GET
+ path: /api/v2/query/suggestions
+ summary: List Flux query suggestions
+ tags:
+ - Query data
+ - operationId: GetQuerySuggestionsName
+ method: GET
+ path: /api/v2/query/suggestions/{name}
+ summary: Retrieve a query suggestion for a branching suggestion
+ tags:
+ - Query data
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-query.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-query.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/remotes
+ - /api/v2/remotes/{remoteID}
+ title: ''
+ description: API reference for /api/v2/remotes
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetRemoteConnections
+ method: GET
+ path: /api/v2/remotes
+ summary: List all remote connections
+ tags:
+ - RemoteConnections
+ - operationId: PostRemoteConnection
+ method: POST
+ path: /api/v2/remotes
+ summary: Register a new remote connection
+ tags:
+ - RemoteConnections
+ - operationId: GetRemoteConnectionByID
+ method: GET
+ path: /api/v2/remotes/{remoteID}
+ summary: Retrieve a remote connection
+ tags:
+ - RemoteConnections
+ - operationId: PatchRemoteConnectionByID
+ method: PATCH
+ path: /api/v2/remotes/{remoteID}
+ summary: Update a remote connection
+ tags:
+ - RemoteConnections
+ - operationId: DeleteRemoteConnectionByID
+ method: DELETE
+ path: /api/v2/remotes/{remoteID}
+ summary: Delete a remote connection
+ tags:
+ - RemoteConnections
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-remotes.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-remotes.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/replications
+ - /api/v2/replications/{replicationID}
+ - /api/v2/replications/{replicationID}/validate
+ title: ''
+ description: API reference for /api/v2/replications
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetReplications
+ method: GET
+ path: /api/v2/replications
+ summary: List all replications
+ tags:
+ - Replications
+ - operationId: PostReplication
+ method: POST
+ path: /api/v2/replications
+ summary: Register a new replication
+ tags:
+ - Replications
+ - operationId: GetReplicationByID
+ method: GET
+ path: /api/v2/replications/{replicationID}
+ summary: Retrieve a replication
+ tags:
+ - Replications
+ - operationId: PatchReplicationByID
+ method: PATCH
+ path: /api/v2/replications/{replicationID}
+ summary: Update a replication
+ tags:
+ - Replications
+ - operationId: DeleteReplicationByID
+ method: DELETE
+ path: /api/v2/replications/{replicationID}
+ summary: Delete a replication
+ tags:
+ - Replications
+ - operationId: PostValidateReplicationByID
+ method: POST
+ path: /api/v2/replications/{replicationID}/validate
+ summary: Validate a replication
+ tags:
+ - Replications
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-replications.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-replications.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/resources
+ title: ''
+ description: API reference for /api/v2/resources
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetResources
+ method: GET
+ path: /api/v2/resources
+ summary: List all known resources
+ tags:
+ - Resources
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-resources.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/restore/bucket/{bucketID}
+ - /api/v2/restore/bucketMetadata
+ - /api/v2/restore/kv
+ - /api/v2/restore/shards/{shardID}
+ - /api/v2/restore/sql
+ title: ''
+ description: API reference for /api/v2/restore
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostRestoreBucketID
+ method: POST
+ path: /api/v2/restore/bucket/{bucketID}
+ summary: >-
+ Overwrite storage metadata for a bucket with shard info from a
+ backup.
+ tags:
+ - Restore
+ - operationId: PostRestoreBucketMetadata
+ method: POST
+ path: /api/v2/restore/bucketMetadata
+ summary: Create a new bucket pre-seeded with shard info from a backup.
+ tags:
+ - Restore
+ - operationId: PostRestoreKV
+ method: POST
+ path: /api/v2/restore/kv
+ summary: >-
+ Overwrite the embedded KV store on the server with a backed-up
+ snapshot.
+ tags:
+ - Restore
+ - operationId: PostRestoreShardId
+ method: POST
+ path: /api/v2/restore/shards/{shardID}
+ summary: Restore a TSM snapshot into a shard.
+ tags:
+ - Restore
+ - operationId: PostRestoreSQL
+ method: POST
+ path: /api/v2/restore/sql
+ summary: >-
+ Overwrite the embedded SQL store on the server with a backed-up
+ snapshot.
+ tags:
+ - Restore
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-restore.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-restore.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/scrapers
+ - /api/v2/scrapers/{scraperTargetID}
+ - /api/v2/scrapers/{scraperTargetID}/labels
+ - /api/v2/scrapers/{scraperTargetID}/labels/{labelID}
+ - /api/v2/scrapers/{scraperTargetID}/members
+ - /api/v2/scrapers/{scraperTargetID}/members/{userID}
+ - /api/v2/scrapers/{scraperTargetID}/owners
+ - /api/v2/scrapers/{scraperTargetID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/scrapers
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetScrapers
+ method: GET
+ path: /api/v2/scrapers
+ summary: List all scraper targets
+ tags:
+ - Scraper Targets
+ - operationId: PostScrapers
+ method: POST
+ path: /api/v2/scrapers
+ summary: Create a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: GetScrapersID
+ method: GET
+ path: /api/v2/scrapers/{scraperTargetID}
+ summary: Retrieve a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: PatchScrapersID
+ method: PATCH
+ path: /api/v2/scrapers/{scraperTargetID}
+ summary: Update a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: DeleteScrapersID
+ method: DELETE
+ path: /api/v2/scrapers/{scraperTargetID}
+ summary: Delete a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: GetScrapersIDLabels
+ method: GET
+ path: /api/v2/scrapers/{scraperTargetID}/labels
+ summary: List all labels for a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: PostScrapersIDLabels
+ method: POST
+ path: /api/v2/scrapers/{scraperTargetID}/labels
+ summary: Add a label to a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: DeleteScrapersIDLabelsID
+ method: DELETE
+ path: /api/v2/scrapers/{scraperTargetID}/labels/{labelID}
+ summary: Delete a label from a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: GetScrapersIDMembers
+ method: GET
+ path: /api/v2/scrapers/{scraperTargetID}/members
+ summary: List all users with member privileges for a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: PostScrapersIDMembers
+ method: POST
+ path: /api/v2/scrapers/{scraperTargetID}/members
+ summary: Add a member to a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: DeleteScrapersIDMembersID
+ method: DELETE
+ path: /api/v2/scrapers/{scraperTargetID}/members/{userID}
+ summary: Remove a member from a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: GetScrapersIDOwners
+ method: GET
+ path: /api/v2/scrapers/{scraperTargetID}/owners
+ summary: List all owners of a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: PostScrapersIDOwners
+ method: POST
+ path: /api/v2/scrapers/{scraperTargetID}/owners
+ summary: Add an owner to a scraper target
+ tags:
+ - Scraper Targets
+ - operationId: DeleteScrapersIDOwnersID
+ method: DELETE
+ path: /api/v2/scrapers/{scraperTargetID}/owners/{userID}
+ summary: Remove an owner from a scraper target
+ tags:
+ - Scraper Targets
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-scrapers.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-scrapers.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/setup
+ title: ''
+ description: API reference for /api/v2/setup
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetSetup
+ method: GET
+ path: /api/v2/setup
+ summary: Check if database has default user, org, bucket
+ tags:
+ - Setup
+ - operationId: PostSetup
+ method: POST
+ path: /api/v2/setup
+ summary: Set up initial user, org and bucket
+ tags:
+ - Setup
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-setup.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/signin
+ title: ''
+ description: API reference for /api/v2/signin
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostSignin
+ method: POST
+ path: /api/v2/signin
+ summary: Create a user session.
+ tags:
+ - Security and access endpoints
+ - Signin
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signin.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/signout
+ title: ''
+ description: API reference for /api/v2/signout
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostSignout
+ method: POST
+ path: /api/v2/signout
+ summary: Expire a user session
+ tags:
+ - Security and access endpoints
+ - Signout
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-signout.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/sources
+ - /api/v2/sources/{sourceID}
+ - /api/v2/sources/{sourceID}/buckets
+ - /api/v2/sources/{sourceID}/health
+ title: ''
+ description: API reference for /api/v2/sources
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetSources
+ method: GET
+ path: /api/v2/sources
+ summary: List all sources
+ tags:
+ - Sources
+ - operationId: PostSources
+ method: POST
+ path: /api/v2/sources
+ summary: Create a source
+ tags:
+ - Sources
+ - operationId: GetSourcesID
+ method: GET
+ path: /api/v2/sources/{sourceID}
+ summary: Retrieve a source
+ tags:
+ - Sources
+ - operationId: PatchSourcesID
+ method: PATCH
+ path: /api/v2/sources/{sourceID}
+ summary: Update a Source
+ tags:
+ - Sources
+ - operationId: DeleteSourcesID
+ method: DELETE
+ path: /api/v2/sources/{sourceID}
+ summary: Delete a source
+ tags:
+ - Sources
+ - operationId: GetSourcesIDBuckets
+ method: GET
+ path: /api/v2/sources/{sourceID}/buckets
+ summary: Get buckets in a source
+ tags:
+ - Sources
+ - Buckets
+ - operationId: GetSourcesIDHealth
+ method: GET
+ path: /api/v2/sources/{sourceID}/health
+ summary: Get the health of a source
+ tags:
+ - Sources
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-sources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-sources.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/stacks
+ - /api/v2/stacks/{stack_id}
+ - /api/v2/stacks/{stack_id}/uninstall
+ title: ''
+ description: API reference for /api/v2/stacks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: ListStacks
+ method: GET
+ path: /api/v2/stacks
+ summary: List installed stacks
+ tags:
+ - Templates
+ - operationId: CreateStack
+ method: POST
+ path: /api/v2/stacks
+ summary: Create a stack
+ tags:
+ - Templates
+ - operationId: ReadStack
+ method: GET
+ path: /api/v2/stacks/{stack_id}
+ summary: Retrieve a stack
+ tags:
+ - Templates
+ - operationId: UpdateStack
+ method: PATCH
+ path: /api/v2/stacks/{stack_id}
+ summary: Update a stack
+ tags:
+ - Templates
+ - operationId: DeleteStack
+ method: DELETE
+ path: /api/v2/stacks/{stack_id}
+ summary: Delete a stack and associated resources
+ tags:
+ - Templates
+ - operationId: UninstallStack
+ method: POST
+ path: /api/v2/stacks/{stack_id}/uninstall
+ summary: Uninstall a stack
+ tags:
+ - Templates
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-stacks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-stacks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/tasks
+ - /api/v2/tasks/{taskID}
+ - /api/v2/tasks/{taskID}/labels
+ - /api/v2/tasks/{taskID}/labels/{labelID}
+ - /api/v2/tasks/{taskID}/logs
+ - /api/v2/tasks/{taskID}/members
+ - /api/v2/tasks/{taskID}/members/{userID}
+ - /api/v2/tasks/{taskID}/owners
+ - /api/v2/tasks/{taskID}/owners/{userID}
+ - /api/v2/tasks/{taskID}/runs
+ - /api/v2/tasks/{taskID}/runs/{runID}
+ - /api/v2/tasks/{taskID}/runs/{runID}/logs
+ - /api/v2/tasks/{taskID}/runs/{runID}/retry
+ title: ''
+ description: API reference for /api/v2/tasks
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTasks
+ method: GET
+ path: /api/v2/tasks
+ summary: List tasks
+ tags:
+ - Tasks
+ - operationId: PostTasks
+ method: POST
+ path: /api/v2/tasks
+ summary: Create a task
+ tags:
+ - Tasks
+ - operationId: GetTasksID
+ method: GET
+ path: /api/v2/tasks/{taskID}
+ summary: Retrieve a task
+ tags:
+ - Tasks
+ - operationId: PatchTasksID
+ method: PATCH
+ path: /api/v2/tasks/{taskID}
+ summary: Update a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}
+ summary: Delete a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDLabels
+ method: GET
+ path: /api/v2/tasks/{taskID}/labels
+ summary: List labels for a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDLabels
+ method: POST
+ path: /api/v2/tasks/{taskID}/labels
+ summary: Add a label to a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDLabelsID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/labels/{labelID}
+ summary: Delete a label from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDLogs
+ method: GET
+ path: /api/v2/tasks/{taskID}/logs
+ summary: Retrieve all logs for a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDMembers
+ method: GET
+ path: /api/v2/tasks/{taskID}/members
+ summary: List all task members
+ tags:
+ - Tasks
+ - operationId: PostTasksIDMembers
+ method: POST
+ path: /api/v2/tasks/{taskID}/members
+ summary: Add a member to a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDMembersID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/members/{userID}
+ summary: Remove a member from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDOwners
+ method: GET
+ path: /api/v2/tasks/{taskID}/owners
+ summary: List all owners of a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDOwners
+ method: POST
+ path: /api/v2/tasks/{taskID}/owners
+ summary: Add an owner for a task
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDOwnersID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/owners/{userID}
+ summary: Remove an owner from a task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRuns
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs
+ summary: List runs for a task
+ tags:
+ - Tasks
+ - operationId: PostTasksIDRuns
+ method: POST
+ path: /api/v2/tasks/{taskID}/runs
+ summary: Start a task run, overriding the schedule
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRunsID
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs/{runID}
+ summary: Retrieve a run for a task.
+ tags:
+ - Tasks
+ - operationId: DeleteTasksIDRunsID
+ method: DELETE
+ path: /api/v2/tasks/{taskID}/runs/{runID}
+ summary: Cancel a running task
+ tags:
+ - Tasks
+ - operationId: GetTasksIDRunsIDLogs
+ method: GET
+ path: /api/v2/tasks/{taskID}/runs/{runID}/logs
+ summary: Retrieve all logs for a run
+ tags:
+ - Tasks
+ - operationId: PostTasksIDRunsIDRetry
+ method: POST
+ path: /api/v2/tasks/{taskID}/runs/{runID}/retry
+ summary: Retry a task run
+ tags:
+ - Tasks
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-tasks.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/telegraf/plugins
+ title: ''
+ description: API reference for /api/v2/telegraf
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTelegrafPlugins
+ method: GET
+ path: /api/v2/telegraf/plugins
+ summary: List all Telegraf plugins
+ tags:
+ - Telegraf Plugins
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegraf.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegraf.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/telegrafs
+ - /api/v2/telegrafs/{telegrafID}
+ - /api/v2/telegrafs/{telegrafID}/labels
+ - /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ - /api/v2/telegrafs/{telegrafID}/members
+ - /api/v2/telegrafs/{telegrafID}/members/{userID}
+ - /api/v2/telegrafs/{telegrafID}/owners
+ - /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ title: ''
+ description: API reference for /api/v2/telegrafs
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetTelegrafs
+ method: GET
+ path: /api/v2/telegrafs
+ summary: List all Telegraf configurations
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafs
+ method: POST
+ path: /api/v2/telegrafs
+ summary: Create a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsID
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Retrieve a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: PutTelegrafsID
+ method: PUT
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Update a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}
+ summary: Delete a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDLabels
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/labels
+ summary: List all labels for a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDLabels
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/labels
+ summary: Add a label to a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDLabelsID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/labels/{labelID}
+ summary: Delete a label from a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDMembers
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/members
+ summary: List all users with member privileges for a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDMembers
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/members
+ summary: Add a member to a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDMembersID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/members/{userID}
+ summary: Remove a member from a Telegraf config
+ tags:
+ - Telegrafs
+ - operationId: GetTelegrafsIDOwners
+ method: GET
+ path: /api/v2/telegrafs/{telegrafID}/owners
+ summary: List all owners of a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: PostTelegrafsIDOwners
+ method: POST
+ path: /api/v2/telegrafs/{telegrafID}/owners
+ summary: Add an owner to a Telegraf configuration
+ tags:
+ - Telegrafs
+ - operationId: DeleteTelegrafsIDOwnersID
+ method: DELETE
+ path: /api/v2/telegrafs/{telegrafID}/owners/{userID}
+ summary: Remove an owner from a Telegraf config
+ tags:
+ - Telegrafs
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-telegrafs.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/templates/apply
+ - /api/v2/templates/export
+ title: ''
+ description: API reference for /api/v2/templates
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: ApplyTemplate
+ method: POST
+ path: /api/v2/templates/apply
+ summary: Apply or dry-run a template
+ tags:
+ - Templates
+ - operationId: ExportTemplate
+ method: POST
+ path: /api/v2/templates/export
+ summary: Export a new template
+ tags:
+ - Templates
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-templates.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/users
+ - /api/v2/users/{userID}
+ - /api/v2/users/{userID}/password
+ title: ''
+ description: API reference for /api/v2/users
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetUsers
+ method: GET
+ path: /api/v2/users
+ summary: List users
+ tags:
+ - Security and access endpoints
+ - Users
+ - operationId: PostUsers
+ method: POST
+ path: /api/v2/users
+ summary: Create a user
+ tags:
+ - Users
+ - operationId: GetUsersID
+ method: GET
+ path: /api/v2/users/{userID}
+ summary: Retrieve a user
+ tags:
+ - Security and access endpoints
+ - Users
+ - operationId: PatchUsersID
+ method: PATCH
+ path: /api/v2/users/{userID}
+ summary: Update a user
+ tags:
+ - Users
+ - operationId: DeleteUsersID
+ method: DELETE
+ path: /api/v2/users/{userID}
+ summary: Delete a user
+ tags:
+ - Users
+ - operationId: PostUsersIDPassword
+ method: POST
+ path: /api/v2/users/{userID}/password
+ summary: Update a password
+ tags:
+ - Security and access endpoints
+ - Users
+ - operationId: PutUsersIDPassword
+ method: PUT
+ path: /api/v2/users/{userID}/password
+ summary: Update a password
+ tags:
+ - Security and access endpoints
+ - Users
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-users.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-users.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/variables
+ - /api/v2/variables/{variableID}
+ - /api/v2/variables/{variableID}/labels
+ - /api/v2/variables/{variableID}/labels/{labelID}
+ title: ''
+ description: API reference for /api/v2/variables
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetVariables
+ method: GET
+ path: /api/v2/variables
+ summary: List all variables
+ tags:
+ - Variables
+ - operationId: PostVariables
+ method: POST
+ path: /api/v2/variables
+ summary: Create a variable
+ tags:
+ - Variables
+ - operationId: GetVariablesID
+ method: GET
+ path: /api/v2/variables/{variableID}
+ summary: Retrieve a variable
+ tags:
+ - Variables
+ - operationId: PutVariablesID
+ method: PUT
+ path: /api/v2/variables/{variableID}
+ summary: Replace a variable
+ tags:
+ - Variables
+ - operationId: PatchVariablesID
+ method: PATCH
+ path: /api/v2/variables/{variableID}
+ summary: Update a variable
+ tags:
+ - Variables
+ - operationId: DeleteVariablesID
+ method: DELETE
+ path: /api/v2/variables/{variableID}
+ summary: Delete a variable
+ tags:
+ - Variables
+ - operationId: GetVariablesIDLabels
+ method: GET
+ path: /api/v2/variables/{variableID}/labels
+ summary: List all labels for a variable
+ tags:
+ - Variables
+ - operationId: PostVariablesIDLabels
+ method: POST
+ path: /api/v2/variables/{variableID}/labels
+ summary: Add a label to a variable
+ tags:
+ - Variables
+ - operationId: DeleteVariablesIDLabelsID
+ method: DELETE
+ path: /api/v2/variables/{variableID}/labels/{labelID}
+ summary: Delete a label from a variable
+ tags:
+ - Variables
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-variables.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2/write
+ title: ''
+ description: API reference for /api/v2/write
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostWrite
+ method: POST
+ path: /api/v2/write
+ summary: Write data
+ tags:
+ - Write data
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-write.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2-write.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /api/v2
+ title: ''
+ description: API reference for /api/v2
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetRoutes
+ method: GET
+ path: /api/v2
+ summary: List all top level routes
+ tags:
+ - Routes
+ - System information endpoints
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-api-v2.yaml
- path: api/authentication
fields:
name: Authentication
describes: []
title: Authentication
- description: >
+ description: |-
Use one of the following schemes to authenticate to the InfluxDB API:
-
- - [Token authentication](#section/Authentication/TokenAuthentication)
-
- - [Basic authentication](#section/Authentication/BasicAuthentication)
-
- - [Querystring
- authentication](#section/Authentication/QuerystringAuthentication)
-
-
+ - Token authentication
+ - Basic authentication
+ - Querystring authentication
tag: Authentication
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: |-
Use one of the following schemes to authenticate to the InfluxDB API:
-
- - [Token authentication](#section/Authentication/TokenAuthentication)
-
- - [Basic authentication](#section/Authentication/BasicAuthentication)
-
- - [Querystring
- authentication](#section/Authentication/QuerystringAuthentication)
-
-
+ - Token authentication
+ - Basic authentication
+ - Querystring authentication
showSecuritySchemes: true
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authentication.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authentication.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authentication.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authentication.yaml
- path: api/authorizations-api-tokens
fields:
name: Authorizations (API tokens)
@@ -43,7 +1884,7 @@ articles:
- /api/v2/authorizations
- /api/v2/authorizations/{authID}
title: Authorizations (API tokens)
- description: >
+ description: >-
Create and manage authorizations (API tokens).
@@ -75,23 +1916,21 @@ articles:
For more information, see [how to assign a token to a specific
user](/influxdb/v2/security/tokens/create-token/).
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related endpoints
- - [Signin](#tag/Signin)
+ - Signin
- - [Signout](#tag/Signout)
+ - Signout
### Related guides
- - [Authorize API
- requests](/influxdb/v2/api-guide/api_intro/#authentication)
+ - [Authorize API requests](/influxdb/v2/api-guide/api_intro/)
- [Manage API tokens](/influxdb/v2/security/tokens/)
@@ -135,7 +1974,7 @@ articles:
summary: Delete an authorization
tags:
- Authorizations (API tokens)
- tagDescription: >
+ tagDescription: >-
Create and manage authorizations (API tokens).
@@ -167,23 +2006,21 @@ articles:
For more information, see [how to assign a token to a specific
user](/influxdb/v2/security/tokens/create-token/).
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related endpoints
- - [Signin](#tag/Signin)
+ - Signin
- - [Signout](#tag/Signout)
+ - Signout
### Related guides
- - [Authorize API
- requests](/influxdb/v2/api-guide/api_intro/#authentication)
+ - [Authorize API requests](/influxdb/v2/api-guide/api_intro/)
- [Manage API tokens](/influxdb/v2/security/tokens/)
@@ -192,9 +2029,9 @@ articles:
related:
- https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-api-tokens.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-api-tokens.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-api-tokens.yaml
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-api-tokens.yaml
- path: api/authorizations-v1-compatible
fields:
name: Authorizations (v1-compatible)
@@ -245,9 +2082,9 @@ articles:
tags:
- Authorizations (v1-compatible)
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-authorizations-v1-compatible.yaml
- path: api/backup
fields:
name: Backup
@@ -281,8 +2118,8 @@ articles:
summary: Download snapshot of all TSM data in a shard
tags:
- Backup
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-backup.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-backup.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-backup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-backup.yaml
- path: api/buckets
fields:
name: Buckets
@@ -297,15 +2134,13 @@ articles:
- /api/v2/buckets/{bucketID}/owners/{userID}
- /api/v2/sources/{sourceID}/buckets
title: Buckets
- description: >
- Store your data in InfluxDB
- [buckets](/influxdb/v2/reference/glossary/#bucket).
+ description: >-
+ Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/).
A bucket is a named location where time series data is stored. All
buckets
- have a [retention
- period](/influxdb/v2/reference/glossary/#retention-period),
+ have a [retention period](/influxdb/v2/reference/glossary/),
a duration of time that each data point persists. InfluxDB drops all
@@ -412,15 +2247,13 @@ articles:
summary: Get buckets in a source
tags:
- Buckets
- tagDescription: >
- Store your data in InfluxDB
- [buckets](/influxdb/v2/reference/glossary/#bucket).
+ tagDescription: >-
+ Store your data in InfluxDB [buckets](/influxdb/v2/reference/glossary/).
A bucket is a named location where time series data is stored. All
buckets
- have a [retention
- period](/influxdb/v2/reference/glossary/#retention-period),
+ have a [retention period](/influxdb/v2/reference/glossary/),
a duration of time that each data point persists. InfluxDB drops all
@@ -433,8 +2266,8 @@ articles:
- [Manage buckets](/influxdb/v2/organizations/buckets/)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-buckets.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-buckets.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-buckets.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-buckets.yaml
- path: api/cells
fields:
name: Cells
@@ -484,8 +2317,8 @@ articles:
summary: Update the view for a cell
tags:
- Cells
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-cells.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-cells.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-cells.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-cells.yaml
- path: api/checks
fields:
name: Checks
@@ -561,14 +2394,14 @@ articles:
summary: Retrieve a check query
tags:
- Checks
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-checks.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-checks.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-checks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-checks.yaml
- path: api/common-parameters
fields:
name: Common parameters
describes: []
title: Common parameters
- description: >
+ description: >-
To specify resources, some InfluxDB API endpoints require parameters or
properties in the request--for example,
@@ -602,7 +2435,7 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
+ tagDescription: >-
To specify resources, some InfluxDB API endpoints require parameters or
properties in the request--for example,
@@ -633,9 +2466,8 @@ articles:
| `orgID` | 16-byte string | The organization ID
([find your organization](/influxdb/v2/organizations/view-orgs/). |
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-common-parameters.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-common-parameters.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-common-parameters.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-common-parameters.yaml
- path: api/config
fields:
name: Config
@@ -660,8 +2492,8 @@ articles:
summary: Retrieve feature flags
tags:
- Config
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-config.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-config.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-config.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-config.yaml
- path: api/dashboards
fields:
name: Dashboards
@@ -803,70 +2635,8 @@ articles:
summary: Remove an owner from a dashboard
tags:
- Dashboards
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dashboards.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dashboards.yaml
- - path: api/data-i-o-endpoints
- fields:
- name: Data I/O endpoints
- describes:
- - /api/v2/delete
- - /api/v2/query
- - /api/v2/tasks
- - /api/v2/tasks/{taskID}
- - /api/v2/tasks/{taskID}/runs
- - /api/v2/write
- title: Data I/O endpoints
- description: API reference for Data I/O endpoints
- tag: Data I/O endpoints
- isConceptual: false
- menuGroup: Other
- operations:
- - operationId: PostDelete
- method: POST
- path: /api/v2/delete
- summary: Delete data
- tags:
- - Data I/O endpoints
- - operationId: PostQuery
- method: POST
- path: /api/v2/query
- summary: Query data
- tags:
- - Data I/O endpoints
- - operationId: GetTasks
- method: GET
- path: /api/v2/tasks
- summary: List tasks
- tags:
- - Data I/O endpoints
- - operationId: PostTasks
- method: POST
- path: /api/v2/tasks
- summary: Create a task
- tags:
- - Data I/O endpoints
- - operationId: GetTasksID
- method: GET
- path: /api/v2/tasks/{taskID}
- summary: Retrieve a task
- tags:
- - Data I/O endpoints
- - operationId: PostTasksIDRuns
- method: POST
- path: /api/v2/tasks/{taskID}/runs
- summary: Start a task run, overriding the schedule
- tags:
- - Data I/O endpoints
- - operationId: PostWrite
- method: POST
- path: /api/v2/write
- summary: Write data
- tags:
- - Data I/O endpoints
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-data-i-o-endpoints.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-data-i-o-endpoints.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dashboards.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dashboards.yaml
- path: api/dbrps
fields:
name: DBRPs
@@ -874,12 +2644,11 @@ articles:
- /api/v2/dbrps
- /api/v2/dbrps/{dbrpID}
title: DBRPs
- description: >
+ description: >-
The InfluxDB 1.x data model includes
- [databases](/influxdb/v2/reference/glossary/#database)
+ [databases](/influxdb/v2/reference/glossary/)
- and [retention
- policies](/influxdb/v2/reference/glossary/#retention-policy-rp).
+ and [retention policies](/influxdb/v2/reference/glossary/).
InfluxDB 2.x replaces databases and retention policies with buckets.
@@ -934,12 +2703,11 @@ articles:
summary: Delete a database retention policy
tags:
- DBRPs
- tagDescription: >
+ tagDescription: >-
The InfluxDB 1.x data model includes
- [databases](/influxdb/v2/reference/glossary/#database)
+ [databases](/influxdb/v2/reference/glossary/)
- and [retention
- policies](/influxdb/v2/reference/glossary/#retention-policy-rp).
+ and [retention policies](/influxdb/v2/reference/glossary/).
InfluxDB 2.x replaces databases and retention policies with buckets.
@@ -960,8 +2728,218 @@ articles:
- [Database and retention policy
mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dbrps.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-dbrps.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dbrps.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-dbrps.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/all
+ title: ''
+ description: API reference for /debug/pprof/all
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofAllProfiles
+ method: GET
+ path: /debug/pprof/all
+ summary: Retrieve all runtime profiles
+ tags:
+ - Debug
+ - System information endpoints
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-all.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-all.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/allocs
+ title: ''
+ description: API reference for /debug/pprof/allocs
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofAllocs
+ method: GET
+ path: /debug/pprof/allocs
+ summary: Retrieve the memory allocations runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-allocs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-allocs.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/block
+ title: ''
+ description: API reference for /debug/pprof/block
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofBlock
+ method: GET
+ path: /debug/pprof/block
+ summary: Retrieve the block runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-block.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-block.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/cmdline
+ title: ''
+ description: API reference for /debug/pprof/cmdline
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofCmdline
+ method: GET
+ path: /debug/pprof/cmdline
+ summary: Retrieve the command line invocation
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-cmdline.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-cmdline.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/goroutine
+ title: ''
+ description: API reference for /debug/pprof/goroutine
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofGoroutine
+ method: GET
+ path: /debug/pprof/goroutine
+ summary: Retrieve the goroutines runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-goroutine.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-goroutine.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/heap
+ title: ''
+ description: API reference for /debug/pprof/heap
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofHeap
+ method: GET
+ path: /debug/pprof/heap
+ summary: Retrieve the heap runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-heap.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-heap.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/mutex
+ title: ''
+ description: API reference for /debug/pprof/mutex
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofMutex
+ method: GET
+ path: /debug/pprof/mutex
+ summary: Retrieve the mutual exclusion (mutex) runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-mutex.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-mutex.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/profile
+ title: ''
+ description: API reference for /debug/pprof/profile
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofProfile
+ method: GET
+ path: /debug/pprof/profile
+ summary: Retrieve the CPU runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-profile.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-profile.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/threadcreate
+ title: ''
+ description: API reference for /debug/pprof/threadcreate
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofThreadCreate
+ method: GET
+ path: /debug/pprof/threadcreate
+ summary: Retrieve the threadcreate runtime profile
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-threadcreate.yaml
+ staticFilePath: >-
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-threadcreate.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /debug/pprof/trace
+ title: ''
+ description: API reference for /debug/pprof/trace
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetDebugPprofTrace
+ method: GET
+ path: /debug/pprof/trace
+ summary: Retrieve the runtime execution trace
+ tags:
+ - Debug
+ - System information endpoints
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-trace.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug-pprof-trace.yaml
- path: api/debug
fields:
name: Debug
@@ -977,7 +2955,7 @@ articles:
- /debug/pprof/threadcreate
- /debug/pprof/trace
title: Debug
- description: >
+ description: >-
Generate profiling and trace reports.
@@ -1065,7 +3043,7 @@ articles:
summary: Retrieve the runtime execution trace
tags:
- Debug
- tagDescription: >
+ tagDescription: >-
Generate profiling and trace reports.
@@ -1089,16 +3067,15 @@ articles:
- [Google pprof tool](https://github.com/google/pprof)
- [Golang diagnostics](https://go.dev/doc/diagnostics)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-debug.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-debug.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-debug.yaml
- path: api/delete
fields:
name: Delete
describes:
- /api/v2/delete
title: Delete
- description: |
- Delete data from an InfluxDB bucket.
+ description: Delete data from an InfluxDB bucket.
tag: Delete
isConceptual: false
menuGroup: Other
@@ -1109,16 +3086,15 @@ articles:
summary: Delete data
tags:
- Delete
- tagDescription: |
- Delete data from an InfluxDB bucket.
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-delete.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-delete.yaml
+ tagDescription: Delete data from an InfluxDB bucket.
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-delete.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-delete.yaml
- path: api/headers
fields:
name: Headers
describes: []
title: Headers
- description: >
+ description: >-
InfluxDB HTTP API endpoints use standard HTTP request and response
headers.
@@ -1154,7 +3130,7 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
+ tagDescription: >-
InfluxDB HTTP API endpoints use standard HTTP request and response
headers.
@@ -1186,8 +3162,8 @@ articles:
| `Content-Type` | string | The format of the
data in the request body. |
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-headers.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-headers.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-headers.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-headers.yaml
- path: api/health
fields:
name: Health
@@ -1205,8 +3181,8 @@ articles:
summary: Retrieve the health of the instance
tags:
- Health
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-health.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-health.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-health.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-health.yaml
- path: api/labels
fields:
name: Labels
@@ -1249,8 +3225,60 @@ articles:
summary: Delete a label
tags:
- Labels
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-labels.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-labels.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-labels.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-labels.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /legacy/authorizations
+ - /legacy/authorizations/{authID}
+ - /legacy/authorizations/{authID}/password
+ title: ''
+ description: API reference for /legacy/authorizations
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetLegacyAuthorizations
+ method: GET
+ path: /legacy/authorizations
+ summary: List all legacy authorizations
+ tags:
+ - Authorizations (v1-compatible)
+ - operationId: PostLegacyAuthorizations
+ method: POST
+ path: /legacy/authorizations
+ summary: Create a legacy authorization
+ tags:
+ - Authorizations (v1-compatible)
+ - operationId: GetLegacyAuthorizationsID
+ method: GET
+ path: /legacy/authorizations/{authID}
+ summary: Retrieve a legacy authorization
+ tags:
+ - Authorizations (v1-compatible)
+ - operationId: PatchLegacyAuthorizationsID
+ method: PATCH
+ path: /legacy/authorizations/{authID}
+ summary: Update a legacy authorization to be active or inactive
+ tags:
+ - Authorizations (v1-compatible)
+ - operationId: DeleteLegacyAuthorizationsID
+ method: DELETE
+ path: /legacy/authorizations/{authID}
+ summary: Delete a legacy authorization
+ tags:
+ - Authorizations (v1-compatible)
+ - operationId: PostLegacyAuthorizationsIDPassword
+ method: POST
+ path: /legacy/authorizations/{authID}/password
+ summary: Set a legacy authorization password
+ tags:
+ - Authorizations (v1-compatible)
+ source: >-
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-legacy-authorizations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-legacy-authorizations.yaml
- path: api/metrics
fields:
name: Metrics
@@ -1268,8 +3296,8 @@ articles:
summary: Retrieve workload performance metrics
tags:
- Metrics
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-metrics.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-metrics.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-metrics.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-metrics.yaml
- path: api/notificationendpoints
fields:
name: NotificationEndpoints
@@ -1339,9 +3367,8 @@ articles:
tags:
- NotificationEndpoints
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationendpoints.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationendpoints.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationendpoints.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationendpoints.yaml
- path: api/notificationrules
fields:
name: NotificationRules
@@ -1411,9 +3438,8 @@ articles:
tags:
- NotificationRules
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationrules.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-notificationrules.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationrules.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-notificationrules.yaml
- path: api/organizations
fields:
name: Organizations
@@ -1425,9 +3451,9 @@ articles:
- /api/v2/orgs/{orgID}/owners
- /api/v2/orgs/{orgID}/owners/{userID}
title: Organizations
- description: >
+ description: >-
Create and manage your
- [organizations](/influxdb/v2/reference/glossary/#organization).
+ [organizations](/influxdb/v2/reference/glossary/).
An organization is a workspace for a group of users. Organizations can
be
@@ -1509,9 +3535,9 @@ articles:
summary: Remove an owner from an organization
tags:
- Organizations
- tagDescription: >
+ tagDescription: >-
Create and manage your
- [organizations](/influxdb/v2/reference/glossary/#organization).
+ [organizations](/influxdb/v2/reference/glossary/).
An organization is a workspace for a group of users. Organizations can
be
@@ -1523,17 +3549,16 @@ articles:
Use the `/api/v2/orgs` endpoints to create, view, and manage
organizations.
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-organizations.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-organizations.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-organizations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-organizations.yaml
- path: api/pagination
fields:
name: Pagination
describes: []
title: Pagination
- description: >
- Some InfluxDB API [list operations](#tag/SupportedOperations) may
- support the following query parameters for paginating results:
+ description: >-
+ Some InfluxDB API list operations may support the following query
+ parameters for paginating results:
| Query parameter | Value type |
@@ -1586,9 +3611,9 @@ articles:
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: >
- Some InfluxDB API [list operations](#tag/SupportedOperations) may
- support the following query parameters for paginating results:
+ tagDescription: >-
+ Some InfluxDB API list operations may support the following query
+ parameters for paginating results:
| Query parameter | Value type |
@@ -1637,8 +3662,8 @@ articles:
"buckets": []
}
```
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-pagination.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-pagination.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-pagination.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-pagination.yaml
- path: api/ping
fields:
name: Ping
@@ -1662,8 +3687,8 @@ articles:
summary: Get the status of the instance
tags:
- Ping
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ping.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ping.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ping.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ping.yaml
- path: api/query-data-v1-compatible
fields:
name: Query data (v1-compatible)
@@ -1688,65 +3713,88 @@ articles:
tags:
- Query data (v1-compatible)
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query-data-v1-compatible.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data-v1-compatible.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query-data-v1-compatible.yaml
- - path: api/query
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data-v1-compatible.yaml
+ - path: api/query-data
fields:
- name: Query
+ name: Query data
describes:
- /api/v2/query
- /api/v2/query/analyze
- /api/v2/query/ast
- /api/v2/query/suggestions
- /api/v2/query/suggestions/{name}
- title: Query
- description: |
- Retrieve data, analyze queries, and get query suggestions.
- tag: Query
+ title: Query data
+ description: Retrieve data, analyze queries, and get query suggestions.
+ tag: Query data
isConceptual: false
- menuGroup: Other
+ menuGroup: Data Operations
operations:
- operationId: PostQuery
method: POST
path: /api/v2/query
summary: Query data
tags:
- - Query
+ - Query data
- operationId: PostQueryAnalyze
method: POST
path: /api/v2/query/analyze
summary: Analyze a Flux query
tags:
- - Query
+ - Query data
- operationId: PostQueryAst
method: POST
path: /api/v2/query/ast
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- - Query
+ - Query data
- operationId: GetQuerySuggestions
method: GET
path: /api/v2/query/suggestions
summary: List Flux query suggestions
tags:
- - Query
+ - Query data
- operationId: GetQuerySuggestionsName
method: GET
path: /api/v2/query/suggestions/{name}
summary: Retrieve a query suggestion for a branching suggestion
tags:
- - Query
- tagDescription: |
- Retrieve data, analyze queries, and get query suggestions.
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-query.yaml
+ - Query data
+ tagDescription: Retrieve data, analyze queries, and get query suggestions.
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query-data.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /query
+ title: ''
+ description: API reference for /query
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: GetLegacyQuery
+ method: GET
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data (v1-compatible)
+ - operationId: PostQueryV1
+ method: POST
+ path: /query
+ summary: Execute InfluxQL query (v1-compatible)
+ tags:
+ - Query data (v1-compatible)
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-query.yaml
- path: api/quick-start
fields:
name: Quick start
describes: []
title: Quick start
- description: >
+ description: >-
See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets,
@@ -1762,7 +3810,7 @@ articles:
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: >-
See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets,
@@ -1774,9 +3822,8 @@ articles:
are available for popular languages and ready to import into your
application.
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-quick-start.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-quick-start.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-quick-start.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-quick-start.yaml
- path: api/ready
fields:
name: Ready
@@ -1794,8 +3841,8 @@ articles:
summary: Get the readiness of an instance at startup
tags:
- Ready
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ready.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-ready.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ready.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-ready.yaml
- path: api/remoteconnections
fields:
name: RemoteConnections
@@ -1839,9 +3886,8 @@ articles:
tags:
- RemoteConnections
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-remoteconnections.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-remoteconnections.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-remoteconnections.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-remoteconnections.yaml
- path: api/replications
fields:
name: Replications
@@ -1891,9 +3937,8 @@ articles:
summary: Validate a replication
tags:
- Replications
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-replications.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-replications.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-replications.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-replications.yaml
- path: api/resources
fields:
name: Resources
@@ -1911,14 +3956,14 @@ articles:
summary: List all known resources
tags:
- Resources
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-resources.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-resources.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-resources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-resources.yaml
- path: api/response-codes
fields:
name: Response codes
describes: []
title: Response codes
- description: >
+ description: >-
InfluxDB HTTP API endpoints use standard HTTP status codes for success
and failure responses.
@@ -1981,7 +4026,7 @@ articles:
isConceptual: true
menuGroup: Concepts
operations: []
- tagDescription: >
+ tagDescription: >-
InfluxDB HTTP API endpoints use standard HTTP status codes for success
and failure responses.
@@ -2040,9 +4085,8 @@ articles:
| `503` | Service unavailable | Server is temporarily
unavailable to process the request. The `Retry-After` header describes
when to try the request again. |
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-response-codes.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-response-codes.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-response-codes.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-response-codes.yaml
- path: api/restore
fields:
name: Restore
@@ -2094,8 +4138,8 @@ articles:
snapshot.
tags:
- Restore
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-restore.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-restore.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-restore.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-restore.yaml
- path: api/routes
fields:
name: Routes
@@ -2113,8 +4157,8 @@ articles:
summary: List all top level routes
tags:
- Routes
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-routes.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-routes.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-routes.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-routes.yaml
- path: api/rules
fields:
name: Rules
@@ -2132,8 +4176,8 @@ articles:
summary: Retrieve a notification rule query
tags:
- Rules
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-rules.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-rules.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-rules.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-rules.yaml
- path: api/scraper-targets
fields:
name: Scraper Targets
@@ -2236,9 +4280,8 @@ articles:
summary: Remove an owner from a scraper target
tags:
- Scraper Targets
- source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-scraper-targets.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-scraper-targets.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-scraper-targets.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-scraper-targets.yaml
- path: api/secrets
fields:
name: Secrets
@@ -2276,8 +4319,8 @@ articles:
summary: Delete secrets from an organization
tags:
- Secrets
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-secrets.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-secrets.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-secrets.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-secrets.yaml
- path: api/security-and-access-endpoints
fields:
name: Security and access endpoints
@@ -2431,9 +4474,9 @@ articles:
related:
- https://docs.influxdata.com/influxdb/v2/security/tokens/view-tokens/
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-security-and-access-endpoints.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-security-and-access-endpoints.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-security-and-access-endpoints.yaml
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-security-and-access-endpoints.yaml
- path: api/setup
fields:
name: Setup
@@ -2457,8 +4500,8 @@ articles:
summary: Set up initial user, org and bucket
tags:
- Setup
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-setup.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-setup.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-setup.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-setup.yaml
- path: api/signin
fields:
name: Signin
@@ -2476,8 +4519,8 @@ articles:
summary: Create a user session.
tags:
- Signin
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signin.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signin.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signin.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signin.yaml
- path: api/signout
fields:
name: Signout
@@ -2495,8 +4538,8 @@ articles:
summary: Expire a user session
tags:
- Signout
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signout.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-signout.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signout.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-signout.yaml
- path: api/sources
fields:
name: Sources
@@ -2553,23 +4596,22 @@ articles:
summary: Get the health of a source
tags:
- Sources
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-sources.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-sources.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-sources.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-sources.yaml
- path: api/supported-operations
fields:
name: Supported operations
describes: []
title: Supported operations
- description: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n"
+ description: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |"
tag: Supported operations
isConceptual: true
menuGroup: Other
operations: []
- tagDescription: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |\n"
+ tagDescription: "The following table shows the most common operations that the InfluxDB `/api/v2` API supports.\nSome resources may support other operations that perform functions more specific to those resources.\nFor example, you can use the `PATCH /api/v2/scripts` endpoint to update properties of a script\nresource.\n\n| Operation | |\n|:----------|:-----------------------------------------------------------------------|\n| Write | Writes (`POST`) data to a bucket. |\n| Run | Executes (`POST`) a query or script and returns the result. |\n| List |\tRetrieves (`GET`) a list of zero or more resources. |\n| Create |\tCreates (`POST`) a new resource and returns the resource. |\n| Update |\tModifies (`PUT`) an existing resource to reflect data in your request. |\n| Delete |\tRemoves (`DELETE`) a specific resource. |"
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-supported-operations.yaml
- staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-supported-operations.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-supported-operations.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-supported-operations.yaml
- path: api/system-information-endpoints
fields:
name: System information endpoints
@@ -2700,9 +4742,9 @@ articles:
tags:
- System information endpoints
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-system-information-endpoints.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-system-information-endpoints.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-system-information-endpoints.yaml
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-system-information-endpoints.yaml
- path: api/tasks
fields:
name: Tasks
@@ -2721,9 +4763,9 @@ articles:
- /api/v2/tasks/{taskID}/runs/{runID}/logs
- /api/v2/tasks/{taskID}/runs/{runID}/retry
title: Tasks
- description: >
+ description: >-
Process and analyze your data with
- [tasks](/influxdb/v2/reference/glossary/#task)
+ [tasks](/influxdb/v2/reference/glossary/)
in the InfluxDB task engine.
@@ -2734,8 +4776,8 @@ articles:
To configure a task, provide the script and the schedule to run the
task.
- For examples, see how to create a task with the [`POST /api/v2/tasks`
- endpoint](#operation/PostTasks).
+ For examples, see how to create a task with the `POST /api/v2/tasks`
+ endpoint.
@@ -2891,9 +4933,9 @@ articles:
summary: Retry a task run
tags:
- Tasks
- tagDescription: >
+ tagDescription: >-
Process and analyze your data with
- [tasks](/influxdb/v2/reference/glossary/#task)
+ [tasks](/influxdb/v2/reference/glossary/)
in the InfluxDB task engine.
@@ -2904,8 +4946,8 @@ articles:
To configure a task, provide the script and the schedule to run the
task.
- For examples, see how to create a task with the [`POST /api/v2/tasks`
- endpoint](#operation/PostTasks).
+ For examples, see how to create a task with the `POST /api/v2/tasks`
+ endpoint.
@@ -2931,8 +4973,8 @@ articles:
- [Common data processing
tasks](/influxdb/v2/process-data/common-tasks/)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-tasks.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-tasks.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-tasks.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-tasks.yaml
- path: api/telegraf-plugins
fields:
name: Telegraf Plugins
@@ -2951,8 +4993,8 @@ articles:
tags:
- Telegraf Plugins
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegraf-plugins.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegraf-plugins.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegraf-plugins.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegraf-plugins.yaml
- path: api/telegrafs
fields:
name: Telegrafs
@@ -3055,8 +5097,8 @@ articles:
summary: Remove an owner from a Telegraf config
tags:
- Telegrafs
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegrafs.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-telegrafs.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegrafs.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-telegrafs.yaml
- path: api/templates
fields:
name: Templates
@@ -3067,7 +5109,7 @@ articles:
- /api/v2/templates/apply
- /api/v2/templates/export
title: Templates
- description: >
+ description: >-
Export and apply InfluxDB **templates**.
Manage **stacks** of templated InfluxDB resources.
@@ -3164,7 +5206,7 @@ articles:
summary: Export a new template
tags:
- Templates
- tagDescription: >
+ tagDescription: >-
Export and apply InfluxDB **templates**.
Manage **stacks** of templated InfluxDB resources.
@@ -3209,8 +5251,8 @@ articles:
- [InfluxDB stacks](/influxdb/v2/influxdb-templates/stacks/)
- [InfluxDB templates](/influxdb/v2/influxdb-templates/)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-templates.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-templates.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-templates.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-templates.yaml
- path: api/users
fields:
name: Users
@@ -3221,7 +5263,7 @@ articles:
- /api/v2/users/{userID}
- /api/v2/users/{userID}/password
title: Users
- description: >
+ description: >-
Manage users for your organization.
Users are those with access to InfluxDB.
@@ -3243,8 +5285,7 @@ articles:
the session carries the permissions granted by all the user's
authorizations.
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related guides
@@ -3253,7 +5294,7 @@ articles:
- [Manage users](/influxdb/v2/influxdb/v2/users/)
- [Create a token scoped to a
- user](/influxdb/v2/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user)
+ user](/influxdb/v2/latest/security/tokens/create-token/)
tag: Users
isConceptual: false
menuGroup: Other
@@ -3312,7 +5353,7 @@ articles:
summary: Update a password
tags:
- Users
- tagDescription: >
+ tagDescription: >-
Manage users for your organization.
Users are those with access to InfluxDB.
@@ -3334,8 +5375,7 @@ articles:
the session carries the permissions granted by all the user's
authorizations.
- To create a user session, use the [`POST /api/v2/signin`
- endpoint](#operation/PostSignin).
+ To create a user session, use the `POST /api/v2/signin` endpoint.
### Related guides
@@ -3344,9 +5384,9 @@ articles:
- [Manage users](/influxdb/v2/influxdb/v2/users/)
- [Create a token scoped to a
- user](/influxdb/v2/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user)
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-users.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-users.yaml
+ user](/influxdb/v2/latest/security/tokens/create-token/)
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-users.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-users.yaml
- path: api/variables
fields:
name: Variables
@@ -3415,8 +5455,8 @@ articles:
summary: Delete a label from a variable
tags:
- Variables
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-variables.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-variables.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-variables.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-variables.yaml
- path: api/views
fields:
name: Views
@@ -3440,8 +5480,8 @@ articles:
summary: Update the view for a cell
tags:
- Views
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-views.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-views.yaml
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-views.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-views.yaml
- path: api/write-data-v1-compatible
fields:
name: Write data (v1-compatible)
@@ -3460,30 +5500,45 @@ articles:
tags:
- Write data (v1-compatible)
source: >-
- static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write-data-v1-compatible.yaml
+ static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data-v1-compatible.yaml
staticFilePath: >-
- /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write-data-v1-compatible.yaml
- - path: api/write
+ /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data-v1-compatible.yaml
+ - path: api/write-data
fields:
- name: Write
+ name: Write data
describes:
- /api/v2/write
- title: Write
- description: >
- Write time series data to
- [buckets](/influxdb/v2/reference/glossary/#bucket).
- tag: Write
+ title: Write data
+ description: Write time series data to [buckets](/influxdb/v2/reference/glossary/).
+ tag: Write data
isConceptual: false
- menuGroup: Other
+ menuGroup: Data Operations
operations:
- operationId: PostWrite
method: POST
path: /api/v2/write
summary: Write data
tags:
- - Write
- tagDescription: >
- Write time series data to
- [buckets](/influxdb/v2/reference/glossary/#bucket).
- source: static/openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write.yaml
- staticFilePath: /openapi/influxdb-oss-v2/tags/tags/influxdb-oss-v2-write.yaml
+ - Write data
+ tagDescription: Write time series data to [buckets](/influxdb/v2/reference/glossary/).
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write-data.yaml
+ - path: api/
+ fields:
+ name: ''
+ describes:
+ - /write
+ title: ''
+ description: API reference for /write
+ tag: ''
+ isConceptual: false
+ menuGroup: Other
+ operations:
+ - operationId: PostLegacyWrite
+ method: POST
+ path: /write
+ summary: Write data using a v1-compatible request
+ tags:
+ - Write data (v1-compatible)
+ source: static/openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write.yaml
+ staticFilePath: /openapi/influxdb-oss-v2/tags/influxdb-oss-v2-write.yaml