diff --git a/.circleci/config.yml b/.circleci/config.yml index 556ee8200..e0ee7ca74 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -2,7 +2,7 @@ version: 2 jobs: build: docker: - - image: cimg/node:20.11.1 + - image: cimg/node:20.12.1 environment: S3DEPLOY_VERSION: "2.11.0" # From https://github.com/bep/s3deploy/releases @@ -49,7 +49,7 @@ jobs: deploy: docker: - - image: cimg/go:1.22.1 + - image: cimg/go:1.22.2 steps: - checkout - restore_cache: diff --git a/.gitignore b/.gitignore index 30ad3184b..9448e9d4f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ node_modules *.log /resources .hugo_build.lock -/content/influxdb/*/api/*.html +/content/influxdb/*/api/**/*.html /api-docs/redoc-static.html* .vscode/* .idea diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c40c52b05..aa8dbf62e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1195,7 +1195,7 @@ the content of the banner. {{< influxdbu >}} - + {{< influxdbu "influxdb-101" >}} diff --git a/README.md b/README.md index b9ed7737e..d24564c76 100644 --- a/README.md +++ b/README.md @@ -52,3 +52,16 @@ including our GPG key, can be found at https://www.influxdata.com/how-to-report- npx hugo server ``` 5. View the docs at [localhost:1313](http://localhost:1313). + +### Alternative: Use docker compose + +1. Clone this repository to your local machine. See how to [clone a repository](https://help.github.com/articles/cloning-a-repository/). + +2. Follow the instructions to [install Docker Desktop](https://docs.docker.com/desktop/) and [Docker Compose](https://docs.docker.com/compose/) to your local machine. + +3. Use Docker Compose to start the Hugo server in development mode--for example, enter the following command in your terminal: + + ```sh + docker compose up local-dev + ``` +4. View the docs at [localhost:1313](http://localhost:1313). diff --git a/api-docs/.redocly.yaml b/api-docs/.config.yml similarity index 100% rename from api-docs/.redocly.yaml rename to api-docs/.config.yml diff --git a/api-docs/cloud-dedicated/.config.yml b/api-docs/cloud-dedicated/.config.yml new file mode 100644 index 000000000..6d7fb6c01 --- /dev/null +++ b/api-docs/cloud-dedicated/.config.yml @@ -0,0 +1,15 @@ +plugins: + - '../openapi/plugins/docs-plugin.js' +extends: + - recommended + - docs/all +x-influxdata-product-name: InfluxDB v3 Cloud Dedicated + +apis: + management@0: + root: management/openapi.yml + v2@2: + root: v2/ref.yml + x-influxdata-default: true + v1-compatibility@2: + root: v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/cloud-dedicated/content/info.yml b/api-docs/cloud-dedicated/content/info.yml deleted file mode 100644 index 13a449cd6..000000000 --- a/api-docs/cloud-dedicated/content/info.yml +++ /dev/null @@ -1,7 +0,0 @@ -title: InfluxDB Cloud Dedicated API Service -description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. -version: InfluxDB v3.0 -license: - name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file diff --git a/api-docs/cloud-dedicated/management/content/info.yml b/api-docs/cloud-dedicated/management/content/info.yml new file mode 100644 index 000000000..070217abb --- /dev/null +++ b/api-docs/cloud-dedicated/management/content/info.yml @@ -0,0 +1,11 @@ +title: InfluxDB Cloud Dedicated Management API +summary: | + The Management API for InfluxDB Cloud Dedicated provides a programmatic interface for managing an InfluxDB Cloud Dedicated instance. +description: | + The InfluxDB v3 Management API lets you manage an InfluxDB Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. + + This documentation is generated from the + InfluxDB OpenAPI specification. +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud-dedicated/management/content/servers.yml b/api-docs/cloud-dedicated/management/content/servers.yml new file mode 100644 index 000000000..340d273d8 --- /dev/null +++ b/api-docs/cloud-dedicated/management/content/servers.yml @@ -0,0 +1,8 @@ +- url: 'https://{baseurl}/api/v0' + description: InfluxDB Cloud Dedicated Management API URL + variables: + baseurl: + enum: + - 'console.influxdata.com' + default: 'console.influxdata.com' + description: InfluxDB Cloud Dedicated Console URL diff --git a/api-docs/cloud-dedicated/management/content/tag-groups.yml b/api-docs/cloud-dedicated/management/content/tag-groups.yml new file mode 100644 index 000000000..775a53762 --- /dev/null +++ b/api-docs/cloud-dedicated/management/content/tag-groups.yml @@ -0,0 +1,6 @@ +- name: Using the Management API + tags: + - Authentication + - Examples +- name: All endpoints + tags: [] diff --git a/api-docs/cloud-dedicated/management/openapi.yml b/api-docs/cloud-dedicated/management/openapi.yml new file mode 100644 index 000000000..5cbbaabf5 --- /dev/null +++ b/api-docs/cloud-dedicated/management/openapi.yml @@ -0,0 +1,1932 @@ +openapi: 3.1.0 +info: + title: InfluxDB Cloud Dedicated Management API + description: | + The InfluxDB v3 Management API lets you manage an InfluxDB Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application. + + This documentation is generated from the + InfluxDB OpenAPI specification. + summary: | + The Management API for InfluxDB Cloud Dedicated provides a programmatic interface for managing an InfluxDB Cloud Dedicated instance. + license: + name: MIT + url: https://opensource.org/licenses/MIT + version: '' +servers: + - url: https://{baseurl}/api/v0 + description: InfluxDB Cloud Dedicated Management API URL + variables: + baseurl: + enum: + - console.influxdata.com + default: console.influxdata.com + description: InfluxDB Cloud Dedicated Console URL +security: + - bearerAuthManagementToken: [] + bearerAuthJwt: [] +tags: + - name: Authentication + x-traitTag: true + description: | + InfluxDB Management API endpoints require the `Authorization` header with a [management token](/influxdb/cloud-dedicated/admin/tokens/management/). + + By default, management tokens in InfluxDB v3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider. + - name: Database tokens + description: Manage database read/write tokens for a cluster + - name: Databases + description: Manage databases for a cluster + - name: Example + x-traitTag: true + description: | + The following example script shows how to use `curl` to make database and token management requests: + + ```shell + #!/bin/bash + + # Usage: + # Note the leading space in the command below to keep secrets out of the shell history + # + # ``` + # MANAGEMENT_TOKEN= ACCOUNT_ID= CLUSTER_ID= ./scripts/test_http_api_v0_endpoints.sh + # ``` + + # Env var validation + if [ -z "${MANAGEMENT_TOKEN}" ]; then + echo " + [Error]: ❌ + \$MANAGEMENT_TOKEN env var is required. + " + exit 1 + fi + + if [ -z "${ACCOUNT_ID}" ]; then + echo " + [Error]: ❌ + \$ACCOUNT_ID env var is required. + " + exit 1 + fi + + if [ -z "${CLUSTER_ID}" ]; then + echo " + [Error]: ❌ + \$CLUSTER_ID env var is required. + " + exit 1 + fi + + domain="https://console.influxdata.com" + + # Database request functions + list_databases () { + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + # Token request functions + list_tokens () { + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + create_token () { + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my test token", + "permissions": [ + { + "action": "write", + "resource": "database_one" + }, + { + "action": "read", + "resource": "database_two" + } + ] + }' \ + ) + echo "$response" + } + + get_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + update_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "my updated test token", + "permissions": [ + { + "action": "database_one", + "resource": "read" + } + ] + }' \ + ) + echo "$response" + } + + delete_token () { + local token_id=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + + + # Test database endpoints + databaseName="test_database_$RANDOM" + + printf "\n🏗️ Creating database... 🏗️\n\n" + response="$(create_database $databaseName)" + echo $response | jq + printf "\n🏗️ Creating database successful 🏗️\n\n" + + printf "\n⬆️ Updating database... ⬆️\n\n" + response="$(update_database $databaseName)" + echo $response | jq + printf "\n⬆️ Updating database successful ⬆️\n\n" + + printf "\n⬇️ Listing databases... ⬇️\n\n" + response="$(list_databases)" + echo $response | jq + printf "\n⬇️ Listing databases successful ⬇️\n\n" + + printf "\n🗑️ Deleting database... 🗑️\n\n" + response="$(delete_database $databaseName)" + echo $response | jq + printf "\n🗑️ Deleting database successful 🗑️\n\n" + + + # Test token endpoints + printf "\n🏗️ Creating token... 🏗️\n\n" + response="$(create_token)" + echo $response | jq + tokenId=$(echo $response | jq '.id') + printf "\n🏗️ Creating token successful 🏗️\n\n" + + printf "\n⬇️ Getting token... ⬇️\n\n" + response="$(get_token $tokenId)" + echo $response | jq + printf "\n⬇️ Getting token successful ⬇️\n\n" + + printf "\n⬆️ Updating token... ⬆️\n\n" + response="$(update_token $tokenId)" + echo $response | jq + printf "\n⬆️ Updating token successful ⬆️\n\n" + + printf "\n📋 Listing tokens... 📋\n\n" + response="$(list_tokens)" + echo $response | jq + printf "\n📋 Listing tokens successful 📋\n\n" + + printf "\n🗑️ Deleting token... 🗑️\n\n" + response="$(delete_token $tokenId)" + echo $response | jq + printf "\n🗑️ Deleting token successful 🗑️\n\n" + ``` + - name: Tables + description: Manage tables in a database +paths: + /accounts/{accountId}/clusters/{clusterId}/databases: + get: + operationId: GetClusterDatabases + summary: Get all databases for a cluster + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [databases](/influxdb/cloud-dedicated/admin/databases/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster to get the [databases](/influxdb/cloud-dedicated/admin/databases/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + responses: + '200': + description: The cluster databases were successfully retrieved + content: + application/json: + schema: + type: array + items: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the database belongs to + $ref: '#/components/schemas/UuidV4' + name: + $ref: '#/components/schemas/ClusterDatabaseName' + maxTables: + $ref: '#/components/schemas/ClusterDatabaseMaxTables' + maxColumnsPerTable: + $ref: '#/components/schemas/ClusterDatabaseMaxColumnsPerTable' + retentionPeriod: + $ref: '#/components/schemas/ClusterDatabaseRetentionPeriod' + partitionTemplate: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplate' + required: + - accountId + - clusterId + - name + - maxTables + - maxColumnsPerTable + - retentionPeriod + example: + - accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 500 + maxColumnsPerTable: 200 + retentionPeriod: 0 + - accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseTwo + maxTables: 100 + maxColumnsPerTable: 50 + retentionPeriod: 300000000000 + partitionTemplate: + - type: time + value: '%Y' + - type: tag + value: bananas + - type: tag + value: plátanos + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: '' + lang: Shell + source: | + domain="https://console.influxdata.com" + + list_databases () { + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + tags: + - Databases + post: + operationId: CreateClusterDatabase + summary: Create a database + tags: + - Databases + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster to create the database for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: '#/components/schemas/ClusterDatabaseName' + maxTables: + $ref: '#/components/schemas/ClusterDatabaseMaxTables' + maxColumnsPerTable: + $ref: '#/components/schemas/ClusterDatabaseMaxColumnsPerTable' + retentionPeriod: + $ref: '#/components/schemas/ClusterDatabaseRetentionPeriod' + partitionTemplate: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplate' + required: + - name + examples: + requiredFieldsOnly: + summary: Required Fields Only + value: + name: DatabaseOne + allFields: + summary: All Fields + value: + name: DatabaseTwo + maxTables: 100 + maxColumnsPerTable: 50 + retentionPeriod: 300000000000 + partitionTemplate: + - type: time + value: '%Y' + - type: tag + value: bananas + - type: tag + value: plátanos + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + responses: + '200': + description: The cluster database was successfully created + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the database belongs to + $ref: '#/components/schemas/UuidV4' + name: + $ref: '#/components/schemas/ClusterDatabaseName' + maxTables: + $ref: '#/components/schemas/ClusterDatabaseMaxTables' + maxColumnsPerTable: + $ref: '#/components/schemas/ClusterDatabaseMaxColumnsPerTable' + retentionPeriod: + $ref: '#/components/schemas/ClusterDatabaseRetentionPeriod' + partitionTemplate: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplate' + required: + - accountId + - clusterId + - name + - maxTables + - maxColumnsPerTable + - retentionPeriod + examples: + requiredFieldsOnly: + summary: Required Fields Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 500 + maxColumnsPerTable: 200 + retentionPeriod: 0 + allFields: + summary: All Fields + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseTwo + maxTables: 100 + maxColumnsPerTable: 50 + retentionPeriod: 300000000000 + partitionTemplate: + - type: time + value: '%Y' + - type: tag + value: a + - type: tag + value: c + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + create_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "name": "'$databaseName'", + "maxTables": 75, + "maxColumnsPerTable": 90, + "retentionPeriod": 600000000000, + "partitionTemplate": [ + { + "type": "tag", + "value": "abc" + }, + { + "type": "bucket", + "value": { + "tagName": "def", + "numberOfBuckets": 5 + } + } + ] + }' \ + ) + echo "$response" + } + /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}: + patch: + operationId: UpdateClusterDatabase + summary: Update a database + tags: + - Databases + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster that the database belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: databaseName + in: path + description: The name of the database to update + required: true + schema: + $ref: '#/components/schemas/ClusterDatabaseName' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + maxTables: + $ref: '#/components/schemas/ClusterDatabaseMaxTables' + maxColumnsPerTable: + $ref: '#/components/schemas/ClusterDatabaseMaxColumnsPerTable' + retentionPeriod: + $ref: '#/components/schemas/ClusterDatabaseRetentionPeriod' + minProperties: 1 + examples: + allFields: + summary: Update All Fields + value: + maxTables: 300 + maxColumnsPerTable: 150 + retentionPeriod: 600000000000 + maxTablsOnly: + summary: Update Max Tables Only + value: + maxTables: 300 + maxColumnsPerTableOnly: + summary: Update Max Columns Per Table Only + value: + maxColumnsPerTable: 150 + retentionPeriodOnly: + summary: Update Retention Period Only + value: + retentionPeriod: 600000000000 + responses: + '200': + description: The cluster database was successfully updated. + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the database belongs to + $ref: '#/components/schemas/UuidV4' + name: + $ref: '#/components/schemas/ClusterDatabaseName' + maxTables: + $ref: '#/components/schemas/ClusterDatabaseMaxTables' + maxColumnsPerTable: + $ref: '#/components/schemas/ClusterDatabaseMaxColumnsPerTable' + retentionPeriod: + $ref: '#/components/schemas/ClusterDatabaseRetentionPeriod' + required: + - accountId + - clusterId + - maxTables + - maxColumnsPerTable + - retentionPeriod + - name + examples: + allFields: + summary: Update All Fields + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 300 + maxColumnsPerTable: 150 + retentionPeriod: 600000000000 + maxTablsOnly: + summary: Update Max Tables Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 300 + maxColumnsPerTable: 200 + retentionPeriod: 0 + maxColumnsPerTableOnly: + summary: Update Max Columns Per Table Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 500 + maxColumnsPerTable: 150 + retentionPeriod: 0 + retentionPeriodOnly: + summary: Update Retention Period Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + name: DatabaseOne + maxTables: 500 + maxColumnsPerTable: 200 + retentionPeriod: 600000000000 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + update_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "maxTables": 150, + "maxColumnsPerTable": 180, + "retentionPeriod": 1200000000000 + }' \ + ) + echo "$response" + } + delete: + operationId: DeleteClusterDatabase + summary: Delete a database + tags: + - Databases + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster that the database belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: databaseName + in: path + description: The name of the database to delete + required: true + schema: + $ref: '#/components/schemas/ClusterDatabaseName' + responses: + '204': + description: The cluster database was successfully deleted + $ref: '#/components/responses/NoContent' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + delete_database () { + local databaseName=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables: + post: + operationId: CreateClusterDatabaseTable + summary: Create a database table + tags: + - Tables + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database table for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster to create the database table for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: databaseName + in: path + description: The name of the database to create the database table for + required: true + schema: + $ref: '#/components/schemas/ClusterDatabaseName' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + $ref: '#/components/schemas/ClusterDatabaseTableName' + partitionTemplate: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplate' + required: + - name + examples: + requiredFieldsOnly: + summary: Required Fields Only + value: + name: TableOne + allFields: + summary: All Fields + value: + name: TableTwo + partitionTemplate: + - type: time + value: '%Y' + - type: tag + value: bananas + - type: tag + value: plátanos + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + responses: + '200': + description: The cluster database table was successfully created + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database table belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the database table belongs to + $ref: '#/components/schemas/UuidV4' + databaseName: + description: The name of the database that the database table belongs to + $ref: '#/components/schemas/ClusterDatabaseName' + name: + description: The name of the database table + $ref: '#/components/schemas/ClusterDatabaseTableName' + partitionTemplate: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplate' + required: + - accountId + - clusterId + - databaseName + - name + examples: + requiredFieldsOnly: + summary: Required Fields Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + databaseName: DatabaseOne + name: TableOne + allFields: + summary: All Fields + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + databaseName: DatabaseOne + name: TableTwo + partitionTemplate: + - type: time + value: '%Y' + - type: tag + value: a + - type: tag + value: c + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '500': + $ref: '#/components/responses/InternalServerError' + /accounts/{accountId}/clusters/{clusterId}/tokens: + get: + operationId: GetDatabaseTokens + summary: Get all database tokens for a cluster + tags: + - Database tokens + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster to get the [database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + responses: + '200': + description: The database tokens were successfully retrieved + content: + application/json: + schema: + type: array + items: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + id: + description: The ID of the database token + $ref: '#/components/schemas/UuidV4' + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + createdAt: + $ref: '#/components/schemas/DatabaseTokenCreatedAt' + required: + - accountId + - clusterId + - id + - description + - permissions + - createdAt + example: + - accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Limited Access Token + permissions: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + createdAt: '2023-12-21T17:32:28.000Z' + - accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 66666666-6666-4666-8666-666666666666 + description: Full Access Token + permissions: + - action: write + resource: '*' + createdAt: '2024-03-02T04:20:19.000Z' + - accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 77777777-7777-4777-8777-777777777777 + description: No Access Token + permissions: [] + createdAt: '2024-03-02T04:20:19.000Z' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + list_tokens () { + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + post: + operationId: CreateDatabaseToken + summary: Create a database token + tags: + - Database tokens + description: | + Create a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for a cluster. + + The access token returned on the `accessToken` property in the response can be used to authenticate query and write requests to the cluster. + + The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created. + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster to create the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for + required: true + schema: + $ref: '#/components/schemas/UuidV4' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + required: + - description + examples: + limitedAccessToken: + summary: Limited Access Token + value: + description: Limited Access Token + permissions: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + fullAccessToken: + summary: Full Access Token + value: + description: Full Access Token + permissions: + - action: write + resource: '*' + noAccessToken: + summary: No Access Token + value: + description: No Access Token + permissions: [] + responses: + '200': + description: The database token was successfully created + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + id: + description: The ID of the database token + $ref: '#/components/schemas/UuidV4' + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + createdAt: + $ref: '#/components/schemas/DatabaseTokenCreatedAt' + accessToken: + $ref: '#/components/schemas/DatabaseTokenAccessToken' + required: + - accountId + - clusterId + - id + - description + - permissions + - createdAt + - accessToken + examples: + limitedAccessToken: + summary: Limited Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Limited Access Token + permissions: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + createdAt: '2023-12-21T17:32:28.000Z' + accessToken: apiv1_5555555555555555555555555555555555555555555555555555555555555555 + fullAccessToken: + summary: Full Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 66666666-6666-4666-8666-666666666666 + description: Full Access Token + permissions: + - action: write + resource: '*' + createdAt: '2024-03-02T04:20:19.000Z' + accessToken: apiv1_6666666666666666666666666666666666666666666666666666666666666666 + noAccessToken: + summary: No Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 66666666-6666-4666-8666-666666666666 + description: No Access Token + permissions: [] + createdAt: '2024-03-02T04:20:19.000Z' + accessToken: apiv1_7777777777777777777777777777777777777777777777777777777777777777 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + create_token () { + local description=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "'$description'", + "permissions": [ + { + "action": "read", + "resource": "DatabaseOne" + }, + { + "action": "write", + "resource": "DatabaseTwo" + } + ] + }' \ + ) + echo "$response" + } + /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}: + get: + operationId: GetDatabaseToken + summary: Get a database token + tags: + - Database tokens + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: tokenId + in: path + description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to get + required: true + schema: + $ref: '#/components/schemas/UuidV4' + responses: + '200': + description: The database token was successfully retrieved. + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + id: + description: The ID of the database token + $ref: '#/components/schemas/UuidV4' + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + createdAt: + $ref: '#/components/schemas/DatabaseTokenCreatedAt' + required: + - accountId + - clusterId + - id + - description + - permissions + - createdAt + examples: + limitedAccessToken: + summary: Limited Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Limited Access Token + permissions: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + createdAt: '2023-12-21T17:32:28.000Z' + fullAccessToken: + summary: Full Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 66666666-6666-4666-8666-666666666666 + description: Full Access Token + permissions: + - action: write + resource: '*' + createdAt: '2024-03-02T04:20:19.000Z' + noAccessToken: + summary: No Access Token + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 77777777-7777-4777-8777-777777777777 + description: No Access Token + permissions: [] + createdAt: '2024-03-02T04:20:19.000Z' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + get_token () { + local tokenId=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } + patch: + operationId: UpdateDatabaseToken + summary: Update a database token + tags: + - Database tokens + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: tokenId + in: path + description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to update + required: true + schema: + $ref: '#/components/schemas/UuidV4' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + minProperties: 1 + examples: + allFields: + summary: Update All Fields + value: + description: Updated Limited Access Token + permissions: + - action: write + resource: DatabaseOne + - action: read + resource: DatabaseTwo + - action: write + resource: DatabaseThree + descriptionOnly: + summary: Update Description Only + value: + description: Updated Limited Access Token + permissionsOnly: + summary: Update Permissions Only + value: + permissions: + - action: write + resource: DatabaseOne + - action: read + resource: DatabaseTwo + - action: write + resource: DatabaseThree + removeAllPermissions: + summary: Remove All Permissions + value: + permissions: [] + responses: + '200': + description: The database token was successfully updated + content: + application/json: + schema: + type: object + properties: + accountId: + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + clusterId: + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + $ref: '#/components/schemas/UuidV4' + id: + description: The ID of the database token + $ref: '#/components/schemas/UuidV4' + description: + $ref: '#/components/schemas/DatabaseTokenDescription' + permissions: + $ref: '#/components/schemas/DatabaseTokenPermissions' + createdAt: + $ref: '#/components/schemas/DatabaseTokenCreatedAt' + required: + - accountId + - clusterId + - id + - description + - permissions + - createdAt + examples: + allFields: + summary: Update All Fields + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Updated Limited Access Token + permissions: + - action: write + resource: DatabaseOne + - action: read + resource: DatabaseTwo + - action: write + resource: DatabaseThree + createdAt: '2023-12-21T17:32:28.000Z' + descriptionOnly: + summary: Update Description Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Updated Limited Access Token + permissions: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + createdAt: '2023-12-21T17:32:28.000Z' + permissionsOnly: + summary: Update Permissions Only + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Limited Access Token + permissions: + - action: write + resource: DatabaseOne + - action: read + resource: DatabaseTwo + - action: write + resource: DatabaseThree + createdAt: '2023-12-21T17:32:28.000Z' + removeAllPermissions: + summary: Remove All Permissions + value: + accountId: 11111111-1111-4111-8111-111111111111 + clusterId: 33333333-3333-4333-8333-333333333333 + id: 55555555-5555-4555-8555-555555555555 + description: Limited Access Token + permissions: [] + createdAt: '2023-12-21T17:32:28.000Z' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + update_token () { + local tokenId=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request PATCH \ + --header "Accept: application/json" \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + --data '{ + "description": "Updated Limited Access Token", + "permissions": [ + { + "action": "write", + "resource": "DatabaseOne" + }, + { + "action": "read", + "resource": "DatabaseTwo" + }, + { + "action": "write", + "resource": "DatabaseThree" + } + ] + }' \ + ) + echo "$response" + } + delete: + operationId: DeleteDatabaseToken + summary: Delete a database token + tags: + - Database tokens + parameters: + - name: accountId + in: path + description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: clusterId + in: path + description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to + required: true + schema: + $ref: '#/components/schemas/UuidV4' + - name: tokenId + in: path + description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to delete + required: true + schema: + $ref: '#/components/schemas/UuidV4' + responses: + '204': + description: The database token was successfully deleted + $ref: '#/components/responses/NoContent' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '500': + $ref: '#/components/responses/InternalServerError' + x-codeSamples: + - label: cURL + lang: Shell + source: | + domain="https://console.influxdata.com" + + delete_token () { + local tokenId=$1 + local response=$( \ + curl \ + --location "$domain/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \ + --request DELETE \ + --header "Accept: application/json" \ + --header "Authorization: Bearer $MANAGEMENT_TOKEN" \ + ) + echo "$response" + } +components: + schemas: + Error: + type: object + properties: + code: + type: integer + message: + type: string + examples: + - code: 400 + message: bad request + - code: 401 + message: unauthorized + - code: 403 + message: forbidden + - code: 404 + message: not found + - code: 409 + message: conflict + - code: 500 + message: internal server error + required: + - code + - message + DateTimeRfc3339: + type: string + format: date-time + examples: + - '2023-12-21T17:32:28Z' + UuidV4: + type: string + format: uuid + examples: + - 11111111-1111-4111-8111-111111111111 + - 22222222-1111-4111-8111-111111111111 + ClusterDatabaseName: + description: The name of the cluster database + type: string + examples: + - DatabaseOne + - DatabaseTwo + maxLength: 64 + minLength: 1 + ClusterDatabaseRetentionPeriod: + description: | + The retention period of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) in nanoseconds, if applicable + + If the retention period is not set or is set to 0, the database will have infinite retention + type: integer + format: int32 + default: 0 + examples: + - 300000000000 + - 600000000000 + minimum: 0 + ClusterDatabaseMaxTables: + description: The maximum number of tables for the cluster database + type: integer + format: int32 + default: 500 + examples: + - 100 + - 300 + minimum: 1 + ClusterDatabaseMaxColumnsPerTable: + description: The maximum number of columns per table for the cluster database + type: integer + format: int32 + default: 200 + examples: + - 50 + - 150 + minimum: 1 + ClusterDatabasePartitionTemplate: + description: | + A template for [partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/) a cluster database. + + Each template part is evaluated in sequence, concatinating the final + partition key from the output of each part, delimited by the partition + key delimiter `|`. + + For example, using the partition template below: + + ```json + [ + { + "type": "time", + "value": "%Y" + }, + { + "type": "tag", + "value": "bananas" + }, + { + "type": "tag", + "value": "plátanos" + }, + { + "type": "bucket", + "value": { + "tagName": "c", + "numberOfBuckets": 10 + } + } + ] + ``` + + The following partition keys are derived: + + * `time=2023-01-01, a=bananas, b=plátanos, c=ananas` -> `2023|bananas|plátanos|5` + * `time=2023-01-01, b=plátanos` -> `2023|!|plátanos|!` + * `time=2023-01-01, another=cat, b=plátanos` -> `2023|!|plátanos|!` + * `time=2023-01-01` -> `2023|!|!|!` + * `time=2023-01-01, a=cat|dog, b=!, c=!` -> `2023|cat%7Cdog|%21|8` + * `time=2023-01-01, a=%50, c=%50` -> `2023|%2550|!|9` + * `time=2023-01-01, a=, c=` -> `2023|^|!|0` + * `time=2023-01-01, a=` -> `2023|#|!|!` + * `time=2023-01-01, c=` -> `2023|!|!|` + + When using the default [partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/) template (YYYY-MM-DD) there is no + encoding necessary, as the derived partition key contains a single part, and + no reserved characters. [`TemplatePart::Bucket`] parts by definition will + always be within the part length limit and contain no restricted characters + so are also not percent-encoded and/or truncated. + type: array + items: + $ref: '#/components/schemas/ClusterDatabasePartitionTemplatePart' + examples: + - - type: time + value: '%Y' + - type: tag + value: bananas + - type: tag + value: plátanos + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + maxItems: 8 + minItems: 1 + uniqueItems: true + ClusterDatabasePartitionTemplatePart: + description: A sub-part of a `PartitionTemplate` + anyOf: + - $ref: '#/components/schemas/ClusterDatabasePartitionTemplatePartTagValue' + - $ref: '#/components/schemas/ClusterDatabasePartitionTemplatePartTimeFormat' + - $ref: '#/components/schemas/ClusterDatabasePartitionTemplatePartBucket' + examples: + - type: time + value: '%Y' + - type: tag + value: bananas + - type: tag + value: plátanos + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + ClusterDatabasePartitionTemplatePartTagValue: + description: | + A tag value matcher that extracts a string value from the specified tag name + + If a row does not contain a value for the specified tag name, the NULL/missing partition key part `!` is rendered. + type: object + properties: + type: + type: string + enum: + - tag + value: + type: string + minLength: 1 + examples: + - type: tag + value: bananas + - type: tag + value: plátanos + ClusterDatabasePartitionTemplatePartTimeFormat: + description: A time format matcher that accepts a "strftime"-like format string and evaluates it against the "time" column + type: object + properties: + type: + type: string + enum: + - time + value: + type: string + minLength: 1 + examples: + - type: time + value: '%Y' + ClusterDatabasePartitionTemplatePartBucket: + description: | + A bucketing matcher that sorts data through a uniform hash function on the values of the given tag name. + + If a row does not contain a value for the specified tag name, the NULL/missing partition key part `!` is rendered. + type: object + properties: + type: + type: string + enum: + - bucket + value: + type: object + properties: + tagName: + description: The name of the tag used to derive the bucket the data belongs in + type: string + minLength: 1 + numberOfBuckets: + description: The number of buckets tag values are distributed across + type: integer + format: int32 + maximum: 100000 + minimum: 1 + examples: + - type: bucket + value: + tagName: c + numberOfBuckets: 10 + ClusterDatabaseTableName: + description: The name of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) table + type: string + examples: + - TableOne + - TableTwo + minLength: 1 + DatabaseTokenDescription: + description: The description of the database token + type: string + examples: + - Limited Access Token + - Full Access Token + DatabaseTokenResourceAllDatabases: + description: A resource value for a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission that refers to all databases + type: string + enum: + - '*' + DatabaseTokenPermissionAction: + description: The action the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission allows + type: string + DatabaseTokenPermissionResource: + description: The resource the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission applies to + anyOf: + - $ref: '#/components/schemas/ClusterDatabaseName' + - $ref: '#/components/schemas/DatabaseTokenResourceAllDatabases' + examples: + - DatabaseOne + - DatabaseTwo + - '*' + DatabaseTokenPermission: + description: The description of the database token + type: object + properties: + action: + $ref: '#/components/schemas/DatabaseTokenPermissionAction' + resource: + $ref: '#/components/schemas/DatabaseTokenPermissionResource' + examples: + - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + - action: write + resource: '*' + DatabaseTokenPermissions: + description: The list of permissions the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) allows + type: array + items: + $ref: '#/components/schemas/DatabaseTokenPermission' + examples: + - - action: read + resource: DatabaseOne + - action: write + resource: DatabaseTwo + - - action: write + resource: '*' + DatabaseTokenCreatedAt: + description: | + The date and time that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) was created + + Uses RFC3339 format + $ref: '#/components/schemas/DateTimeRfc3339' + examples: + - '2023-12-21T17:32:28.000Z' + - '2024-03-02T04:20:19.000Z' + DatabaseTokenAccessToken: + description: | + The access token that can be used to authenticate query and write requests to the cluster + + The access token is never stored by InfluxDB and is only returned once when the token is created. If the access token is lost, a new token must be created. + type: string + examples: + - apiv1_5555555555555555555555555555555555555555555555555555555555555555 + - apiv1_6666666666666666666666666666666666666666666666666666666666666666 + minLength: 64 + responses: + BadRequest: + description: Bad Request + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 400 + $ref: '#/components/schemas/Error' + example: + code: 400 + message: bad request + Unauthorized: + description: Unauthorized + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 401 + $ref: '#/components/schemas/Error' + example: + code: 401 + message: unauthorized + Forbidden: + description: Forbidden + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 403 + $ref: '#/components/schemas/Error' + example: + code: 403 + message: forbidden + NotFound: + description: Not Found + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 404 + $ref: '#/components/schemas/Error' + example: + code: 404 + message: not found + Conflict: + description: Conflict + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 409 + $ref: '#/components/schemas/Error' + example: + code: 409 + message: conflict + InternalServerError: + description: Internal Server Error + content: + application/json: + schema: + properties: + code: + type: integer + enum: + - 500 + $ref: '#/components/schemas/Error' + example: + code: 500 + message: internal server error + NoContent: + description: No Content + securitySchemes: + bearerAuthManagementToken: + type: http + scheme: bearer + bearerFormat: Management Token + bearerAuthJwt: + type: http + scheme: bearer + bearerFormat: JWT +x-tagGroups: + - name: Using the Management API + tags: + - Authentication + - Examples + - name: All endpoints + tags: + - Database tokens + - Databases + - Tables diff --git a/api-docs/cloud-dedicated/v1-compatibility/content/info.yml b/api-docs/cloud-dedicated/v1-compatibility/content/info.yml new file mode 100644 index 000000000..19a7f036d --- /dev/null +++ b/api-docs/cloud-dedicated/v1-compatibility/content/info.yml @@ -0,0 +1,14 @@ +title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Dedicated database. +description: | + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/) +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml b/api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml new file mode 100644 index 000000000..2305869b8 --- /dev/null +++ b/api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -0,0 +1,434 @@ +openapi: 3.0.0 +info: + title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated + version: '' + description: | + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/) + license: + name: MIT + url: https://opensource.org/licenses/MIT + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Dedicated database. +servers: + - url: / +security: + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + The InfluxDB 1.x API requires authentication for all requests. + InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. + + + For more information, see the following: + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + + x-traitTag: true + - name: Query + - name: Write +paths: + /write: + post: + operationId: PostWriteV1 + tags: + - Write + summary: Write time series data into InfluxDB in a V1-compatible format + requestBody: + description: Line protocol body + required: true + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: query + name: db + schema: + type: string + required: true + description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: precision + schema: + type: string + description: Write precision. + - in: header + name: Content-Encoding + description: When present, its value indicates to the database that compression is applied to the line protocol body. + schema: + type: string + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + responses: + '204': + description: Write data is correctly formatted and accepted for writing to the bucket. + '400': + description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: No token was sent and they are required. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '413': + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /query: + post: + operationId: PostQueryV1 + tags: + - Query + summary: Query InfluxDB in a V1 compatible format + requestBody: + description: InfluxQL query to execute. + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: header + name: Content-Type + schema: + type: string + enum: + - application/vnd.influxql + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: q + description: Defines the influxql query to run. + schema: + type: string + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' +components: + parameters: + TraceSpan: + in: header + name: Zap-Trace-Span + description: OpenTracing span context + example: + trace_id: '1' + span_id: '1' + baggage: + key: value + required: false + schema: + type: string + AuthUserV1: + in: query + name: u + required: false + schema: + type: string + description: Username. + AuthPassV1: + in: query + name: p + required: false + schema: + type: string + description: User token. + schemas: + InfluxQLResponse: + properties: + results: + type: array + oneOf: + - required: + - statement_id + - error + - required: + - statement_id + - series + items: + type: object + properties: + statement_id: + type: integer + error: + type: string + series: + type: array + items: + type: object + properties: + name: + type: string + tags: + type: object + additionalProperties: + type: string + partial: + type: boolean + columns: + type: array + items: + type: string + values: + type: array + items: + type: array + items: {} + InfluxQLCSVResponse: + type: string + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + Error: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + message: + readOnly: true + description: Message is a human-readable message. + type: string + required: + - code + - message + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + message: + readOnly: true + description: Message is a human-readable message. + type: string + op: + readOnly: true + description: Op describes the logical code operation during error. Useful for debugging. + type: string + err: + readOnly: true + description: Err is a stack of errors that occurred during processing of the request. Useful for debugging. + type: string + line: + readOnly: true + description: First line within sent body containing malformed data + type: integer + format: int32 + required: + - code + - message + - op + - err + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - invalid + message: + readOnly: true + description: Message is a human-readable message. + type: string + maxLength: + readOnly: true + description: Max length in bytes for a body of line-protocol. + type: integer + format: int32 + required: + - code + - message + - maxLength + securitySchemes: + TokenAuthentication: + type: apiKey + name: Authorization + in: header + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + + ### Syntax + + `Authorization: Token YOUR_INFLUX_TOKEN` + + + For examples and more information, see the following: + - [`/authorizations`](#tag/Authorizations) endpoint. + - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication). + - [Manage API tokens](/influxdb/cloud/security/tokens/). + BasicAuthentication: + type: http + scheme: basic + description: | + Use the HTTP [Basic authentication](#section/Authentication/BasicAuthentication) + scheme with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme): + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: | + Use the [Querystring authentication](#section/Authentication/QuerystringAuthentication) + scheme with InfluxDB 1.x API parameters to provide credentials through the query string. + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). diff --git a/api-docs/cloud-dedicated/v2/content/info.yml b/api-docs/cloud-dedicated/v2/content/info.yml new file mode 100644 index 000000000..a1778e664 --- /dev/null +++ b/api-docs/cloud-dedicated/v2/content/info.yml @@ -0,0 +1,11 @@ +title: InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated +summary: The InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Cloud Dedicated database. + +description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud-dedicated/content/servers.yml b/api-docs/cloud-dedicated/v2/content/servers.yml similarity index 100% rename from api-docs/cloud-dedicated/content/servers.yml rename to api-docs/cloud-dedicated/v2/content/servers.yml diff --git a/api-docs/cloud-dedicated/content/tag-groups.yml b/api-docs/cloud-dedicated/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud-dedicated/content/tag-groups.yml rename to api-docs/cloud-dedicated/v2/content/tag-groups.yml diff --git a/api-docs/cloud-dedicated/ref.yml b/api-docs/cloud-dedicated/v2/ref.yml similarity index 97% rename from api-docs/cloud-dedicated/ref.yml rename to api-docs/cloud-dedicated/v2/ref.yml index 0966704b7..29ad4a5fa 100644 --- a/api-docs/cloud-dedicated/ref.yml +++ b/api-docs/cloud-dedicated/v2/ref.yml @@ -1,3 +1,729 @@ +openapi: 3.0.0 +info: + title: InfluxDB v2 HTTP API for Cloud Dedicated + description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). + license: + name: MIT + url: https://opensource.org/licenses/MIT + summary: The InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Cloud Dedicated database. + version: '' +servers: + - url: https://{baseurl} + description: InfluxDB Cloud Dedicated API URL + variables: + baseurl: + enum: + - cluster-id.influxdb.io + default: cluster-id.influxdb.io + description: InfluxDB Cloud Dedicated URL +security: + - BearerAuthentication: [] + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - description: | + ### Write data + + InfluxDB Cloud Dedicated provides the following HTTP API endpoints for writing data: + + - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. + - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. + + Both endpoints accept the same line protocol format and process data in the same way. + + ### Query data + + InfluxDB Cloud Dedicated provides the following protocols for executing a query: + + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-dedicated/get-started/query/). + - HTTP API [`/query` request](#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to v3. + + ### InfluxDB v2 compatibility + + The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-dedicated/write-data/). + + See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). + + ### InfluxDB v1 compatibility + + The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. + + See how to [use the InfluxDB v1 HTTP API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). + name: API compatibility + x-traitTag: true + - description: | + Use one of the following schemes to authenticate to the InfluxDB API: + + - [Bearer authentication](#section/Authentication/BearerAuthentication) + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + name: Authentication + x-traitTag: true + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `database` resource. + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `database`, `db` | string | The database name | + name: Common parameters + x-traitTag: true + - name: Data I/O endpoints + description: | + Write and query data stored in InfluxDB. + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - name: Ping + - description: | + Query data stored in a database. + + - HTTP clients can query the v1 [`/query` endpoint](#operation/GetLegacyQuery) + using **InfluxQL** and retrieve data in **CSV** or **JSON** format. + - The `/api/v2/query` endpoint can't query InfluxDB Cloud Dedicated. + - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. + + #### Related guides + + - [Get started querying InfluxDB](/influxdb/cloud-dedicated/get-started/query/) + - [Execute queries](/influxdb/cloud-dedicated/query-data/execute-queries/) + name: Query + - description: | + See the [**Get Started**](/influxdb/cloud-dedicated/get-started/) tutorial + to get up and running authenticating with tokens, writing to databases, and querying data. + + [**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-dedicated/reference/client-libraries/) + are available to integrate InfluxDB APIs with your application. + name: Quick start + x-traitTag: true + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `201` | Created | One or more resources are created. The response body contains details about the resource. | + | `204` | No content | The request is successful and no data is returned. For example, The [`/write` and `/api/v2/write` endpoints](#tag/Write) return this status code if all data in the batch is written and queryable. | + | `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:
  • [Rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points)
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| + | `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 tokens](/influxdb/cloud-dedicated/admin/tokens/)
| + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `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`. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: System information endpoints + - name: Usage + - description: | + Write time series data to [databases](/influxdb/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints. + name: Write +paths: + /ping: + get: + description: | + Retrieves the status and InfluxDB version of the instance. + + Use this endpoint to monitor uptime for the InfluxDB instance. The response + returns a HTTP `204` status code to inform you the instance is available. + + This endpoint doesn't require authentication. + operationId: GetPing + responses: + '204': + description: | + Success. + Headers contain InfluxDB version information. + headers: + X-Influxdb-Build: + description: | + The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: | + The version of InfluxDB. + schema: + type: integer + 4xx: + description: | + #### InfluxDB Cloud + - Doesn't return this error. + security: + - {} + servers: [] + summary: Get the status of the instance + tags: + - Ping + head: + description: | + Returns the status and InfluxDB version of the instance. + + Use this endpoint to monitor uptime for the InfluxDB instance. The response + returns a HTTP `204` status code to inform you the instance is available. + + This endpoint doesn't require authentication. + operationId: HeadPing + responses: + '204': + description: | + Success. + Headers contain InfluxDB version information. + headers: + X-Influxdb-Build: + description: The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: | + The version of InfluxDB. + schema: + type: integer + 4xx: + description: | + #### InfluxDB Cloud + - Doesn't return this error. + security: + - {} + servers: [] + summary: Get the status of the instance + tags: + - Ping + /api/v2/write: + post: + description: | + Writes data to a database. + + Use this endpoint to send data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. + + InfluxDB Cloud Dedicated does the following when you send a write request: + + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: + + - `204 No Content`: all data in the batch is ingested + - `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected + - `400 Bad Request`: all data is rejected + + The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. + + To ensure that InfluxDB handles writes in the order you request them, + wait for the response before you send the next request. + + #### Write endpoints + + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. + + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). + - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). + + #### Related guides + + - [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) + - [Write data](/influxdb/cloud-dedicated/write-data/) + - [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) + operationId: PostWrite + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + in: header + name: Content-Encoding + schema: + default: identity + description: | + Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - description: | + The format of the data in the request body. + To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. + in: header + name: Content-Type + schema: + default: text/plain; charset=utf-8 + description: | + `text/plain` is the content type for line protocol. `UTF-8` is the default character set. + enum: + - text/plain + - text/plain; charset=utf-8 + type: string + - description: | + The size of the entity-body, in bytes, sent to InfluxDB. + If the length is greater than the `max body` configuration option, + the server responds with status code `413`. + in: header + name: Content-Length + schema: + description: The length in decimal number of octets. + type: integer + - description: | + The content type that the client can understand. + Writes only return a response body if they fail--for example, + due to a formatting problem or quota limit. + + #### InfluxDB Cloud + + - Returns only `application/json` for format and limit errors. + - Returns only `text/html` for some quota limit errors. + + #### Related guides + + - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) + in: header + name: Accept + schema: + default: application/json + description: Error content type. + enum: + - application/json + type: string + - description: | + Ignored. An organization name or ID. + + InfluxDB ignores this parameter; authorizes the request using the specified database token + and writes data to the specified cluster database. + in: query + name: org + required: true + schema: + description: The organization name or ID. + type: string + - description: | + Ignored. An organization ID. + + InfluxDB ignores this parameter; authorizes the request using the specified database token + and writes data to the specified cluster database. + in: query + name: orgID + schema: + type: string + - description: | + A database name or ID. + InfluxDB writes all points in the batch to the specified database. + in: query + name: bucket + required: true + schema: + description: The database name or ID. + type: string + - description: The precision for unix timestamps in the line protocol batch. + in: query + name: precision + schema: + $ref: '#/components/schemas/WritePrecision' + requestBody: + content: + text/plain: + examples: + plain-utf8: + value: | + airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000 + airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000 + schema: + format: byte + type: string + description: | + In the request body, provide data in [line protocol format](/influxdb/cloud-dedicated/reference/syntax/line-protocol/). + + To send compressed data, do the following: + + 1. Use [gzip](https://www.gzip.org/) to compress the line protocol data. + 2. In your request, send the compressed data and the + `Content-Encoding: gzip` header. + + #### Related guides + + - [Best practices for optimizing writes](/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes/) + required: true + responses: + '201': + description: | + Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + partialWriteErrorWithRejectedPoints: + summary: Partial write rejects points with syntax errors + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '204': + description: Success ("No Content"). All data in the batch is written and queryable. + '400': + description: All data in body was rejected and not written. + content: + application/json: + examples: + rejectsAllPoints: + summary: Rejected all points + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + description: | + Service unavailable. + + - Returns this error if + the server is temporarily unavailable to accept writes. + - Returns a `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + default: + $ref: '#/components/responses/GeneralServerError' + summary: Write data + tags: + - Data I/O endpoints + - Write + /query: + get: + description: Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats. + operationId: GetLegacyQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Accept + schema: + default: application/json + description: | + Media type that the client can understand. + + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp). + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + type: string + - description: The content encoding (usually a compression algorithm) that the client can understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: | + The [database](/influxdb/cloud-dedicated/admin/databases/) to query data from. + in: query + name: db + required: true + schema: + type: string + - description: | + The retention policy to query data from. + For more information, see [InfluxQL DBRP naming convention](/influxdb/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). + in: query + name: rp + schema: + type: string + - description: The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`). + in: query + name: q + required: true + schema: + type: string + - description: | + A unix timestamp precision. + Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision. + in: query + name: epoch + schema: + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + responses: + '200': + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxqlJsonResponse' + application/x-msgpack: + schema: + format: binary + type: string + text/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + description: Query results + headers: + Content-Encoding: + description: Lists encodings (usually compression algorithms) that have been applied to the response payload. + schema: + default: identity + description: | + The content coding: + - `gzip`: compressed data + - `identity`: unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + Trace-Id: + description: The trace ID, if generated, of the request. + schema: + description: Trace ID of a request. + type: string + '429': + description: | + #### InfluxDB Cloud: + - returns this error if a **read** or **write** request exceeds your + plan's [adjustable service quotas](/influxdb/cloud-dedicated/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum + [global limit](/influxdb/cloud-dedicated/account-management/limits/#global-limits) + - returns `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Error processing query + summary: Query using the InfluxDB v1 HTTP API + tags: + - Query + - Data I/O endpoints + /write: + post: + operationId: PostLegacyWrite + description: | + Writes data to a database. + + Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. + + InfluxDB Cloud Dedicated does the following when you send a write request: + + 1. Validates the request. + 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes). + 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: + + - `204 No Content`: all data in the batch is ingested + - `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected + - `400 Bad Request`: all data is rejected + + The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + + Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. + + To ensure that InfluxDB handles writes in the order you request them, + wait for the response before you send the next request. + + #### Write endpoints + + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. + + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). + - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). + + #### Related guides + + - [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) + - [Write data](/influxdb/cloud-dedicated/write-data/) + - [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. + in: query + name: db + required: true + schema: + type: string + - description: Retention policy name. + in: query + name: rp + schema: + type: string + - description: Write precision. + in: query + name: precision + schema: + type: string + - description: When present, its value indicates to the database that compression is applied to the line protocol body. + in: header + name: Content-Encoding + schema: + default: identity + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + requestBody: + content: + text/plain: + schema: + type: string + description: Line protocol body + required: true + responses: + '201': + description: | + Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + partialWriteErrorWithRejectedPoints: + summary: Partial write rejects points with syntax errors + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '204': + description: Success ("No Content"). All data in the batch is written and queryable. + '400': + description: Bad Request. All data in body was rejected and not written. + content: + application/json: + examples: + rejectsAllPoints: + summary: Rejected all points + value: + code: invalid + line: 2 + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: No token was sent and they are required. + '413': + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Write data using the InfluxDB v1 HTTP API + tags: + - Data I/O endpoints + - Write components: parameters: TraceSpan: @@ -1225,7 +1951,7 @@ components: ```sh ####################################### # Use Basic authentication with a database token - # to query the InfluxDB v1 API + # to query the InfluxDB v1 HTTP API ####################################### # Use the --user option with `--user username:DATABASE_TOKEN` syntax ####################################### @@ -1269,7 +1995,7 @@ components: ```sh ####################################### # Use an InfluxDB 1.x compatible username and password - # to query the InfluxDB v1 API + # to query the InfluxDB v1 HTTP API ####################################### # Use authentication query parameters: # ?p=DATABASE_TOKEN @@ -1355,737 +2081,6 @@ components: in: header name: Authorization type: apiKey -info: - title: InfluxDB Cloud Dedicated API Service - version: InfluxDB v3.0 - description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. - license: - name: MIT - url: https://opensource.org/licenses/MIT -openapi: 3.0.0 -paths: - /ping: - get: - description: | - Retrieves the status and InfluxDB version of the instance. - - Use this endpoint to monitor uptime for the InfluxDB instance. The response - returns a HTTP `204` status code to inform you the instance is available. - - This endpoint doesn't require authentication. - operationId: GetPing - responses: - '204': - description: | - Success. - Headers contain InfluxDB version information. - headers: - X-Influxdb-Build: - description: | - The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: | - The version of InfluxDB. - schema: - type: integer - 4xx: - description: | - #### InfluxDB Cloud - - Doesn't return this error. - security: - - {} - servers: [] - summary: Get the status of the instance - tags: - - Ping - head: - description: | - Returns the status and InfluxDB version of the instance. - - Use this endpoint to monitor uptime for the InfluxDB instance. The response - returns a HTTP `204` status code to inform you the instance is available. - - This endpoint doesn't require authentication. - operationId: HeadPing - responses: - '204': - description: | - Success. - Headers contain InfluxDB version information. - headers: - X-Influxdb-Build: - description: The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: | - The version of InfluxDB. - schema: - type: integer - 4xx: - description: | - #### InfluxDB Cloud - - Doesn't return this error. - security: - - {} - servers: [] - summary: Get the status of the instance - tags: - - Ping - /api/v2/write: - post: - description: | - Writes data to a database. - - Use this endpoint to send data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. - - InfluxDB Cloud Dedicated does the following when you send a write request: - - 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes). - 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - - `204 No Content`: all data in the batch is ingested - - `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected - - `400 Bad Request`: all data is rejected - - The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. - - Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. - - To ensure that InfluxDB handles writes in the order you request them, - wait for the response before you send the next request. - - #### Write endpoints - - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. - - - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). - - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). - - #### Related guides - - - [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) - - [Write data](/influxdb/cloud-dedicated/write-data/) - - [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) - - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - operationId: PostWrite - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: | - The compression applied to the line protocol in the request payload. - To send a gzip payload, pass `Content-Encoding: gzip` header. - in: header - name: Content-Encoding - schema: - default: identity - description: | - Content coding. - Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - - description: | - The format of the data in the request body. - To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. - in: header - name: Content-Type - schema: - default: text/plain; charset=utf-8 - description: | - `text/plain` is the content type for line protocol. `UTF-8` is the default character set. - enum: - - text/plain - - text/plain; charset=utf-8 - type: string - - description: | - The size of the entity-body, in bytes, sent to InfluxDB. - If the length is greater than the `max body` configuration option, - the server responds with status code `413`. - in: header - name: Content-Length - schema: - description: The length in decimal number of octets. - type: integer - - description: | - The content type that the client can understand. - Writes only return a response body if they fail--for example, - due to a formatting problem or quota limit. - - #### InfluxDB Cloud - - - Returns only `application/json` for format and limit errors. - - Returns only `text/html` for some quota limit errors. - - #### Related guides - - - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - in: header - name: Accept - schema: - default: application/json - description: Error content type. - enum: - - application/json - type: string - - description: | - Ignored. An organization name or ID. - - InfluxDB ignores this parameter; authorizes the request using the specified database token - and writes data to the specified cluster database. - in: query - name: org - required: true - schema: - description: The organization name or ID. - type: string - - description: | - Ignored. An organization ID. - - InfluxDB ignores this parameter; authorizes the request using the specified database token - and writes data to the specified cluster database. - in: query - name: orgID - schema: - type: string - - description: | - A database name or ID. - InfluxDB writes all points in the batch to the specified database. - in: query - name: bucket - required: true - schema: - description: The database name or ID. - type: string - - description: The precision for unix timestamps in the line protocol batch. - in: query - name: precision - schema: - $ref: '#/components/schemas/WritePrecision' - requestBody: - content: - text/plain: - examples: - plain-utf8: - value: | - airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000 - airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000 - schema: - format: byte - type: string - description: | - In the request body, provide data in [line protocol format](/influxdb/cloud-dedicated/reference/syntax/line-protocol/). - - To send compressed data, do the following: - - 1. Use [gzip](https://www.gzip.org/) to compress the line protocol data. - 2. In your request, send the compressed data and the - `Content-Encoding: gzip` header. - - #### Related guides - - - [Best practices for optimizing writes](/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes/) - required: true - responses: - '201': - description: | - Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. - content: - application/json: - examples: - partialWriteErrorWithRejectedPoints: - summary: Partial write rejects points with syntax errors - value: - code: invalid - line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" - schema: - $ref: '#/components/schemas/LineProtocolError' - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - '400': - description: All data in body was rejected and not written. - content: - application/json: - examples: - rejectsAllPoints: - summary: Rejected all points - value: - code: invalid - line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" - schema: - $ref: '#/components/schemas/LineProtocolError' - '401': - $ref: '#/components/responses/AuthorizationError' - '404': - $ref: '#/components/responses/ResourceNotFoundError' - '500': - $ref: '#/components/responses/InternalServerError' - '503': - description: | - Service unavailable. - - - Returns this error if - the server is temporarily unavailable to accept writes. - - Returns a `Retry-After` header that describes when to try the write again. - headers: - Retry-After: - description: Non-negative decimal integer indicating seconds to wait before retrying the request. - schema: - format: int32 - type: integer - default: - $ref: '#/components/responses/GeneralServerError' - summary: Write data - tags: - - Data I/O endpoints - - Write - /query: - get: - description: Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats. - operationId: GetLegacyQuery - parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: header - name: Accept - schema: - default: application/json - description: | - Media type that the client can understand. - - **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp). - enum: - - application/json - - application/csv - - text/csv - - application/x-msgpack - type: string - - description: The content encoding (usually a compression algorithm) that the client can understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - - in: header - name: Content-Type - schema: - enum: - - application/json - type: string - - description: The InfluxDB 1.x username to authenticate the request. - in: query - name: u - schema: - type: string - - description: The InfluxDB 1.x password to authenticate the request. - in: query - name: p - schema: - type: string - - description: | - The [database](/influxdb/cloud-dedicated/admin/databases/) to query data from. - in: query - name: db - required: true - schema: - type: string - - description: | - The retention policy to query data from. - For more information, see [InfluxQL DBRP naming convention](/influxdb/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). - in: query - name: rp - schema: - type: string - - description: The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`). - in: query - name: q - required: true - schema: - type: string - - description: | - A unix timestamp precision. - Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision - instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - in: query - name: epoch - schema: - enum: - - ns - - u - - µ - - ms - - s - - m - - h - type: string - responses: - '200': - content: - application/csv: - schema: - $ref: '#/components/schemas/InfluxqlCsvResponse' - application/json: - schema: - $ref: '#/components/schemas/InfluxqlJsonResponse' - application/x-msgpack: - schema: - format: binary - type: string - text/csv: - schema: - $ref: '#/components/schemas/InfluxqlCsvResponse' - description: Query results - headers: - Content-Encoding: - description: Lists encodings (usually compression algorithms) that have been applied to the response payload. - schema: - default: identity - description: | - The content coding: - - `gzip`: compressed data - - `identity`: unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - Trace-Id: - description: The trace ID, if generated, of the request. - schema: - description: Trace ID of a request. - type: string - '429': - description: | - #### InfluxDB Cloud: - - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](/influxdb/cloud-dedicated/account-management/limits/#adjustable-service-quotas) - or if a **delete** request exceeds the maximum - [global limit](/influxdb/cloud-dedicated/account-management/limits/#global-limits) - - returns `Retry-After` header that describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error processing query - summary: Query using the InfluxDB v1 API - tags: - - Query - - Data I/O endpoints - /write: - post: - operationId: PostLegacyWrite - description: | - Writes data to a database. - - Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. - - InfluxDB Cloud Dedicated does the following when you send a write request: - - 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes). - 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - - `204 No Content`: all data in the batch is ingested - - `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected - - `400 Bad Request`: all data is rejected - - The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. - - Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable. - - To ensure that InfluxDB handles writes in the order you request them, - wait for the response before you send the next request. - - #### Write endpoints - - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. - - - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). - - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). - - #### Related guides - - - [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) - - [Write data](/influxdb/cloud-dedicated/write-data/) - - [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) - - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The InfluxDB 1.x username to authenticate the request. - in: query - name: u - schema: - type: string - - description: The InfluxDB 1.x password to authenticate the request. - in: query - name: p - schema: - type: string - - description: database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. - in: query - name: db - required: true - schema: - type: string - - description: Retention policy name. - in: query - name: rp - schema: - type: string - - description: Write precision. - in: query - name: precision - schema: - type: string - - description: When present, its value indicates to the database that compression is applied to the line protocol body. - in: header - name: Content-Encoding - schema: - default: identity - description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - requestBody: - content: - text/plain: - schema: - type: string - description: Line protocol body - required: true - responses: - '201': - description: | - Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. - content: - application/json: - examples: - partialWriteErrorWithRejectedPoints: - summary: Partial write rejects points with syntax errors - value: - code: invalid - line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" - schema: - $ref: '#/components/schemas/LineProtocolError' - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - '400': - description: Bad Request. All data in body was rejected and not written. - content: - application/json: - examples: - rejectsAllPoints: - summary: Rejected all points - value: - code: invalid - line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" - schema: - $ref: '#/components/schemas/LineProtocolError' - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: No token was sent and they are required. - '413': - content: - application/json: - schema: - $ref: '#/components/schemas/LineProtocolLengthError' - description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. - '429': - description: Token is temporarily over quota. The Retry-After header describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - '503': - description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Write data using the InfluxDB v1 API - tags: - - Data I/O endpoints - - Write -security: - - BearerAuthentication: [] - - TokenAuthentication: [] - - BasicAuthentication: [] - - QuerystringAuthentication: [] -servers: - - url: / -tags: - - description: | - ### Write data - - InfluxDB Cloud Dedicated provides the following HTTP API endpoints for writing data: - - - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. - - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. - - Both endpoints accept the same line protocol format and process data in the same way. - - ### Query data - - InfluxDB Cloud Dedicated provides the following protocols for executing a query: - - - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-dedicated/get-started/query/). - - HTTP API [`/query` request](#operation/GetLegacyQuery) that contains an InfluxQL query. - Use this protocol when bringing existing InfluxDB v1 query workloads to v3. - - ### InfluxDB v2 compatibility - - The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-dedicated/write-data/). - - See how to [use the InfluxDB v2 API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). - - ### InfluxDB v1 compatibility - - The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. - - See how to [use the InfluxDB v1 API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v1/). - name: API compatibility - x-traitTag: true - - description: | - Use one of the following schemes to authenticate to the InfluxDB API: - - - [Bearer authentication](#section/Authentication/BearerAuthentication) - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - name: Authentication - x-traitTag: true - - description: | - To specify resources, some InfluxDB API endpoints require parameters or - properties in the request--for example, - writing to a `database` resource. - - ### Common parameters - - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `database`, `db` | string | The database name | - name: Common parameters - x-traitTag: true - - name: Data I/O endpoints - description: | - Write and query data stored in InfluxDB. - - description: | - InfluxDB HTTP API endpoints use standard HTTP request and response headers. - The following table shows common headers used by many InfluxDB API endpoints. - Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. - - | Header | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `Accept` | string | The content type that the client can understand. | - | `Authorization` | string | The authorization scheme and credential. | - | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | - | `Content-Type` | string | The format of the data in the request body. | - name: Headers - x-traitTag: true - - name: Ping - - description: | - Query data stored in a database. - - - HTTP clients can query the v1 [`/query` endpoint](#operation/GetLegacyQuery) - using **InfluxQL** and retrieve data in **CSV** or **JSON** format. - - The `/api/v2/query` endpoint can't query InfluxDB Cloud Dedicated. - - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. - - #### Related guides - - - [Get started querying InfluxDB](/influxdb/cloud-dedicated/get-started/query/) - - [Execute queries](/influxdb/cloud-dedicated/query-data/execute-queries/) - name: Query - - description: | - See the [**Get Started**](/influxdb/cloud-dedicated/get-started/) tutorial - to get up and running authenticating with tokens, writing to databases, and querying data. - - [**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-dedicated/reference/client-libraries/) - are available to integrate InfluxDB APIs with your application. - name: Quick start - x-traitTag: true - - description: | - InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. - The response body may include additional details. - For details about a specific operation's response, - see **Responses** and **Response Samples** for that operation. - - API operations may return the following HTTP status codes: - - |  Code  | Status | Description | - |:-----------:|:------------------------ |:--------------------- | - | `200` | Success | | - | `201` | Created | One or more resources are created. The response body contains details about the resource. | - | `204` | No content | The request is successful and no data is returned. For example, The [`/write` and `/api/v2/write` endpoints](#tag/Write) return this status code if all data in the batch is written and queryable. | - | `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:
  • [Rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points)
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| - | `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 tokens](/influxdb/cloud-dedicated/admin/tokens/)
| - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `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`. | - | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | - | `500` | Internal server error | | - | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | - name: Response codes - x-traitTag: true - - name: System information endpoints - - name: Usage - - description: | - Write time series data to [databases](/influxdb/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints. - name: Write x-tagGroups: - name: Using the InfluxDB HTTP API tags: diff --git a/api-docs/cloud-serverless/.config.yml b/api-docs/cloud-serverless/.config.yml new file mode 100644 index 000000000..16abffd30 --- /dev/null +++ b/api-docs/cloud-serverless/.config.yml @@ -0,0 +1,13 @@ +plugins: + - '../openapi/plugins/docs-plugin.js' +extends: + - recommended + - docs/all +x-influxdata-product-name: InfluxDB v3 Serverless + +apis: + v2@2: + root: v2/ref.yml + x-influxdata-default: true + v1-compatibility@2: + root: v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/cloud-serverless/content/info.yml b/api-docs/cloud-serverless/content/info.yml deleted file mode 100644 index 790a9dce8..000000000 --- a/api-docs/cloud-serverless/content/info.yml +++ /dev/null @@ -1,7 +0,0 @@ -title: InfluxDB Cloud Serverless API Service -description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. -version: InfluxDB v3.0 -license: - name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file diff --git a/api-docs/cloud-serverless/v1-compatibility/content/info.yml b/api-docs/cloud-serverless/v1-compatibility/content/info.yml new file mode 100644 index 000000000..9e0faafbc --- /dev/null +++ b/api-docs/cloud-serverless/v1-compatibility/content/info.yml @@ -0,0 +1,14 @@ +title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Serverless bucket. +description: | + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/) +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml b/api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml new file mode 100644 index 000000000..152d47bdc --- /dev/null +++ b/api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -0,0 +1,434 @@ +openapi: 3.0.0 +info: + title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless + version: '' + description: | + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/) + license: + name: MIT + url: https://opensource.org/licenses/MIT + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Serverless bucket. +servers: + - url: / +security: + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + The InfluxDB 1.x API requires authentication for all requests. + InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. + + + For more information, see the following: + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + + x-traitTag: true + - name: Query + - name: Write +paths: + /write: + post: + operationId: PostWriteV1 + tags: + - Write + summary: Write time series data into InfluxDB in a V1-compatible format + requestBody: + description: Line protocol body + required: true + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: query + name: db + schema: + type: string + required: true + description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: precision + schema: + type: string + description: Write precision. + - in: header + name: Content-Encoding + description: When present, its value indicates to the database that compression is applied to the line protocol body. + schema: + type: string + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + responses: + '204': + description: Write data is correctly formatted and accepted for writing to the bucket. + '400': + description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: No token was sent and they are required. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '413': + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /query: + post: + operationId: PostQueryV1 + tags: + - Query + summary: Query InfluxDB in a V1 compatible format + requestBody: + description: InfluxQL query to execute. + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: header + name: Content-Type + schema: + type: string + enum: + - application/vnd.influxql + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: q + description: Defines the influxql query to run. + schema: + type: string + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' +components: + parameters: + TraceSpan: + in: header + name: Zap-Trace-Span + description: OpenTracing span context + example: + trace_id: '1' + span_id: '1' + baggage: + key: value + required: false + schema: + type: string + AuthUserV1: + in: query + name: u + required: false + schema: + type: string + description: Username. + AuthPassV1: + in: query + name: p + required: false + schema: + type: string + description: User token. + schemas: + InfluxQLResponse: + properties: + results: + type: array + oneOf: + - required: + - statement_id + - error + - required: + - statement_id + - series + items: + type: object + properties: + statement_id: + type: integer + error: + type: string + series: + type: array + items: + type: object + properties: + name: + type: string + tags: + type: object + additionalProperties: + type: string + partial: + type: boolean + columns: + type: array + items: + type: string + values: + type: array + items: + type: array + items: {} + InfluxQLCSVResponse: + type: string + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + Error: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + message: + readOnly: true + description: Message is a human-readable message. + type: string + required: + - code + - message + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + message: + readOnly: true + description: Message is a human-readable message. + type: string + op: + readOnly: true + description: Op describes the logical code operation during error. Useful for debugging. + type: string + err: + readOnly: true + description: Err is a stack of errors that occurred during processing of the request. Useful for debugging. + type: string + line: + readOnly: true + description: First line within sent body containing malformed data + type: integer + format: int32 + required: + - code + - message + - op + - err + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - invalid + message: + readOnly: true + description: Message is a human-readable message. + type: string + maxLength: + readOnly: true + description: Max length in bytes for a body of line-protocol. + type: integer + format: int32 + required: + - code + - message + - maxLength + securitySchemes: + TokenAuthentication: + type: apiKey + name: Authorization + in: header + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + + ### Syntax + + `Authorization: Token YOUR_INFLUX_TOKEN` + + + For examples and more information, see the following: + - [`/authorizations`](#tag/Authorizations) endpoint. + - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication). + - [Manage API tokens](/influxdb/cloud/security/tokens/). + BasicAuthentication: + type: http + scheme: basic + description: | + Use the HTTP [Basic authentication](#section/Authentication/BasicAuthentication) + scheme with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme): + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: | + Use the [Querystring authentication](#section/Authentication/QuerystringAuthentication) + scheme with InfluxDB 1.x API parameters to provide credentials through the query string. + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). diff --git a/api-docs/cloud-serverless/v2/content/info.yml b/api-docs/cloud-serverless/v2/content/info.yml new file mode 100644 index 000000000..293543ebf --- /dev/null +++ b/api-docs/cloud-serverless/v2/content/info.yml @@ -0,0 +1,11 @@ +title: InfluxDB Cloud Serverless API Service +summary: | + The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket. +description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud-serverless/content/servers.yml b/api-docs/cloud-serverless/v2/content/servers.yml similarity index 100% rename from api-docs/cloud-serverless/content/servers.yml rename to api-docs/cloud-serverless/v2/content/servers.yml diff --git a/api-docs/cloud-serverless/content/tag-groups.yml b/api-docs/cloud-serverless/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud-serverless/content/tag-groups.yml rename to api-docs/cloud-serverless/v2/content/tag-groups.yml diff --git a/api-docs/cloud-serverless/ref.yml b/api-docs/cloud-serverless/v2/ref.yml similarity index 99% rename from api-docs/cloud-serverless/ref.yml rename to api-docs/cloud-serverless/v2/ref.yml index bc8f18499..2f9a17190 100644 --- a/api-docs/cloud-serverless/ref.yml +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -1,6713 +1,359 @@ -components: - examples: - AuthorizationPostRequest: - description: Creates an authorization. - summary: An authorization for a resource type - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - type: buckets - AuthorizationWithResourcePostRequest: - description: Creates an authorization for access to a specific resource. - summary: An authorization for a resource - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - id: INFLUX_BUCKET_ID - type: buckets - AuthorizationWithUserPostRequest: - description: Creates an authorization scoped to a specific user. - summary: An authorization scoped to a user - value: - description: iot_user write to bucket - orgID: INFLUX_ORG_ID - permissions: - - action: write - resource: - id: INFLUX_BUCKET_ID - type: buckets - userID: INFLUX_USER_ID - TaskWithFluxRequest: - description: Sets the `flux` property with Flux task options and a query. - summary: A task with Flux - value: - description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. - flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" - status: active - TaskWithScriptRequest: - description: | - Sets properties for a task that runs an _invokable script_. - summary: A task with an invokable script - value: - description: This task runs an invokable script every hour with the defined parameters. - every: 1h - name: CPU Total 1 Hour New - scriptID: SCRIPT_ID - scriptParameters: - bucket: telegraf - filterField: cpu-total - rangeStart: '-1h' - status: active - parameters: - After: - description: | - A resource ID to seek from. - Returns records created after the specified record; - results don't include the specified record. - - Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). - in: query - name: after - required: false - schema: - type: string - Descending: - in: query - name: descending - required: false - schema: - default: false - type: boolean - Limit: - description: | - Limits the number of records returned. Default is `20`. - in: query - name: limit - required: false - schema: - default: 20 - maximum: 100 - minimum: 1 - type: integer - Offset: - description: | - The offset for pagination. - The number of records to skip. - - For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). - in: query - name: offset - required: false - schema: - minimum: 0 - type: integer - SortBy: - in: query - name: sortBy - required: false - schema: - type: string - TraceSpan: - description: OpenTracing span context - example: - baggage: - key: value - span_id: '1' - trace_id: '1' - in: header - name: Zap-Trace-Span - required: false - schema: - type: string - responses: - AuthorizationError: - content: - application/json: - examples: - tokenNotAuthorized: - summary: Token is not authorized to access a resource - value: - code: unauthorized - message: unauthorized access - schema: - properties: - code: - description: | - The HTTP status code description. Default is `unauthorized`. - enum: - - unauthorized - readOnly: true - type: string - message: - description: A human-readable message that may contain detail about the error. - readOnly: true - type: string - description: | - Unauthorized. The error may indicate one of the following: - - * The `Authorization: Token` header is missing or malformed. - * The API token value is missing from the header. - * The token doesn't have sufficient permissions to write to this organization and bucket. - BadRequestError: - content: - application/json: - examples: - orgProvidedNotFound: - summary: The org or orgID passed doesn't own the token passed in the header - value: - code: invalid - message: 'failed to decode request body: organization not found' - schema: - $ref: '#/components/schemas/Error' - description: | - Bad request. - The response body contains detail about the error. - - #### InfluxDB OSS - - - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. - GeneralServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - InternalServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: | - Internal server error. - The server encountered an unexpected situation. - ResourceNotFoundError: - content: - application/json: - examples: - bucket-not-found: - summary: Bucket name not found - value: - code: not found - message: bucket "air_sensor" not found - org-not-found: - summary: Organization name not found - value: - code: not found - message: organization name "my-org" not found - orgID-not-found: - summary: Organization ID not found - value: - code: not found - message: organization not found - schema: - $ref: '#/components/schemas/Error' - description: | - Not found. - A requested resource was not found. - The response body contains the requested resource type and the name value - (if you passed it)--for example: - - - `"organization name \"my-org\" not found"` - - `"organization not found"`: indicates you passed an ID that did not match - an organization. - ServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - schemas: - ASTResponse: - description: Contains the AST for the supplied Flux query - properties: - ast: - $ref: '#/components/schemas/Package' - type: object - AddResourceMemberRequestBody: - properties: - id: - description: | - The ID of the user to add to the resource. - type: string - name: - description: | - The name of the user to add to the resource. - type: string - required: - - id - type: object - AnalyzeQueryResponse: - properties: - errors: - items: - properties: - character: - type: integer - column: - type: integer - line: - type: integer - message: - type: string - type: object - type: array - type: object - ArrayExpression: - description: Used to create and directly specify the elements of an array object - properties: - elements: - description: Elements of the array - items: - $ref: '#/components/schemas/Expression' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - Authorization: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - createdAt: - format: date-time - readOnly: true - type: string - id: - description: The authorization ID. - readOnly: true - type: string - links: - example: - self: /api/v2/authorizations/1 - user: /api/v2/users/12 - properties: - self: - $ref: '#/components/schemas/Link' - readOnly: true - user: - $ref: '#/components/schemas/Link' - readOnly: true - readOnly: true - type: object - org: - description: | - The organization name. - Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) - that the token is scoped to. - readOnly: true - type: string - orgID: - description: | - The organization ID. - Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions. - An authorization must have at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: | - The API token. - The token value is unique to the authorization. - [API tokens](/influxdb/cloud-serverless/reference/glossary/#token) are - used to authenticate and authorize InfluxDB API requests and `influx` - CLI commands--after receiving the request, InfluxDB checks that the - token is valid and that the `permissions` allow the requested action(s). - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: | - The user name. - Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. - If the authorization is _scoped_ to a user, the user; - otherwise, the creator of the authorization. - readOnly: true - type: string - userID: - description: The user ID. Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. - readOnly: true - type: string - type: object - required: - - orgID - - permissions - AuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: | - An organization ID. - Specifies the organization that owns the authorization. - type: string - permissions: - description: | - A list of permissions for an authorization. - In the list, provide at least one `permission` object. - - In a `permission`, the `resource.type` property grants access to all - resources of the specified type. - To grant access to only a specific resource, specify the - `resource.id` property. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - userID: - description: | - A user ID. - Specifies the user that the authorization is scoped to. - - When a user authenticates with username and password, - InfluxDB generates a _user session_ with all the permissions - specified by all the user's authorizations. - type: string - type: object - required: - - orgID - - permissions - AuthorizationUpdateRequest: - properties: - description: - description: A description of the token. - type: string - status: - default: active - description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. - enum: - - active - - inactive - type: string - Authorizations: - properties: - authorizations: - items: - $ref: '#/components/schemas/Authorization' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - Axes: - description: The viewport for a View's visualizations - properties: - x: - $ref: '#/components/schemas/Axis' - 'y': - $ref: '#/components/schemas/Axis' - required: - - x - - 'y' - type: object - Axis: - description: Axis used in a visualization. - properties: - base: - description: Radix for formatting axis values. - enum: - - '' - - '2' - - '10' - type: string - bounds: - description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. - items: - type: string - maxItems: 2 - minItems: 0 - type: array - label: - description: Description of the axis. - type: string - prefix: - description: Label prefix for formatting axis values. - type: string - scale: - $ref: '#/components/schemas/AxisScale' - suffix: - description: Label suffix for formatting axis values. - type: string - type: object - AxisScale: - description: 'Scale is the axis formatting scale. Supported: "log", "linear"' - enum: - - log - - linear - type: string - BadStatement: - description: A placeholder for statements for which no correct statement nodes can be created - properties: - text: - description: Raw source text - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - BandViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - lowerColumn: - type: string - mainColumn: - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - band - type: string - upperColumn: - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - type: object - BinaryExpression: - description: uses binary operators to act on two operands in an expression - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Block: - description: A set of statements - properties: - body: - description: Block body - items: - $ref: '#/components/schemas/Statement' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - BooleanLiteral: - description: Represents boolean values - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: boolean - type: object - Bucket: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/buckets/1/labels - members: /api/v2/buckets/1/members - org: /api/v2/orgs/2 - owners: /api/v2/buckets/1/owners - self: /api/v2/buckets/1 - write: /api/v2/write?org=2&bucket=1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this bucket. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members that can read this bucket. - org: - $ref: '#/components/schemas/Link' - description: The URL to retrieve parent organization for this bucket. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners that can read and write to this bucket. - self: - $ref: '#/components/schemas/Link' - description: The URL for this bucket. - write: - $ref: '#/components/schemas/Link' - description: The URL to write line protocol to this bucket. - readOnly: true - type: object - name: - type: string - orgID: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - type: - default: user - enum: - - user - - system - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - retentionRules - Buckets: - properties: - buckets: - items: - $ref: '#/components/schemas/Bucket' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - BuilderAggregateFunctionType: - enum: - - filter - - group - type: string - BuilderConfig: - properties: - aggregateWindow: - properties: - fillValues: - type: boolean - period: - type: string - type: object - buckets: - items: - type: string - type: array - functions: - items: - $ref: '#/components/schemas/BuilderFunctionsType' - type: array - tags: - items: - $ref: '#/components/schemas/BuilderTagsType' - type: array - type: object - BuilderFunctionsType: - properties: - name: - type: string - type: object - BuilderTagsType: - properties: - aggregateFunctionType: - $ref: '#/components/schemas/BuilderAggregateFunctionType' - key: - type: string - values: - items: - type: string - type: array - type: object - BuiltinStatement: - description: Declares a builtin identifier and its type - properties: - id: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - CallExpression: - description: Represents a function call - properties: - arguments: - description: Function arguments - items: - $ref: '#/components/schemas/Expression' - type: array - callee: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Cell: - properties: - h: - format: int32 - type: integer - id: - type: string - links: - properties: - self: - type: string - view: - type: string - type: object - viewID: - description: The reference to a view from the views API. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellUpdate: - properties: - h: - format: int32 - type: integer - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellWithViewProperties: - allOf: - - $ref: '#/components/schemas/Cell' - - properties: - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - type: object - type: object - Cells: - items: - $ref: '#/components/schemas/Cell' - type: array - CellsWithViewProperties: - items: - $ref: '#/components/schemas/CellWithViewProperties' - type: array - Check: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - CheckBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the check. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/checks/1/labels - members: /api/v2/checks/1/members - owners: /api/v2/checks/1/owners - query: /api/v2/checks/1/query - self: /api/v2/checks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this check. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this check. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this check. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this check. - self: - $ref: '#/components/schemas/Link' - description: The URL for this check. - readOnly: true - type: object - name: - type: string - orgID: - description: The ID of the organization that owns this check. - type: string - ownerID: - description: The ID of creator used to create this check. - readOnly: true - type: string - query: - $ref: '#/components/schemas/DashboardQuery' - status: - $ref: '#/components/schemas/TaskStatusType' - taskID: - description: The ID of the task associated with this check. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - orgID - - query - CheckDiscriminator: - discriminator: - mapping: - custom: '#/components/schemas/CustomCheck' - deadman: '#/components/schemas/DeadmanCheck' - threshold: '#/components/schemas/ThresholdCheck' - propertyName: type - oneOf: - - $ref: '#/components/schemas/DeadmanCheck' - - $ref: '#/components/schemas/ThresholdCheck' - - $ref: '#/components/schemas/CustomCheck' - CheckPatch: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - CheckStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - type: string - CheckViewProperties: - properties: - adaptiveZoomHide: - type: boolean - check: - $ref: '#/components/schemas/Check' - checkID: - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - check - type: string - required: - - type - - shape - - checkID - - queries - - colors - type: object - Checks: - properties: - checks: - items: - $ref: '#/components/schemas/Check' - type: array - links: - $ref: '#/components/schemas/Links' - ColorMapping: - additionalProperties: - type: string - description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. - example: - configcat_deployments-autopromotionblocker: '#663cd0' - measurement_birdmigration_europe: '#663cd0' - series_id_1: '#edf529' - series_id_2: '#edf529' - type: object - ColumnDataType: - enum: - - integer - - float - - boolean - - string - - unsigned - type: string - ColumnSemanticType: - enum: - - timestamp - - tag - - field - nullable: false - type: string - ConditionalExpression: - description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` - properties: - alternate: - $ref: '#/components/schemas/Expression' - consequent: - $ref: '#/components/schemas/Expression' - test: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - ConstantVariableProperties: - properties: - type: - enum: - - constant - type: string - values: - items: - type: string - type: array - CreateCell: - properties: - h: - format: int32 - type: integer - name: - type: string - usingView: - description: Makes a copy of the provided view. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CreateDashboardRequest: - properties: - description: - description: The user-facing description of the dashboard. - type: string - name: - description: The user-facing name of the dashboard. - type: string - orgID: - description: The ID of the organization that owns the dashboard. - type: string - required: - - orgID - - name - CustomCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - type: - enum: - - custom - type: string - required: - - type - type: object - DBRP: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - If set to `true`, this DBRP mapping is the default retention policy - for the database (specified by the `database` property's value). - type: boolean - id: - description: | - The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. - readOnly: true - type: string - links: - $ref: '#/components/schemas/Links' - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - virtual: - description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. - type: boolean - required: - - id - - orgID - - bucketID - - database - - retention_policy - - default - type: object - DBRPCreate: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - type: boolean - org: - description: | - An organization name. - Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. - type: string - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - required: - - bucketID - - database - - retention_policy - type: object - DBRPGet: - properties: - content: - $ref: '#/components/schemas/DBRP' - required: true - type: object - DBRPUpdate: - properties: - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - To remove the default mapping, set to `false`. - type: boolean - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - DBRPs: - properties: - content: - items: - $ref: '#/components/schemas/DBRP' - type: array - Dashboard: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/Cells' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - DashboardColor: - description: Defines an encoding of data value into color space. - properties: - hex: - description: The hex number of the color - maxLength: 7 - minLength: 7 - type: string - id: - description: The unique ID of the view color. - type: string - name: - description: The user-facing name of the hex color. - type: string - type: - description: Type is how the color is used. - enum: - - min - - max - - threshold - - scale - - text - - background - type: string - value: - description: The data value mapped to this color. - format: float - type: number - required: - - id - - type - - hex - - name - - value - type: object - DashboardQuery: - properties: - builderConfig: - $ref: '#/components/schemas/BuilderConfig' - editMode: - $ref: '#/components/schemas/QueryEditMode' - name: - type: string - text: - description: The text of the Flux query. - type: string - type: object - DashboardWithViewProperties: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/CellsWithViewProperties' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - Dashboards: - properties: - dashboards: - items: - $ref: '#/components/schemas/Dashboard' - type: array - links: - $ref: '#/components/schemas/Links' - type: object - DateTimeLiteral: - description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp). - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - format: date-time - type: string - type: object - DeadmanCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - level: - $ref: '#/components/schemas/CheckStatusLevel' - offset: - description: Duration to delay after the schedule, before executing check. - type: string - reportZero: - description: If only zero values reported since time, trigger an alert - type: boolean - staleTime: - description: String duration for time that a series is considered stale and should not trigger deadman. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - timeSince: - description: String duration before deadman triggers. - type: string - type: - enum: - - deadman - type: string - required: - - type - type: object - DecimalPlaces: - description: Indicates whether decimal places should be enforced, and how many digits it should show. - properties: - digits: - description: The number of digits after decimal to display - format: int32 - type: integer - isEnforced: - description: Indicates whether decimal point setting should be enforced - type: boolean - type: object - DeletePredicateRequest: - description: The delete predicate request. - properties: - predicate: - description: | - An expression in [delete predicate syntax](/influxdb/cloud-serverless/reference/syntax/delete-predicate/). - example: tag1="value1" and (tag2="value2" and tag3!="value3") - type: string - start: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). - The earliest time to delete from. - format: date-time - type: string - stop: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). - The latest time to delete from. - format: date-time - type: string - required: - - start - - stop - type: object - Dialect: - description: | - Options for tabular data output. - Default output is [annotated CSV](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#csv-response-format) with headers. - - For more information about tabular data **dialect**, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). - properties: - annotations: - description: | - Annotation rows to include in the results. - An _annotation_ is metadata associated with an object (column) in the data model. - - #### Related guides - - - See [Annotated CSV annotations](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#annotations) for examples and more information. - - For more information about **annotations** in tabular data, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). - items: - enum: - - group - - datatype - - default - type: string - type: array - uniqueItems: true - commentPrefix: - default: '#' - description: The character prefixed to comment strings. Default is a number sign (`#`). - maxLength: 1 - minLength: 0 - type: string - dateTimeFormat: - default: RFC3339 - description: | - The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). - To include nanoseconds in timestamps, use `RFC3339Nano`. - - #### Example formatted date/time values - - | Format | Value | - |:------------|:----------------------------| - | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | - | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | - enum: - - RFC3339 - - RFC3339Nano - type: string - delimiter: - default: ',' - description: The separator used between cells. Default is a comma (`,`). - maxLength: 1 - minLength: 1 - type: string - header: - default: true - description: If true, the results contain a header row. - type: boolean - type: object - DictExpression: - description: Used to create and directly specify the elements of a dictionary - properties: - elements: - description: Elements of the dictionary - items: - $ref: '#/components/schemas/DictItem' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - DictItem: - description: A key-value pair in a dictionary. - properties: - key: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - val: - $ref: '#/components/schemas/Expression' - type: object - Duration: - description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. - properties: - magnitude: - type: integer - type: - $ref: '#/components/schemas/NodeType' - unit: - type: string - type: object - DurationLiteral: - description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration - properties: - type: - $ref: '#/components/schemas/NodeType' - values: - description: Duration values - items: - $ref: '#/components/schemas/Duration' - type: array - type: object - Error: - properties: - code: - $ref: '#/components/schemas/ErrorCode' - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - ErrorCode: - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - Expression: - oneOf: - - $ref: '#/components/schemas/ArrayExpression' - - $ref: '#/components/schemas/DictExpression' - - $ref: '#/components/schemas/FunctionExpression' - - $ref: '#/components/schemas/BinaryExpression' - - $ref: '#/components/schemas/CallExpression' - - $ref: '#/components/schemas/ConditionalExpression' - - $ref: '#/components/schemas/LogicalExpression' - - $ref: '#/components/schemas/MemberExpression' - - $ref: '#/components/schemas/IndexExpression' - - $ref: '#/components/schemas/ObjectExpression' - - $ref: '#/components/schemas/ParenExpression' - - $ref: '#/components/schemas/PipeExpression' - - $ref: '#/components/schemas/UnaryExpression' - - $ref: '#/components/schemas/BooleanLiteral' - - $ref: '#/components/schemas/DateTimeLiteral' - - $ref: '#/components/schemas/DurationLiteral' - - $ref: '#/components/schemas/FloatLiteral' - - $ref: '#/components/schemas/IntegerLiteral' - - $ref: '#/components/schemas/PipeLiteral' - - $ref: '#/components/schemas/RegexpLiteral' - - $ref: '#/components/schemas/StringLiteral' - - $ref: '#/components/schemas/UnsignedIntegerLiteral' - - $ref: '#/components/schemas/Identifier' - ExpressionStatement: - description: May consist of an expression that doesn't return a value and is executed solely for its side-effects - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Field: - properties: - alias: - description: Alias overrides the field name in the returned response. Applies only if type is `func` - type: string - args: - description: Args are the arguments to the function - items: - $ref: '#/components/schemas/Field' - type: array - type: - description: '`type` describes the field type. `func` is a function. `field` is a field reference.' - enum: - - func - - field - - integer - - number - - regex - - wildcard - type: string - value: - description: value is the value of the field. Meaning of the value is implied by the `type` key - type: string - type: object - File: - description: Represents a source from a single file - properties: - body: - description: List of Flux statements - items: - $ref: '#/components/schemas/Statement' - type: array - imports: - description: A list of package imports - items: - $ref: '#/components/schemas/ImportDeclaration' - type: array - name: - description: The name of the file. - type: string - package: - $ref: '#/components/schemas/PackageClause' - type: - $ref: '#/components/schemas/NodeType' - type: object - Flags: - additionalProperties: true - type: object - FloatLiteral: - description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: number - type: object - FluxResponse: - description: Rendered flux that backs the check or notification. - properties: - flux: - type: string - FluxSuggestion: - properties: - name: - type: string - params: - additionalProperties: - type: string - type: object - type: object - FluxSuggestions: - properties: - funcs: - items: - $ref: '#/components/schemas/FluxSuggestion' - type: array - type: object - FunctionExpression: - description: Function expression - properties: - body: - $ref: '#/components/schemas/Node' - params: - description: Function parameters - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - GaugeViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - gauge - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - GeoCircleViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Circle color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - interpolateColors: - description: Interpolate circle color based on displayed value - type: boolean - radius: - description: Maximum radius size in pixels - type: integer - radiusDimension: - $ref: '#/components/schemas/Axis' - radiusField: - description: Radius field - type: string - required: - - radiusField - - radiusDimension - - colorField - - colorDimension - - colors - type: object - GeoHeatMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - blur: - description: Blur for heatmap points - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - intensityDimension: - $ref: '#/components/schemas/Axis' - intensityField: - description: Intensity field - type: string - radius: - description: Radius size in pixels - type: integer - required: - - intensityField - - intensityDimension - - radius - - blur - - colors - type: object - GeoPointMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Marker color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - isClustered: - description: Cluster close markers together - type: boolean - tooltipColumns: - description: An array for which columns to display in tooltip - items: - type: string - type: array - required: - - colorField - - colorDimension - - colors - type: object - GeoTrackMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - required: - - trackWidth - - speed - - randomColors - - trackPointVisualization - type: object - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - randomColors: - description: Assign different colors to different tracks - type: boolean - speed: - description: Speed of the track animation - type: integer - trackWidth: - description: Width of the track - type: integer - GeoViewLayer: - oneOf: - - $ref: '#/components/schemas/GeoCircleViewLayer' - - $ref: '#/components/schemas/GeoHeatMapViewLayer' - - $ref: '#/components/schemas/GeoPointMapViewLayer' - - $ref: '#/components/schemas/GeoTrackMapViewLayer' - type: object - GeoViewLayerProperties: - properties: - type: - enum: - - heatmap - - circleMap - - pointMap - - trackMap - type: string - required: - - type - type: object - GeoViewProperties: - properties: - allowPanAndZoom: - default: true - description: If true, map zoom and pan controls are enabled on the dashboard view - type: boolean - center: - description: Coordinates of the center of the map - properties: - lat: - description: Latitude of the center of the map - format: double - type: number - lon: - description: Longitude of the center of the map - format: double - type: number - required: - - lat - - lon - type: object - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - detectCoordinateFields: - default: true - description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns - type: boolean - latLonColumns: - $ref: '#/components/schemas/LatLonColumns' - layers: - description: List of individual layers shown in the map - items: - $ref: '#/components/schemas/GeoViewLayer' - type: array - mapStyle: - description: Define map type - regular, satellite etc. - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - s2Column: - description: String to define the column - type: string - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - geo - type: string - useS2CellID: - description: If true, S2 column is used to calculate lat/lon - type: boolean - zoom: - description: Zoom level used for initial display of the map - format: double - maximum: 28 - minimum: 1 - type: number - required: - - type - - shape - - queries - - note - - showNoteWhenEmpty - - center - - zoom - - allowPanAndZoom - - detectCoordinateFields - - layers - type: object - GreaterThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - greater - type: string - value: - format: float - type: number - required: - - type - - value - type: object - HTTPNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - authMethod: - enum: - - none - - basic - - bearer - type: string - contentTemplate: - type: string - headers: - additionalProperties: - type: string - description: Customized headers. - type: object - method: - enum: - - POST - - GET - - PUT - type: string - password: - type: string - token: - type: string - url: - type: string - username: - type: string - required: - - url - - authMethod - - method - type: object - type: object - HTTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/HTTPNotificationRuleBase' - HTTPNotificationRuleBase: - properties: - type: - enum: - - http - type: string - url: - type: string - required: - - type - type: object - HealthCheck: - properties: - checks: - items: - $ref: '#/components/schemas/HealthCheck' - type: array - commit: - type: string - message: - type: string - name: - type: string - status: - enum: - - pass - - fail - type: string - version: - type: string - required: - - name - - status - type: object - HeatmapViewProperties: - properties: - adaptiveZoomHide: - type: boolean - binSize: - type: number - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - heatmap - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - - binSize - type: object - HistogramViewProperties: - properties: - binCount: - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - fillColumns: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - histogram - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - format: float - type: number - type: array - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - fillColumns - - xDomain - - xAxisLabel - - position - - binCount - type: object - Identifier: - description: A valid Flux identifier - properties: - name: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - ImportDeclaration: - description: Declares a package import - properties: - as: - $ref: '#/components/schemas/Identifier' - path: - $ref: '#/components/schemas/StringLiteral' - type: - $ref: '#/components/schemas/NodeType' - type: object - IndexExpression: - description: Represents indexing into an array - properties: - array: - $ref: '#/components/schemas/Expression' - index: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - InfluxqlCsvResponse: - description: CSV Response to InfluxQL Query - example: | - name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value - type: string - InfluxqlJsonResponse: - description: JSON Response to InfluxQL Query - properties: - results: - items: - properties: - error: - type: string - series: - items: - properties: - columns: - items: - type: string - type: array - name: - type: string - partial: - type: boolean - tags: - additionalProperties: - type: string - type: object - values: - items: - items: {} - type: array - type: array - type: object - type: array - statement_id: - type: integer - type: object - type: array - type: object - IntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - IsOnboarding: - properties: - allowed: - description: | - If `true`, the InfluxDB instance hasn't had initial setup; - `false` otherwise. - type: boolean - type: object - Label: - properties: - id: - readOnly: true - type: string - name: - type: string - orgID: - readOnly: true - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - type: object - LabelCreateRequest: - properties: - name: - type: string - orgID: - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - required: - - orgID - - name - type: object - LabelMapping: - description: A _label mapping_ contains a `label` ID to attach to a resource. - properties: - labelID: - description: | - A label ID. - Specifies the label to attach. - type: string - required: - - labelID - type: object - LabelResponse: - properties: - label: - $ref: '#/components/schemas/Label' - links: - $ref: '#/components/schemas/Links' - type: object - LabelUpdate: - properties: - name: - type: string - properties: - additionalProperties: - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - type: string - example: - color: ffb3b3 - description: this is a description - type: object - type: object - Labels: - items: - $ref: '#/components/schemas/Label' - type: array - LabelsResponse: - properties: - labels: - $ref: '#/components/schemas/Labels' - links: - $ref: '#/components/schemas/Links' - type: object - LanguageRequest: - description: Flux query to be analyzed. - properties: - query: - description: | - The Flux query script to be analyzed. - type: string - required: - - query - type: object - LatLonColumn: - description: Object type for key and column definitions - properties: - column: - description: Column to look up Lat/Lon - type: string - key: - description: Key to determine whether the column is tag/field - type: string - required: - - key - - column - type: object - LatLonColumns: - description: Object type to define lat/lon columns - properties: - lat: - $ref: '#/components/schemas/LatLonColumn' - lon: - $ref: '#/components/schemas/LatLonColumn' - required: - - lat - - lon - type: object - LegacyAuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: The organization ID. Identifies the organization that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions that provide `read` and `write` access to organization resources. - An authorization must contain at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: The name that you provide for the authorization. - type: string - userID: - description: The user ID. Identifies the user that the authorization is scoped to. - type: string - type: object - required: - - orgID - - permissions - LesserThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - lesser - type: string - value: - format: float - type: number - required: - - type - - value - type: object - Limit: - description: These are org limits similar to those configured in/by quartz. - properties: - bucket: - properties: - maxBuckets: - type: integer - maxRetentionDuration: - description: Max bucket retention duration in nanoseconds. 0 is unlimited. - type: integer - required: - - maxBuckets - - maxRetentionDuration - type: object - check: - properties: - maxChecks: - type: integer - required: - - maxChecks - type: object - dashboard: - properties: - maxDashboards: - type: integer - required: - - maxDashboards - type: object - features: - properties: - allowDelete: - description: allow delete predicate endpoint - type: boolean - type: object - notificationEndpoint: - properties: - blockedNotificationEndpoints: - description: comma separated list of notification endpoints - example: http,pagerduty - type: string - required: - - blockNotificationEndpoints - type: object - notificationRule: - properties: - blockedNotificationRules: - description: comma separated list of notification rules - example: http,pagerduty - type: string - maxNotifications: - type: integer - required: - - maxNotifications - - blockNotificationRules - type: object - orgID: - type: string - rate: - properties: - cardinality: - description: Allowed organization total cardinality. 0 is unlimited. - type: integer - concurrentDeleteRequests: - description: Allowed organization concurrent outstanding delete requests. - type: integer - concurrentReadRequests: - description: Allowed concurrent queries. 0 is unlimited. - type: integer - concurrentWriteRequests: - description: Allowed concurrent writes. 0 is unlimited. - type: integer - deleteRequestsPerSecond: - description: Allowed organization delete request rate. - type: integer - queryTime: - description: Query Time in nanoseconds - type: integer - readKBs: - description: Query limit in kb/sec. 0 is unlimited. - type: integer - writeKBs: - description: Write limit in kb/sec. 0 is unlimited. - type: integer - required: - - readKBs - - queryTime - - concurrentReadRequests - - writeKBs - - concurrentWriteRequests - - cardinality - type: object - stack: - properties: - enabled: - type: boolean - required: - - enabled - type: object - task: - properties: - maxTasks: - type: integer - required: - - maxTasks - type: object - timeout: - properties: - queryUnconditionalTimeoutSeconds: - type: integer - queryidleWriteTimeoutSeconds: - type: integer - required: - - queryUnconditionalTimeoutSeconds - - queryidleWriteTimeoutSeconds - type: object - required: - - rate - - bucket - - task - - dashboard - - check - - notificationRule - - notificationEndpoint - type: object - LinePlusSingleStatProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - timeFormat: - type: string - type: - enum: - - line-plus-single-stat - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - prefix - - suffix - - decimalPlaces - - position - type: object - LineProtocolError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - internal error - - not found - - conflict - - invalid - - empty value - - unavailable - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - line: - description: First line in the request body that contains malformed data. - format: int32 - readOnly: true - type: integer - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - LineProtocolLengthError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - invalid - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - required: - - code - - message - Link: - description: URI of resource. - format: uri - readOnly: true - type: string - Links: - description: | - URI pointers for additional paged results. - properties: - next: - $ref: '#/components/schemas/Link' - prev: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - required: - - self - type: object - LogEvent: - properties: - message: - description: A description of the event that occurred. - example: Halt and catch fire - readOnly: true - type: string - runID: - description: The ID of the task run that generated the event. - readOnly: true - type: string - time: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - type: object - LogicalExpression: - description: Represents the rule conditions that collectively evaluate to either true or false - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Logs: - properties: - events: - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - type: object - MapVariableProperties: - properties: - type: - enum: - - map - type: string - values: - additionalProperties: - type: string - type: object - MarkdownViewProperties: - properties: - note: - type: string - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - markdown - type: string - required: - - type - - shape - - note - type: object - MeasurementSchema: - description: Definition of a measurement schema. - example: - bucketID: ba3c5e7f9b0a0010 - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8642 - name: cpu - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - properties: - bucketID: - description: The ID of the bucket that the measurement schema is associated with. - type: string - columns: - description: Ordered collection of column definitions. - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - createdAt: - format: date-time - readOnly: true - type: string - id: - readOnly: true - type: string - name: - nullable: false - type: string - orgID: - description: The ID of the organization. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - id - - name - - columns - - createdAt - - updatedAt - type: object - MeasurementSchemaColumn: - description: Definition of a measurement schema column. - example: - format: unix timestamp - name: time - type: integer - properties: - dataType: - $ref: '#/components/schemas/ColumnDataType' - name: - type: string - type: - $ref: '#/components/schemas/ColumnSemanticType' - required: - - name - - type - type: object - MeasurementSchemaCreateRequest: - description: Create a new measurement schema. - example: - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - name: cpu - properties: - columns: - description: Ordered collection of column definitions. - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - name: - description: | - The [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) - name. - type: string - required: - - name - - columns - type: object - MeasurementSchemaList: - description: A list of measurement schemas returning summary information - example: - measurementSchemas: - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8642 - name: cpu - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8643 - name: memory - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8644 - name: disk - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - properties: - measurementSchemas: - items: - $ref: '#/components/schemas/MeasurementSchema' - type: array - required: - - measurementSchemas - type: object - MeasurementSchemaUpdateRequest: - description: Update an existing measurement schema - example: - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - properties: - columns: - description: An ordered collection of column definitions - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - required: - - columns - type: object - MemberAssignment: - description: Object property assignment - properties: - init: - $ref: '#/components/schemas/Expression' - member: - $ref: '#/components/schemas/MemberExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - MemberExpression: - description: Represents accessing a property of an object - properties: - object: - $ref: '#/components/schemas/Expression' - property: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - type: object - MosaicViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - mosaic - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yLabelColumnSeparator: - type: string - yLabelColumns: - items: - type: string - type: array - yPrefix: - type: string - ySeriesColumns: - items: - type: string - type: array - ySuffix: - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - ySeriesColumns - - fillColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - Node: - oneOf: - - $ref: '#/components/schemas/Expression' - - $ref: '#/components/schemas/Block' - NodeType: - description: Type of AST node - type: string - NotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - NotificationEndpointBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification endpoint. - type: string - id: - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/notificationEndpoints/1/labels - members: /api/v2/notificationEndpoints/1/members - owners: /api/v2/notificationEndpoints/1/owners - self: /api/v2/notificationEndpoints/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this endpoint. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this endpoint. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this endpoint. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - type: string - orgID: - type: string - status: - default: active - description: The status of the endpoint. - enum: - - active - - inactive - type: string - type: - $ref: '#/components/schemas/NotificationEndpointType' - updatedAt: - format: date-time - readOnly: true - type: string - userID: - type: string - required: - - type - - name - type: object - NotificationEndpointDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationEndpoint' - pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' - slack: '#/components/schemas/SlackNotificationEndpoint' - telegram: '#/components/schemas/TelegramNotificationEndpoint' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationEndpoint' - - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - - $ref: '#/components/schemas/HTTPNotificationEndpoint' - - $ref: '#/components/schemas/TelegramNotificationEndpoint' - NotificationEndpointType: - enum: - - slack - - pagerduty - - http - - telegram - type: string - NotificationEndpointUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationEndpoints: - properties: - links: - $ref: '#/components/schemas/Links' - notificationEndpoints: - items: - $ref: '#/components/schemas/NotificationEndpoint' - type: array - NotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - NotificationRuleBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification rule. - type: string - endpointID: - type: string - every: - description: The notification repetition interval. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - limit: - description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. - type: integer - limitEvery: - description: Don't notify me more than times every seconds. If set, limit cannot be empty. - type: integer - links: - example: - labels: /api/v2/notificationRules/1/labels - members: /api/v2/notificationRules/1/members - owners: /api/v2/notificationRules/1/owners - query: /api/v2/notificationRules/1/query - self: /api/v2/notificationRules/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this notification rule. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this notification rule. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this notification rule. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this notification rule. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - description: Human-readable name describing the notification rule. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - orgID: - description: The ID of the organization that owns this notification rule. - type: string - ownerID: - description: The ID of creator used to create this notification rule. - readOnly: true - type: string - runbookLink: - type: string - sleepUntil: - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - statusRules: - description: List of status rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/StatusRule' - minItems: 1 - type: array - tagRules: - description: List of tag rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/TagRule' - type: array - taskID: - description: The ID of the task associated with this notification rule. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - orgID - - status - - name - - statusRules - - endpointID - type: object - NotificationRuleDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationRule' - pagerduty: '#/components/schemas/PagerDutyNotificationRule' - slack: '#/components/schemas/SlackNotificationRule' - smtp: '#/components/schemas/SMTPNotificationRule' - telegram: '#/components/schemas/TelegramNotificationRule' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationRule' - - $ref: '#/components/schemas/SMTPNotificationRule' - - $ref: '#/components/schemas/PagerDutyNotificationRule' - - $ref: '#/components/schemas/HTTPNotificationRule' - - $ref: '#/components/schemas/TelegramNotificationRule' - NotificationRuleUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationRules: - properties: - links: - $ref: '#/components/schemas/Links' - notificationRules: - items: - $ref: '#/components/schemas/NotificationRule' - type: array - ObjectExpression: - description: Allows the declaration of an anonymous object within a declaration - properties: - properties: - description: Object properties - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - OnboardingRequest: - properties: - bucket: - type: string - limit: - $ref: '#/components/schemas/Limit' - org: - type: string - password: - type: string - retentionPeriodHrs: - deprecated: true - type: integer - retentionPeriodSeconds: - type: integer - username: - type: string - required: - - username - - org - - bucket - type: object - OnboardingResponse: - properties: - auth: - $ref: '#/components/schemas/Authorization' - bucket: - $ref: '#/components/schemas/Bucket' - org: - $ref: '#/components/schemas/Organization' - user: - $ref: '#/components/schemas/UserResponse' - type: object - OptionStatement: - description: A single variable declaration - properties: - assignment: - oneOf: - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Organization: - properties: - createdAt: - format: date-time - readOnly: true - type: string - defaultStorageType: - description: Discloses whether the organization uses TSM or IOx. - enum: - - tsm - - iox - type: string - description: - type: string - id: - readOnly: true - type: string - links: - example: - buckets: /api/v2/buckets?org=myorg - dashboards: /api/v2/dashboards?org=myorg - labels: /api/v2/orgs/1/labels - members: /api/v2/orgs/1/members - owners: /api/v2/orgs/1/owners - secrets: /api/v2/orgs/1/secrets - self: /api/v2/orgs/1 - tasks: /api/v2/tasks?org=myorg - properties: - buckets: - $ref: '#/components/schemas/Link' - dashboards: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - secrets: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - tasks: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - type: string - status: - default: active - description: If inactive, the organization is inactive. - enum: - - active - - inactive - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - Organizations: - properties: - links: - $ref: '#/components/schemas/Links' - orgs: - items: - $ref: '#/components/schemas/Organization' - type: array - type: object - Package: - description: Represents a complete package source tree. - properties: - files: - description: Package files - items: - $ref: '#/components/schemas/File' - type: array - package: - description: Package name - type: string - path: - description: Package import path - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - PackageClause: - description: Defines a package identifier - properties: - name: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - PagerDutyNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - clientURL: - type: string - routingKey: - type: string - required: - - routingKey - type: object - type: object - PagerDutyNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' - PagerDutyNotificationRuleBase: - properties: - messageTemplate: - type: string - type: - enum: - - pagerduty - type: string - required: - - type - - messageTemplate - type: object - Params: - properties: - params: - additionalProperties: - enum: - - any - - bool - - duration - - float - - int - - string - - time - - uint - type: string - description: | - The `params` keys and value type defined in the script. - type: object - type: object - ParenExpression: - description: Represents an expression wrapped in parenthesis - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PasswordResetBody: - properties: - password: - type: string - required: - - password - PatchBucketRequest: - description: | - An object that contains updated bucket properties to apply. - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The name of the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/PatchRetentionRules' - type: object - PatchOrganizationRequest: - description: | - An object that contains updated organization properties to apply. - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - type: object - PatchRetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The number of seconds to keep data. - Default duration is `2592000` (30 days). - `0` represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The [shard group duration](/influxdb/cloud-serverless/reference/glossary/#shard). - The number of seconds that each shard group covers. - - #### InfluxDB Cloud Serverless - - - Doesn't use `shardGroupDurationsSeconds`. - - #### InfluxDB OSS - - - Default value depends on the [bucket retention period](/influxdb/cloud-serverless/reference/internals/shards/#shard-group-duration). - - #### Related guides - - - InfluxDB [shards and shard groups](/influxdb/cloud-serverless/reference/internals/shards/) - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - PatchRetentionRules: - description: Updates to rules to expire or retain data. No rules means no updates. - items: - $ref: '#/components/schemas/PatchRetentionRule' - type: array - Permission: - properties: - action: - enum: - - read - - write - type: string - resource: - $ref: '#/components/schemas/Resource' - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - required: - - action - - resource - PipeExpression: - description: Call expression with pipe argument - properties: - argument: - $ref: '#/components/schemas/Expression' - call: - $ref: '#/components/schemas/CallExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PipeLiteral: - description: Represents a specialized literal value, indicating the left hand value of a pipe expression - properties: - type: - $ref: '#/components/schemas/NodeType' - type: object - PostBucketRequest: - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The bucket name. - type: string - orgID: - description: | - The organization ID. - Specifies the organization that owns the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - default: '0' - description: | - The retention policy for the bucket. - For InfluxDB 1.x, specifies the duration of time that each data point - in the retention policy persists. - - If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; - otherwise, see the `retentionRules` property. - - [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) - is an InfluxDB 1.x concept. - The InfluxDB 2.x and Cloud equivalent is - [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - description: | - The schema Type. Default is `implicit`. - required: - - orgID - - name - PostCheck: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - PostNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - PostNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - PostOrganizationRequest: - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - required: - - name - type: object - Property: - description: The value associated with a key - properties: - key: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - value: - $ref: '#/components/schemas/Expression' - type: object - PropertyKey: - oneOf: - - $ref: '#/components/schemas/Identifier' - - $ref: '#/components/schemas/StringLiteral' - Query: - description: Query InfluxDB with the Flux language - properties: - dialect: - $ref: '#/components/schemas/Dialect' - extern: - $ref: '#/components/schemas/File' - now: - description: | - Specifies the time that should be reported as `now` in the query. - Default is the server `now` time. - format: date-time - type: string - params: - additionalProperties: true - description: | - Key-value pairs passed as parameters during query execution. - - To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example: - - ```json - query: "from(bucket: params.mybucket)\ - |> range(start: params.rangeStart) |> limit(n:1)" - ``` - - and pass _`params`_ with the key-value pairs--for example: - - ```json - params: { - "mybucket": "environment", - "rangeStart": "-30d" - } - ``` - - During query execution, InfluxDB passes _`params`_ to your script and substitutes the values. - - #### Limitations - - - If you use _`params`_, you can't use _`extern`_. - type: object - query: - description: The query script to execute. - type: string - type: - description: The type of query. Must be "flux". - enum: - - flux - type: string - required: - - query - type: object - QueryEditMode: - enum: - - builder - - advanced - type: string - QueryVariableProperties: - properties: - type: - enum: - - query - type: string - values: - properties: - language: - type: string - query: - type: string - type: object - RangeThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - max: - format: float - type: number - min: - format: float - type: number - type: - enum: - - range - type: string - within: - type: boolean - required: - - type - - min - - max - - within - type: object - Ready: - properties: - started: - example: '2019-03-13T10:09:33.891196-04:00' - format: date-time - type: string - status: - enum: - - ready - type: string - up: - example: 14m45.911966424s - type: string - type: object - RegexpLiteral: - description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - RenamableField: - description: Describes a field that can be renamed and made visible or invisible. - properties: - displayName: - description: The name that a field is renamed to by the user. - type: string - internalName: - description: The calculated name of a field. - readOnly: true - type: string - visible: - description: Indicates whether this field should be visible on the table. - type: boolean - type: object - Resource: - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - ResourceMember: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: member - enum: - - member - type: string - type: object - ResourceMembers: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceMember' - type: array - type: object - ResourceOwner: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: owner - enum: - - owner - type: string - type: object - ResourceOwners: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceOwner' - type: array - type: object - RetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The duration in seconds for how long data will be kept in the database. - The default duration is 2592000 (30 days). - 0 represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The shard group duration. - The duration or interval (in seconds) that each shard group covers. - - #### InfluxDB Cloud Serverless - - - Does not use `shardGroupDurationsSeconds`. - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - RetentionRules: - description: | - Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). - - #### InfluxDB Cloud Serverless - - - `retentionRules` is required. - - #### InfluxDB OSS - - - `retentionRules` isn't required. - items: - $ref: '#/components/schemas/RetentionRule' - type: array - ReturnStatement: - description: Defines an expression to return - properties: - argument: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Routes: - properties: - authorizations: - format: uri - type: string - buckets: - format: uri - type: string - dashboards: - format: uri - type: string - external: - properties: - statusFeed: - format: uri - type: string - type: object - flags: - format: uri - type: string - me: - format: uri - type: string - orgs: - format: uri - type: string - query: - properties: - analyze: - format: uri - type: string - ast: - format: uri - type: string - self: - format: uri - type: string - suggestions: - format: uri - type: string - type: object - setup: - format: uri - type: string - signin: - format: uri - type: string - signout: - format: uri - type: string - sources: - format: uri - type: string - system: - properties: - debug: - format: uri - type: string - health: - format: uri - type: string - metrics: - format: uri - type: string - type: object - tasks: - format: uri - type: string - telegrafs: - format: uri - type: string - users: - format: uri - type: string - variables: - format: uri - type: string - write: - format: uri - type: string - RuleStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - - ANY - type: string - Run: - properties: - finishedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - flux: - description: Flux used for the task - readOnly: true - type: string - id: - readOnly: true - type: string - links: - example: - retry: /api/v2/tasks/1/runs/1/retry - self: /api/v2/tasks/1/runs/1 - task: /api/v2/tasks/1 - properties: - retry: - format: uri - type: string - self: - format: uri - type: string - task: - format: uri - type: string - readOnly: true - type: object - log: - description: An array of logs associated with the run. - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - requestedAt: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - scheduledFor: - description: The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. - format: date-time - type: string - startedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - status: - enum: - - scheduled - - started - - failed - - success - - canceled - readOnly: true - type: string - taskID: - readOnly: true - type: string - RunManually: - properties: - scheduledFor: - description: | - The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) - used for the run's `now` option. - Default is the server _now_ time. - format: date-time - nullable: true - type: string - Runs: - properties: - links: - $ref: '#/components/schemas/Links' - runs: - items: - $ref: '#/components/schemas/Run' - type: array - type: object - SMTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SMTPNotificationRuleBase' - SMTPNotificationRuleBase: - properties: - bodyTemplate: - type: string - subjectTemplate: - type: string - to: - type: string - type: - enum: - - smtp - type: string - required: - - type - - subjectTemplate - - to - type: object - ScatterViewProperties: - properties: - adaptiveZoomHide: - type: boolean - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - symbolColumns: - items: - type: string - type: array - timeFormat: - type: string - type: - enum: - - scatter - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - fillColumns - - symbolColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - SchemaType: - enum: - - implicit - - explicit - type: string - Script: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - language: - $ref: '#/components/schemas/ScriptLanguage' - name: - type: string - orgID: - type: string - script: - description: The script to execute. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - url: - description: The invocation endpoint address. - type: string - required: - - name - - orgID - - script - ScriptCreateRequest: - properties: - description: - description: Script description. A description of the script. - type: string - language: - $ref: '#/components/schemas/ScriptLanguage' - name: - description: Script name. The name must be unique within the organization. - type: string - script: - description: The script to execute. - type: string - required: - - name - - script - - language - - description - type: object - ScriptHTTPResponseData: - description: | - The response body contains the results of the executed script. - The response is user-defined and dynamic. - format: binary - type: string - ScriptInvocationParams: - properties: - params: - additionalProperties: true - description: | - The script parameters. - `params` contains key-value pairs that map values to the **params.keys** - in a script. - When you invoke a script with `params`, InfluxDB passes the values as - invocation parameters to the script. - type: object - type: object - ScriptLanguage: - enum: - - flux - - sql - type: string - ScriptUpdateRequest: - properties: - description: - description: A description of the script. - type: string - script: - description: The script to execute. - type: string - type: object - Scripts: - properties: - scripts: - items: - $ref: '#/components/schemas/Script' - type: array - type: object - SecretKeys: - properties: - secrets: - items: - type: string - type: array - type: object - SecretKeysResponse: - allOf: - - $ref: '#/components/schemas/SecretKeys' - - properties: - links: - properties: - org: - type: string - self: - type: string - readOnly: true - type: object - type: object - Secrets: - additionalProperties: - type: string - example: - apikey: abc123xyz - SimpleTableViewProperties: - properties: - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showAll: - type: boolean - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - simple-table - type: string - required: - - type - - showAll - - queries - - shape - - note - - showNoteWhenEmpty - type: object - SingleStatViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - single-stat - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - SlackNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - token: - description: Specifies the API token string. Specify either `URL` or `Token`. - type: string - url: - description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. - type: string - type: object - type: object - SlackNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SlackNotificationRuleBase' - SlackNotificationRuleBase: - properties: - channel: - type: string - messageTemplate: - type: string - type: - enum: - - slack - type: string - required: - - type - - messageTemplate - type: object - Stack: - properties: - createdAt: - format: date-time - readOnly: true - type: string - events: - items: - properties: - description: - type: string - eventType: - type: string - name: - type: string - resources: - items: - properties: - apiVersion: - type: string - associations: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - metaName: - type: string - type: object - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - links: - properties: - self: - type: string - type: object - resourceID: - type: string - templateMetaName: - type: string - type: object - type: array - sources: - items: - type: string - type: array - updatedAt: - format: date-time - readOnly: true - type: string - urls: - items: - type: string - type: array - type: object - type: array - id: - type: string - orgID: - type: string - type: object - Statement: - oneOf: - - $ref: '#/components/schemas/BadStatement' - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - - $ref: '#/components/schemas/ExpressionStatement' - - $ref: '#/components/schemas/ReturnStatement' - - $ref: '#/components/schemas/OptionStatement' - - $ref: '#/components/schemas/BuiltinStatement' - - $ref: '#/components/schemas/TestStatement' - StaticLegend: - description: StaticLegend represents the options specific to the static legend - properties: - colorizeRows: - type: boolean - heightRatio: - format: float - type: number - opacity: - format: float - type: number - orientationThreshold: - type: integer - show: - type: boolean - valueAxis: - type: string - widthRatio: - format: float - type: number - type: object - StatusRule: - properties: - count: - type: integer - currentLevel: - $ref: '#/components/schemas/RuleStatusLevel' - period: - type: string - previousLevel: - $ref: '#/components/schemas/RuleStatusLevel' - type: object - StringLiteral: - description: Expressions begin and end with double quote marks - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - TableViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - fieldOptions: - description: fieldOptions represent the fields retrieved by the query with customization options - items: - $ref: '#/components/schemas/RenamableField' - type: array - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - tableOptions: - properties: - fixFirstColumn: - description: fixFirstColumn indicates whether the first column of the table should be locked - type: boolean - sortBy: - $ref: '#/components/schemas/RenamableField' - verticalTimeAxis: - description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically - type: boolean - wrapping: - description: Wrapping describes the text wrapping style to be used in table views - enum: - - truncate - - wrap - - single-line - type: string - type: object - timeFormat: - description: timeFormat describes the display format for time values according to moment.js date formatting - type: string - type: - enum: - - table - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - tableOptions - - fieldOptions - - timeFormat - - decimalPlaces - type: object - TagRule: - properties: - key: - type: string - operator: - enum: - - equal - - notequal - - equalregex - - notequalregex - type: string - value: - type: string - type: object - Task: - properties: - authorizationID: - description: | - An authorization ID. - Specifies the authorization used when the task communicates with the query engine. - - To find an authorization ID, use the - [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to - list authorizations. - type: string - createdAt: - format: date-time - readOnly: true - type: string - cron: - description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. - type: string - description: - description: A description of the task. - type: string - every: - description: The interval ([duration literal](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. - format: duration - type: string - flux: - description: | - The Flux script that the task executes. - - #### Limitations - - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. - format: flux - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/tasks/1/labels - logs: /api/v2/tasks/1/logs - members: /api/v2/tasks/1/members - owners: /api/v2/tasks/1/owners - runs: /api/v2/tasks/1/runs - self: /api/v2/tasks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - logs: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - runs: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - description: The name of the task. - type: string - offset: - description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. - format: duration - type: string - org: - description: | - An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. - Specifies the organization that owns the task. - type: string - orgID: - description: | - An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) ID. - Specifies the organization that owns the task. - type: string - ownerID: - description: | - A [user](/influxdb/cloud-serverless/reference/glossary/#user) ID. - Specifies the owner of the task. - - To find a user ID, you can use the - [`GET /api/v2/users` endpoint](#operation/GetUsers) to - list users. - type: string - scriptID: - description: | - A script ID. - Specifies the invokable script that the task executes. - - #### Limitations - - - If you use the `scriptID` property, you can't use the `flux` property. - - - type: string - scriptParameters: - description: | - Key-value pairs for `params` in the script. - Defines the invocation parameter values passed to the script specified by `scriptID`. - When running the task, InfluxDB executes the script with the parameters - you provide. - - #### Limitations - - - To use `scriptParameters`, you must provide a `scriptID`. - - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - updatedAt: - format: date-time - readOnly: true - type: string - required: - - id - - name - - orgID - type: object - TaskCreateRequest: - properties: - cron: - description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time. - type: string - description: - description: The description of the task. - type: string - every: - description: | - The interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. - `every` also determines when the task first runs, depending on the specified time. - type: string - flux: - description: | - The Flux script that the task runs. - - #### Limitations - - - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. - type: string - name: - description: The name of the task - type: string - offset: - description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. - format: duration - type: string - org: - description: The name of the organization that owns the task. - type: string - orgID: - description: The ID of the organization that owns the task. - type: string - scriptID: - description: | - The ID of the script that the task runs. - - #### Limitations - - - If you use the `scriptID` property, you can't use the `flux` property. - type: string - scriptParameters: - description: | - The parameter key-value pairs passed to the script (referenced by `scriptID`) during the task run. - - #### Limitations - - - `scriptParameters` requires `scriptID`. - - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - type: object - TaskStatusType: - description: | - `inactive` cancels scheduled runs and prevents manual runs of the task. - enum: - - active - - inactive - type: string - TaskUpdateRequest: - properties: - cron: - description: Update the 'cron' option in the flux script. - type: string - description: - description: Update the description of the task. - type: string - every: - description: Update the 'every' option in the flux script. - type: string - flux: - description: Update the Flux script that the task runs. - type: string - name: - description: Update the 'name' option in the flux script. - type: string - offset: - description: Update the 'offset' option in the flux script. - type: string - scriptID: - description: Update the 'scriptID' of the task. - type: string - scriptParameters: - description: Update the 'scriptParameters' of the task. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - type: object - Tasks: - properties: - links: - $ref: '#/components/schemas/Links' - readOnly: true - tasks: - items: - $ref: '#/components/schemas/Task' - type: array - type: object - Telegraf: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - readOnly: true - links: - example: - labels: /api/v2/telegrafs/1/labels - members: /api/v2/telegrafs/1/members - owners: /api/v2/telegrafs/1/owners - self: /api/v2/telegrafs/1 - properties: - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - type: object - type: object - TelegrafPlugin: - properties: - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - TelegrafPluginRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - plugins: - items: - properties: - alias: - type: string - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - type: array - type: object - TelegrafPlugins: - properties: - os: - type: string - plugins: - items: - $ref: '#/components/schemas/TelegrafPlugin' - type: array - version: - type: string - type: object - TelegrafRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - type: object - Telegrafs: - properties: - configurations: - items: - $ref: '#/components/schemas/Telegraf' - type: array - type: object - TelegramNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - channel: - description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . - type: string - token: - description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . - type: string - required: - - token - - channel - type: object - type: object - TelegramNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/TelegramNotificationRuleBase' - TelegramNotificationRuleBase: - properties: - disableWebPagePreview: - description: Disables preview of web links in the sent messages when "true". Defaults to "false". - type: boolean - messageTemplate: - description: The message template as a flux interpolated string. - type: string - parseMode: - description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". - enum: - - MarkdownV2 - - HTML - - Markdown - type: string - type: - description: The discriminator between other types of notification rules is "telegram". - enum: - - telegram - type: string - required: - - type - - messageTemplate - - channel - type: object - Template: - items: - description: | - A template entry. - Defines an InfluxDB resource in a template. - properties: - apiVersion: - example: influxdata.com/v2alpha1 - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - metadata: - description: | - Metadata properties used for the resource when the template is applied. - properties: - name: - type: string - type: object - spec: - description: | - Configuration properties used for the resource when the template is applied. - Key-value pairs map to the specification for the resource. - - The following code samples show `spec` configurations for template resources: - - - A bucket: - - ```json - { "spec": { - "name": "iot_center", - "retentionRules": [{ - "everySeconds": 2.592e+06, - "type": "expire" - }] - } - } - ``` - - - A variable: - - ```json - { "spec": { - "language": "flux", - "name": "Node_Service", - "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", - tag: \"service\")", - "type": "query" - } - } - ``` - type: object - type: object - type: array - TemplateApply: - properties: - actions: - description: | - A list of `action` objects. - Actions let you customize how InfluxDB applies templates in the request. - - You can use the following actions to prevent creating or updating resources: - - - A `skipKind` action skips template resources of a specified `kind`. - - A `skipResource` action skips template resources with a specified `metadata.name` - and `kind`. - items: - oneOf: - - properties: - action: - enum: - - skipKind - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - required: - - kind - type: object - type: object - - properties: - action: - enum: - - skipResource - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - resourceTemplateName: - type: string - required: - - kind - - resourceTemplateName - type: object - type: object - type: array - dryRun: - description: | - Only applies a dry run of the templates passed in the request. - - - Validates the template and generates a resource diff and summary. - - Doesn't install templates or make changes to the InfluxDB instance. - type: boolean - envRefs: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - description: | - An object with key-value pairs that map to **environment references** in templates. - - Environment references in templates are `envRef` objects with an `envRef.key` - property. - To substitute a custom environment reference value when applying templates, - pass `envRefs` with the `envRef.key` and the value. - - When you apply a template, InfluxDB replaces `envRef` objects in the template - with the values that you provide in the `envRefs` parameter. - - The following template fields may use environment references: - - - `metadata.name` - - `spec.endpointName` - - `spec.associations.name` - - - type: object - orgID: - description: | - Organization ID. - InfluxDB applies templates to this organization. - The organization owns all resources created by the template. - - To find your organization, see how to - [view organizations](/influxdb/cloud-serverless/organizations/view-orgs/). - type: string - remotes: - description: | - A list of URLs for template files. - - To apply a template manifest file located at a URL, pass `remotes` - with an array that contains the URL. - items: - properties: - contentType: - type: string - url: - type: string - required: - - url - type: object - type: array - secrets: - additionalProperties: - type: string - description: | - An object with key-value pairs that map to **secrets** in queries. - - Queries may reference secrets stored in InfluxDB--for example, - the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` - secrets and then uses them to connect to a PostgreSQL database: - - ```js - import "sql" - import "influxdata/influxdb/secrets" - - username = secrets.get(key: "POSTGRES_USERNAME") - password = secrets.get(key: "POSTGRES_PASSWORD") - - sql.from( - driverName: "postgres", - dataSourceName: "postgresql://${username}:${password}@localhost:5432", - query: "SELECT * FROM example_table", - ) - ``` - - To define secret values in your `/api/v2/templates/apply` request, - pass the `secrets` parameter with key-value pairs--for example: - - ```json - { - ... - "secrets": { - "POSTGRES_USERNAME": "pguser", - "POSTGRES_PASSWORD": "foo" - } - ... - } - ``` - - InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. - Once stored, you can't view secret values in InfluxDB. - - - type: object - stackID: - description: | - ID of the stack to update. - - To apply templates to an existing stack in the organization, use the `stackID` parameter. - If you apply templates without providing a stack ID, - InfluxDB initializes a new stack with all new resources. - - To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. - - - type: string - template: - description: | - A template object to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Pass `template` to apply only one template object. - If you use `template`, you can't use the `templates` parameter. - If you want to apply multiple template objects, use `templates` instead. - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - templates: - description: | - A list of template objects to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Use the `templates` parameter to apply multiple template objects. - If you use `templates`, you can't use the `template` parameter. - items: - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - type: array - type: object - TemplateChart: - properties: - height: - type: integer - properties: - $ref: '#/components/schemas/ViewProperties' - width: - type: integer - xPos: - type: integer - yPos: - type: integer - type: object - TemplateEnvReferences: - items: - properties: - defaultValue: - description: Default value that will be provided for the reference when no value is provided - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - envRefKey: - description: Key identified as environment reference and is the key identified in the template - type: string - resourceField: - description: Field the environment reference corresponds too - type: string - value: - description: Value provided to fulfill reference - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - required: - - resourceField - - envRefKey - type: object - type: array - TemplateExportByID: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported - type: string - required: - - id - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateExportByName: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - required: - - name - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateKind: - enum: - - Bucket - - Check - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpoint - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable - type: string - TemplateSummary: - properties: - diff: - properties: - buckets: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - old: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - checks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/CheckDiscriminator' - old: - $ref: '#/components/schemas/CheckDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - old: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - old: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationEndpoints: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - old: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - old: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - old: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/TelegrafRequest' - old: - $ref: '#/components/schemas/TelegrafRequest' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - old: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - errors: - items: - properties: - fields: - items: - type: string - type: array - indexes: - items: - type: integer - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - reason: - type: string - type: object - type: array - sources: - items: - type: string - type: array - stackID: - type: string - summary: - properties: - buckets: - items: - properties: - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - retentionPeriod: - type: integer - templateMetaName: - type: string - type: object - type: array - checks: - items: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - missingEnvRefs: - items: - type: string - type: array - missingSecrets: - items: - type: string - type: array - notificationEndpoints: - items: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - description: - type: string - endpointID: - type: string - endpointTemplateMetaName: - type: string - endpointType: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - cron: - type: string - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - type: object - TemplateSummaryLabel: - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - orgID: - type: string - properties: - properties: - color: - type: string - description: - type: string - type: object - templateMetaName: - type: string - type: object - TestStatement: - description: Declares a Flux test case - properties: - assignment: - $ref: '#/components/schemas/VariableAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Threshold: - discriminator: - mapping: - greater: '#/components/schemas/GreaterThreshold' - lesser: '#/components/schemas/LesserThreshold' - range: '#/components/schemas/RangeThreshold' - propertyName: type - oneOf: - - $ref: '#/components/schemas/GreaterThreshold' - - $ref: '#/components/schemas/LesserThreshold' - - $ref: '#/components/schemas/RangeThreshold' - ThresholdBase: - properties: - allValues: - description: If true, only alert if all values meet threshold. - type: boolean - level: - $ref: '#/components/schemas/CheckStatusLevel' - ThresholdCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - thresholds: - items: - $ref: '#/components/schemas/Threshold' - type: array - type: - enum: - - threshold - type: string - required: - - type - type: object - Token: - properties: - token: - type: string - type: object - UnaryExpression: - description: Uses operators to act on a single operand in an expression - properties: - argument: - $ref: '#/components/schemas/Expression' - operator: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - UnsignedIntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - User: - properties: - id: - readOnly: true - type: string - name: - type: string - org_id: - type: string - role: - enum: - - owner - - member - type: string - status: - default: active - description: If inactive the user is inactive. - enum: - - active - - inactive - type: string - required: - - name - UserResponse: - properties: - id: - description: | - The user ID. - readOnly: true - type: string - links: - example: - self: /api/v2/users/1 - properties: - self: - format: uri - type: string - readOnly: true - type: object - name: - description: | - The user name. - type: string - status: - default: active - description: | - The status of a user. - An inactive user can't read or write resources. - enum: - - active - - inactive - type: string - required: - - name - Users: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/UserResponse' - type: array - type: object - Variable: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - createdAt: - format: date-time - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - properties: - labels: - format: uri - type: string - org: - format: uri - type: string - self: - format: uri - type: string - readOnly: true - type: object - name: - type: string - orgID: - type: string - selected: - items: - type: string - type: array - sort_order: - type: integer - updatedAt: - format: date-time - type: string - required: - - name - - orgID - - arguments - type: object - VariableAssignment: - description: Represents the declaration of a variable - properties: - id: - $ref: '#/components/schemas/Identifier' - init: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - VariableProperties: - oneOf: - - $ref: '#/components/schemas/QueryVariableProperties' - - $ref: '#/components/schemas/ConstantVariableProperties' - - $ref: '#/components/schemas/MapVariableProperties' - type: object - Variables: - example: - variables: - - arguments: - type: constant - values: - - howdy - - hello - - hi - - yo - - oy - id: '1221432' - name: ':ok:' - selected: - - hello - - arguments: - type: map - values: - a: fdjaklfdjkldsfjlkjdsa - b: dfaksjfkljekfajekdljfas - c: fdjksajfdkfeawfeea - id: '1221432' - name: ':ok:' - selected: - - c - - arguments: - language: flux - query: 'from(bucket: "foo") |> showMeasurements()' - type: query - id: '1221432' - name: ':ok:' - selected: - - host - properties: - variables: - items: - $ref: '#/components/schemas/Variable' - type: array - type: object - View: - properties: - id: - readOnly: true - type: string - links: - properties: - self: - type: string - readOnly: true - type: object - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - required: - - name - - properties - ViewProperties: - oneOf: - - $ref: '#/components/schemas/LinePlusSingleStatProperties' - - $ref: '#/components/schemas/XYViewProperties' - - $ref: '#/components/schemas/SingleStatViewProperties' - - $ref: '#/components/schemas/HistogramViewProperties' - - $ref: '#/components/schemas/GaugeViewProperties' - - $ref: '#/components/schemas/TableViewProperties' - - $ref: '#/components/schemas/SimpleTableViewProperties' - - $ref: '#/components/schemas/MarkdownViewProperties' - - $ref: '#/components/schemas/CheckViewProperties' - - $ref: '#/components/schemas/ScatterViewProperties' - - $ref: '#/components/schemas/HeatmapViewProperties' - - $ref: '#/components/schemas/MosaicViewProperties' - - $ref: '#/components/schemas/BandViewProperties' - - $ref: '#/components/schemas/GeoViewProperties' - Views: - properties: - links: - properties: - self: - type: string - type: object - views: - items: - $ref: '#/components/schemas/View' - type: array - type: object - WritePrecision: - enum: - - ms - - s - - us - - ns - type: string - XYGeom: - enum: - - line - - step - - stacked - - bar - - monotoneX - - stepBefore - - stepAfter - type: string - XYViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colorMapping: - $ref: '#/components/schemas/ColorMapping' - description: An object that contains information about the color mapping - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - xy - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - position - type: object - securitySchemes: - BasicAuthentication: - description: | - ### Basic authentication scheme - - Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: - - ### Syntax - - `Authorization: Basic BASE64_ENCODED_CREDENTIALS` - - To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and - the password with a colon (`USERNAME:PASSWORD`), and then encode the - resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). - Many HTTP clients encode the credentials for you before sending the - request. - - _**Warning**: Base64-encoding can easily be reversed to obtain the original - username and password. It is used to keep the data intact and does not provide - security. You should always use HTTPS when authenticating or sending a request with - sensitive information._ - - ### Examples - - In the examples, replace the following: - - - **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with) - - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb/cloud-serverless/reference/glossary/#token) - - **`INFLUX_URL`**: your InfluxDB Cloud URL - - #### Encode credentials with cURL - - The following example shows how to use cURL to send an API request that uses Basic authentication. - With the `--user` option, cURL encodes the credentials and passes them - in the `Authorization: Basic` header. - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --user "EMAIL_ADDRESS":"PASSWORD" - ``` - - #### Encode credentials with Flux - - The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded - basic authentication header using a specified username and password combination. - - #### Encode credentials with JavaScript - - The following example shows how to use the JavaScript `btoa()` function - to create a Base64-encoded string: - - ```js - btoa('EMAIL_ADDRESS:PASSWORD') - ``` - - The output is the following: - - ```js - 'VVNFUk5BTUU6UEFTU1dPUkQ=' - ``` - - Once you have the Base64-encoded credentials, you can pass them in the - `Authorization` header--for example: - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" - ``` - - To learn more about HTTP authentication, see - [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ - scheme: basic - type: http - TokenAuthentication: - description: | - Use the [Token authentication](#section/Authentication/TokenAuthentication) - scheme to authenticate to the InfluxDB API. - - In your API requests, send an `Authorization` header. - For the header value, provide the word `Token` followed by a space and an InfluxDB API token. - The word `Token` is case-sensitive. - - ### Syntax - - `Authorization: Token INFLUX_API_TOKEN` - - ### Example - - #### Use Token authentication with cURL - - The following example shows how to use cURL to send an API request that uses Token authentication: - - ```sh - curl --request GET "INFLUX_URL/api/v2/buckets" \ - --header "Authorization: Token INFLUX_API_TOKEN" - ``` - - Replace the following: - - - *`INFLUX_URL`*: your InfluxDB Cloud URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud-serverless/reference/glossary/#token) - - ### Related endpoints - - - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) - - ### Related guides - - - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) - in: header - name: Authorization - type: apiKey +openapi: 3.0.0 info: title: InfluxDB Cloud Serverless API Service - version: InfluxDB v3.0 description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). license: name: MIT url: https://opensource.org/licenses/MIT -openapi: 3.0.0 + summary: | + The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket. + version: '' +servers: + - url: https://{baseurl} + description: InfluxDB Cloud Serverless API URL + variables: + baseurl: + enum: + - us-east-1-1.aws.cloud2.influxdata.com + default: us-east-1-1.aws.cloud2.influxdata.com + description: InfluxDB Cloud Serverless URL +security: + - TokenAuthentication: [] +tags: + - description: | + ### Write data + + InfluxDB Cloud Serverless provides the following HTTP API endpoints for writing data: + + - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) + for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. + - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. + + Both endpoints accept the same line protocol format and process data in the same way. + + ### Query data + + InfluxDB Cloud Serverless provides the following protocols for executing a query: + + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-serverless/get-started/query/). + - HTTP API [`/query` request](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to v3. + + ### InfluxDB v2 compatibility + + The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Token` authentication scheme](#section/Authentication/TokenAuthentication) and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-serverless/write-data/). + + See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + + ### InfluxDB v1 compatibility + + The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. + + See how to [use the InfluxDB v1 HTTP API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v1/). + name: API compatibility + x-traitTag: true + - 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) + + name: Authentication + x-traitTag: true + - description: | + Create and manage authorizations (API tokens). + + An _authorization_ contains a list of `read` and `write` + permissions for organization resources and provides an API token for authentication. + An authorization belongs to an organization and only contains permissions for that organization. + + We recommend the following for managing your tokens: + + - Create a generic user to create and manage tokens for writing data. + - Store your tokens in a secure password vault for future access. + + ### User sessions with authorizations + + Optionally, when creating an authorization, you can scope it to a specific user. + If the user signs in with username and password, creating a _user session_, + the session carries the permissions granted by all the user's authorizations. + For more information, see [how to assign a token to a specific user](/influxdb/cloud-serverless/security/tokens/create-token/). + To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + + ### Related endpoints + + - [Signin](#tag/Signin) + - [Signout](#tag/Signout) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) + - [Assign a token to a specific user](/influxdb/cloud-serverless/security/tokens/create-token/) + name: Authorizations (API tokens) + - name: Bucket Schemas + - description: | + Store your data in InfluxDB [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket). + A bucket is a named location where time series data is stored. All buckets + have a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period), + a duration of time that each data point persists. InfluxDB drops all + points with timestamps older than the bucket’s retention period. + A bucket belongs to an organization. + + ### Related guides + + - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + name: Buckets + - name: Cells + - name: Checks + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `bucket` resource in an `org` (_organization_ resource). + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | + name: Common parameters + x-traitTag: true + - name: Config + - name: Dashboards + - name: Data I/O endpoints + - description: | + The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) + and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). + InfluxDB 2.x replaces databases and retention policies with buckets. + To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, + databases and retention policies are mapped to buckets using the + database and retention policy (DBRP) mapping service. + The DBRP mapping service uses the database and retention policy + specified in 1.x compatibility API requests to route operations to a bucket. + + ### Related guides + + - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + name: DBRPs + - description: | + Delete data from an InfluxDB bucket. + name: Delete + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - description: | + Store, manage, and execute scripts in InfluxDB. + A script stores your custom Flux script and provides an invokable + endpoint that accepts runtime parameters. + In a script, you can specify custom runtime parameters + (`params`)--for example, `params.myparameter`. + Once you create a script, InfluxDB generates an + [`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke) + for your organization. + You can run the script from API requests and tasks, defining parameter + values for each run. + When the script runs, InfluxDB replaces `params` references in the + script with the runtime parameter values you define. + + Use the `/api/v2/scripts` endpoints to create and manage scripts. + See related guides to learn how to define parameters and execute scripts. + + + name: Invokable Scripts + - name: Labels + - name: Legacy Authorizations + - name: Limits + - name: NotificationEndpoints + - name: NotificationRules + - description: | + Manage your [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + An organization is a workspace for a group of users. Organizations can be + used to separate different environments, projects, teams or users within + InfluxDB. + + Use the `/api/v2/orgs` endpoints to view and manage organizations. + name: Organizations + - description: | + Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `limit` | integer | The maximum number of records to return (after other parameters are applied). | + | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | + | `after` | string (resource ID) | Only returns resources created after the specified resource. | + + ### Limitations + + - For specific endpoint parameters and examples, see the endpoint definition. + - If you specify an `offset` parameter value greater than the total number of records, + then InfluxDB returns an empty list in the response + (given `offset` skips the specified number of records). + + The following example passes `offset=50` to skip the first 50 results, + but the user only has 10 buckets: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + The response contains the following: + + ```json + { + "links": { + "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", + "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" + }, + "buckets": [] + } + ``` + name: Pagination + x-traitTag: true + - name: Ping + - description: | + Query data stored in a bucket. + + - HTTP clients can query the v1 [`/query` endpoint](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) + using **InfluxQL** and retrieve data in **CSV** or **JSON** format. + - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. + + #### Related guides + + - [Get started querying InfluxDB](/influxdb/cloud-serverless/get-started/query/) + - [Execute queries](/influxdb/cloud-serverless/query-data/execute-queries/) + name: Query + - description: | + See the [**Get started**](/influxdb/cloud-serverless/get-started/) tutorial + to get up and running authenticating with tokens, writing to buckets, and querying data. + + [**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-serverless/reference/client-libraries/) + are available to integrate InfluxDB with your application. + name: Quick start + x-traitTag: true + - name: Resources + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `201` | Created | Successfully created a resource. The response body may contain details. | + | `204` | No content | The request succeeded. InfluxDB doesn't typically return a response body for the operation. The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints return a response body if some points are written and some are rejected. | + | `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.
  • The batch contains a point with the same series as other points, but one of the field values has a different data type.
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| + | `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-serverless/security/tokens/)
| + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `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`. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: Routes + - name: Rules + - name: Secrets + - name: Security and access endpoints + - name: Setup + - name: Signin + - name: Signout + - 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" + name: Supported operations + x-traitTag: true + - name: System information endpoints + - description: | + Process and analyze your data with tasks + in the InfluxDB task engine. + Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + + 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). + + + + ### Properties + + A `task` object contains information about an InfluxDB task resource. + + The following table defines the properties that appear in this object: + + + + + name: Tasks + - name: Telegraf Plugins + - name: Telegrafs + - description: | + Export and apply InfluxDB **templates**. + Manage **stacks** of templated InfluxDB resources. + + InfluxDB templates are prepackaged configurations for resources. + Use InfluxDB templates to configure a fresh instance of InfluxDB, + back up your dashboard configuration, or share your configuration. + + Use the `/api/v2/templates` endpoints to export templates and apply templates. + + **InfluxDB stacks** are stateful InfluxDB templates that let you + add, update, and remove installed template resources over time, avoid duplicating + resources when applying the same or similar templates more than once, and + apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + + Use the `/api/v2/stacks` endpoints to manage installed template resources. + + + name: Templates + - name: Usage + - description: | + Retrieve specific users. + + InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. + To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); + you can't use the InfluxDB API to manage users in InfluxDB Cloud. + Once a user is added to your organization, you can use the + `GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to + view specific members. + + ### User sessions with authorizations + + Optionally, you can scope an authorization (and its API token) to a user. + If a user signs in with username and password, creating a _user session_, + 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). + + ### Related guides + + - [Manage users](/influxdb/cloud-serverless/organizations/users/) + name: Users + - name: Variables + - name: Views + - description: | + Write time series data to [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket) using InfluxDB v1 or v2 endpoints. + name: Write paths: /api/v2: get: @@ -14004,13 +7650,9 @@ paths: value: code: invalid line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: - $ref: "#/components/schemas/LineProtocolError" + $ref: '#/components/schemas/LineProtocolError' '400': description: | All data in the batch was rejected and not written. @@ -14024,11 +7666,7 @@ paths: value: code: invalid line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: $ref: '#/components/schemas/LineProtocolError' '401': @@ -14121,7 +7759,7 @@ paths: #### Related guides - - [Use the InfluxDB v1 API](/influxdb/cloud-serverless/guides/api-compatibility/v1/) + - [Use the InfluxDB v1 HTTP API](/influxdb/cloud-serverless/guides/api-compatibility/v1/) - [Query data](/influxdb/cloud-serverless/query-data/) operationId: GetLegacyQuery parameters: @@ -14263,7 +7901,7 @@ paths: schema: $ref: '#/components/schemas/Error' description: Error processing query - summary: Query using the InfluxDB v1 API + summary: Query using the InfluxDB v1 HTTP API tags: - Data I/O endpoints - Query @@ -14352,7 +7990,7 @@ paths: description: Line protocol body required: true responses: - "204": + '204': description: | Success. Data in the batch is written and queryable. @@ -14366,13 +8004,9 @@ paths: value: code: invalid line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: - $ref: "#/components/schemas/LineProtocolError" + $ref: '#/components/schemas/LineProtocolError' '400': description: | All data in the batch is rejected and not written. @@ -14386,11 +8020,7 @@ paths: value: code: invalid line: 2 - message: "failed to parse line protocol: - errors encountered on line(s): - error message for first rejected point - error message for second rejected point - error message for Nth rejected point (up to 100 rejected points)" + message: 'failed to parse line protocol: errors encountered on line(s): error message for first rejected point error message for second rejected point error message for Nth rejected point (up to 100 rejected points)' schema: $ref: '#/components/schemas/LineProtocolError' '401': @@ -14433,345 +8063,6711 @@ paths: schema: $ref: '#/components/schemas/Error' description: Internal server error - summary: Write data using the InfluxDB v1 API + summary: Write data using the InfluxDB v1 HTTP API tags: - Data I/O endpoints - Write -security: - - TokenAuthentication: [] -servers: - - url: / -tags: - - description: | - ### Write data +components: + examples: + AuthorizationPostRequest: + description: Creates an authorization. + summary: An authorization for a resource type + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + type: buckets + AuthorizationWithResourcePostRequest: + description: Creates an authorization for access to a specific resource. + summary: An authorization for a resource + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + id: INFLUX_BUCKET_ID + type: buckets + AuthorizationWithUserPostRequest: + description: Creates an authorization scoped to a specific user. + summary: An authorization scoped to a user + value: + description: iot_user write to bucket + orgID: INFLUX_ORG_ID + permissions: + - action: write + resource: + id: INFLUX_BUCKET_ID + type: buckets + userID: INFLUX_USER_ID + TaskWithFluxRequest: + description: Sets the `flux` property with Flux task options and a query. + summary: A task with Flux + value: + description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. + flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" + status: active + TaskWithScriptRequest: + description: | + Sets properties for a task that runs an _invokable script_. + summary: A task with an invokable script + value: + description: This task runs an invokable script every hour with the defined parameters. + every: 1h + name: CPU Total 1 Hour New + scriptID: SCRIPT_ID + scriptParameters: + bucket: telegraf + filterField: cpu-total + rangeStart: '-1h' + status: active + parameters: + After: + description: | + A resource ID to seek from. + Returns records created after the specified record; + results don't include the specified record. - InfluxDB Cloud Serverless provides the following HTTP API endpoints for writing data: + Use `after` instead of the `offset` parameter. + For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + in: query + name: after + required: false + schema: + type: string + Descending: + in: query + name: descending + required: false + schema: + default: false + type: boolean + Limit: + description: | + Limits the number of records returned. Default is `20`. + in: query + name: limit + required: false + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + Offset: + description: | + The offset for pagination. + The number of records to skip. - - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) - for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. - - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. + For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + in: query + name: offset + required: false + schema: + minimum: 0 + type: integer + SortBy: + in: query + name: sortBy + required: false + schema: + type: string + TraceSpan: + description: OpenTracing span context + example: + baggage: + key: value + span_id: '1' + trace_id: '1' + in: header + name: Zap-Trace-Span + required: false + schema: + type: string + responses: + AuthorizationError: + content: + application/json: + examples: + tokenNotAuthorized: + summary: Token is not authorized to access a resource + value: + code: unauthorized + message: unauthorized access + schema: + properties: + code: + description: | + The HTTP status code description. Default is `unauthorized`. + enum: + - unauthorized + readOnly: true + type: string + message: + description: A human-readable message that may contain detail about the error. + readOnly: true + type: string + description: | + Unauthorized. The error may indicate one of the following: - Both endpoints accept the same line protocol format and process data in the same way. + * The `Authorization: Token` header is missing or malformed. + * The API token value is missing from the header. + * The token doesn't have sufficient permissions to write to this organization and bucket. + BadRequestError: + content: + application/json: + examples: + orgProvidedNotFound: + summary: The org or orgID passed doesn't own the token passed in the header + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. - ### Query data + #### InfluxDB OSS - InfluxDB Cloud Serverless provides the following protocols for executing a query: + - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. + GeneralServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + InternalServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + The server encountered an unexpected situation. + ResourceNotFoundError: + content: + application/json: + examples: + bucket-not-found: + summary: Bucket name not found + value: + code: not found + message: bucket "air_sensor" not found + org-not-found: + summary: Organization name not found + value: + code: not found + message: organization name "my-org" not found + orgID-not-found: + summary: Organization ID not found + value: + code: not found + message: organization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + A requested resource was not found. + The response body contains the requested resource type and the name value + (if you passed it)--for example: - - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-serverless/get-started/query/). - - HTTP API [`/query` request](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) that contains an InfluxQL query. - Use this protocol when bringing existing InfluxDB v1 query workloads to v3. + - `"organization name \"my-org\" not found"` + - `"organization not found"`: indicates you passed an ID that did not match + an organization. + ServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + schemas: + ASTResponse: + description: Contains the AST for the supplied Flux query + properties: + ast: + $ref: '#/components/schemas/Package' + type: object + AddResourceMemberRequestBody: + properties: + id: + description: | + The ID of the user to add to the resource. + type: string + name: + description: | + The name of the user to add to the resource. + type: string + required: + - id + type: object + AnalyzeQueryResponse: + properties: + errors: + items: + properties: + character: + type: integer + column: + type: integer + line: + type: integer + message: + type: string + type: object + type: array + type: object + ArrayExpression: + description: Used to create and directly specify the elements of an array object + properties: + elements: + description: Elements of the array + items: + $ref: '#/components/schemas/Expression' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + Authorization: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + id: + description: The authorization ID. + readOnly: true + type: string + links: + example: + self: /api/v2/authorizations/1 + user: /api/v2/users/12 + properties: + self: + $ref: '#/components/schemas/Link' + readOnly: true + user: + $ref: '#/components/schemas/Link' + readOnly: true + readOnly: true + type: object + org: + description: | + The organization name. + Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + that the token is scoped to. + readOnly: true + type: string + orgID: + description: | + The organization ID. + Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions. + An authorization must have at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: | + The API token. + The token value is unique to the authorization. + [API tokens](/influxdb/cloud-serverless/reference/glossary/#token) are + used to authenticate and authorize InfluxDB API requests and `influx` + CLI commands--after receiving the request, InfluxDB checks that the + token is valid and that the `permissions` allow the requested action(s). + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: | + The user name. + Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. + If the authorization is _scoped_ to a user, the user; + otherwise, the creator of the authorization. + readOnly: true + type: string + userID: + description: The user ID. Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. + readOnly: true + type: string + type: object + required: + - orgID + - permissions + AuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: | + An organization ID. + Specifies the organization that owns the authorization. + type: string + permissions: + description: | + A list of permissions for an authorization. + In the list, provide at least one `permission` object. - ### InfluxDB v2 compatibility + In a `permission`, the `resource.type` property grants access to all + resources of the specified type. + To grant access to only a specific resource, specify the + `resource.id` property. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + userID: + description: | + A user ID. + Specifies the user that the authorization is scoped to. - The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Token` authentication scheme](#section/Authentication/TokenAuthentication) and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-serverless/write-data/). + When a user authenticates with username and password, + InfluxDB generates a _user session_ with all the permissions + specified by all the user's authorizations. + type: string + type: object + required: + - orgID + - permissions + AuthorizationUpdateRequest: + properties: + description: + description: A description of the token. + type: string + status: + default: active + description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. + enum: + - active + - inactive + type: string + Authorizations: + properties: + authorizations: + items: + $ref: '#/components/schemas/Authorization' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + Axes: + description: The viewport for a View's visualizations + properties: + x: + $ref: '#/components/schemas/Axis' + 'y': + $ref: '#/components/schemas/Axis' + required: + - x + - 'y' + type: object + Axis: + description: Axis used in a visualization. + properties: + base: + description: Radix for formatting axis values. + enum: + - '' + - '2' + - '10' + type: string + bounds: + description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. + items: + type: string + maxItems: 2 + minItems: 0 + type: array + label: + description: Description of the axis. + type: string + prefix: + description: Label prefix for formatting axis values. + type: string + scale: + $ref: '#/components/schemas/AxisScale' + suffix: + description: Label suffix for formatting axis values. + type: string + type: object + AxisScale: + description: 'Scale is the axis formatting scale. Supported: "log", "linear"' + enum: + - log + - linear + type: string + BadStatement: + description: A placeholder for statements for which no correct statement nodes can be created + properties: + text: + description: Raw source text + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + BandViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + lowerColumn: + type: string + mainColumn: + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - band + type: string + upperColumn: + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + type: object + BinaryExpression: + description: uses binary operators to act on two operands in an expression + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Block: + description: A set of statements + properties: + body: + description: Block body + items: + $ref: '#/components/schemas/Statement' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + BooleanLiteral: + description: Represents boolean values + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: boolean + type: object + Bucket: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/buckets/1/labels + members: /api/v2/buckets/1/members + org: /api/v2/orgs/2 + owners: /api/v2/buckets/1/owners + self: /api/v2/buckets/1 + write: /api/v2/write?org=2&bucket=1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this bucket. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members that can read this bucket. + org: + $ref: '#/components/schemas/Link' + description: The URL to retrieve parent organization for this bucket. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners that can read and write to this bucket. + self: + $ref: '#/components/schemas/Link' + description: The URL for this bucket. + write: + $ref: '#/components/schemas/Link' + description: The URL to write line protocol to this bucket. + readOnly: true + type: object + name: + type: string + orgID: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + type: + default: user + enum: + - user + - system + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - retentionRules + Buckets: + properties: + buckets: + items: + $ref: '#/components/schemas/Bucket' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + BuilderAggregateFunctionType: + enum: + - filter + - group + type: string + BuilderConfig: + properties: + aggregateWindow: + properties: + fillValues: + type: boolean + period: + type: string + type: object + buckets: + items: + type: string + type: array + functions: + items: + $ref: '#/components/schemas/BuilderFunctionsType' + type: array + tags: + items: + $ref: '#/components/schemas/BuilderTagsType' + type: array + type: object + BuilderFunctionsType: + properties: + name: + type: string + type: object + BuilderTagsType: + properties: + aggregateFunctionType: + $ref: '#/components/schemas/BuilderAggregateFunctionType' + key: + type: string + values: + items: + type: string + type: array + type: object + BuiltinStatement: + description: Declares a builtin identifier and its type + properties: + id: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + CallExpression: + description: Represents a function call + properties: + arguments: + description: Function arguments + items: + $ref: '#/components/schemas/Expression' + type: array + callee: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Cell: + properties: + h: + format: int32 + type: integer + id: + type: string + links: + properties: + self: + type: string + view: + type: string + type: object + viewID: + description: The reference to a view from the views API. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellUpdate: + properties: + h: + format: int32 + type: integer + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellWithViewProperties: + allOf: + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object + type: object + Cells: + items: + $ref: '#/components/schemas/Cell' + type: array + CellsWithViewProperties: + items: + $ref: '#/components/schemas/CellWithViewProperties' + type: array + Check: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + CheckBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the check. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/checks/1/labels + members: /api/v2/checks/1/members + owners: /api/v2/checks/1/owners + query: /api/v2/checks/1/query + self: /api/v2/checks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this check. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this check. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this check. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this check. + self: + $ref: '#/components/schemas/Link' + description: The URL for this check. + readOnly: true + type: object + name: + type: string + orgID: + description: The ID of the organization that owns this check. + type: string + ownerID: + description: The ID of creator used to create this check. + readOnly: true + type: string + query: + $ref: '#/components/schemas/DashboardQuery' + status: + $ref: '#/components/schemas/TaskStatusType' + taskID: + description: The ID of the task associated with this check. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - orgID + - query + CheckDiscriminator: + discriminator: + mapping: + custom: '#/components/schemas/CustomCheck' + deadman: '#/components/schemas/DeadmanCheck' + threshold: '#/components/schemas/ThresholdCheck' + propertyName: type + oneOf: + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' + CheckPatch: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + CheckStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + type: string + CheckViewProperties: + properties: + adaptiveZoomHide: + type: boolean + check: + $ref: '#/components/schemas/Check' + checkID: + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - check + type: string + required: + - type + - shape + - checkID + - queries + - colors + type: object + Checks: + properties: + checks: + items: + $ref: '#/components/schemas/Check' + type: array + links: + $ref: '#/components/schemas/Links' + ColorMapping: + additionalProperties: + type: string + description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. + example: + configcat_deployments-autopromotionblocker: '#663cd0' + measurement_birdmigration_europe: '#663cd0' + series_id_1: '#edf529' + series_id_2: '#edf529' + type: object + ColumnDataType: + enum: + - integer + - float + - boolean + - string + - unsigned + type: string + ColumnSemanticType: + enum: + - timestamp + - tag + - field + nullable: false + type: string + ConditionalExpression: + description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` + properties: + alternate: + $ref: '#/components/schemas/Expression' + consequent: + $ref: '#/components/schemas/Expression' + test: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + ConstantVariableProperties: + properties: + type: + enum: + - constant + type: string + values: + items: + type: string + type: array + CreateCell: + properties: + h: + format: int32 + type: integer + name: + type: string + usingView: + description: Makes a copy of the provided view. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CreateDashboardRequest: + properties: + description: + description: The user-facing description of the dashboard. + type: string + name: + description: The user-facing name of the dashboard. + type: string + orgID: + description: The ID of the organization that owns the dashboard. + type: string + required: + - orgID + - name + CustomCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object + DBRP: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + If set to `true`, this DBRP mapping is the default retention policy + for the database (specified by the `database` property's value). + type: boolean + id: + description: | + The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. + readOnly: true + type: string + links: + $ref: '#/components/schemas/Links' + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + virtual: + description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. + type: boolean + required: + - id + - orgID + - bucketID + - database + - retention_policy + - default + type: object + DBRPCreate: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + type: boolean + org: + description: | + An organization name. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + required: + - bucketID + - database + - retention_policy + type: object + DBRPGet: + properties: + content: + $ref: '#/components/schemas/DBRP' + required: true + type: object + DBRPUpdate: + properties: + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + To remove the default mapping, set to `false`. + type: boolean + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + DBRPs: + properties: + content: + items: + $ref: '#/components/schemas/DBRP' + type: array + Dashboard: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/Cells' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + DashboardColor: + description: Defines an encoding of data value into color space. + properties: + hex: + description: The hex number of the color + maxLength: 7 + minLength: 7 + type: string + id: + description: The unique ID of the view color. + type: string + name: + description: The user-facing name of the hex color. + type: string + type: + description: Type is how the color is used. + enum: + - min + - max + - threshold + - scale + - text + - background + type: string + value: + description: The data value mapped to this color. + format: float + type: number + required: + - id + - type + - hex + - name + - value + type: object + DashboardQuery: + properties: + builderConfig: + $ref: '#/components/schemas/BuilderConfig' + editMode: + $ref: '#/components/schemas/QueryEditMode' + name: + type: string + text: + description: The text of the Flux query. + type: string + type: object + DashboardWithViewProperties: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/CellsWithViewProperties' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + Dashboards: + properties: + dashboards: + items: + $ref: '#/components/schemas/Dashboard' + type: array + links: + $ref: '#/components/schemas/Links' + type: object + DateTimeLiteral: + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp). + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + format: date-time + type: string + type: object + DeadmanCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + level: + $ref: '#/components/schemas/CheckStatusLevel' + offset: + description: Duration to delay after the schedule, before executing check. + type: string + reportZero: + description: If only zero values reported since time, trigger an alert + type: boolean + staleTime: + description: String duration for time that a series is considered stale and should not trigger deadman. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + timeSince: + description: String duration before deadman triggers. + type: string + type: + enum: + - deadman + type: string + required: + - type + type: object + DecimalPlaces: + description: Indicates whether decimal places should be enforced, and how many digits it should show. + properties: + digits: + description: The number of digits after decimal to display + format: int32 + type: integer + isEnforced: + description: Indicates whether decimal point setting should be enforced + type: boolean + type: object + DeletePredicateRequest: + description: The delete predicate request. + properties: + predicate: + description: | + An expression in [delete predicate syntax](/influxdb/cloud-serverless/reference/syntax/delete-predicate/). + example: tag1="value1" and (tag2="value2" and tag3!="value3") + type: string + start: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + The earliest time to delete from. + format: date-time + type: string + stop: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + The latest time to delete from. + format: date-time + type: string + required: + - start + - stop + type: object + Dialect: + description: | + Options for tabular data output. + Default output is [annotated CSV](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#csv-response-format) with headers. - See how to [use the InfluxDB v2 API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + For more information about tabular data **dialect**, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). + properties: + annotations: + description: | + Annotation rows to include in the results. + An _annotation_ is metadata associated with an object (column) in the data model. - ### InfluxDB v1 compatibility + #### Related guides - The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. + - See [Annotated CSV annotations](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#annotations) for examples and more information. - See how to [use the InfluxDB v1 API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v1/). - name: API compatibility - x-traitTag: true - - description: | - Use one of the following schemes to authenticate to the InfluxDB API: + For more information about **annotations** in tabular data, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). + items: + enum: + - group + - datatype + - default + type: string + type: array + uniqueItems: true + commentPrefix: + default: '#' + description: The character prefixed to comment strings. Default is a number sign (`#`). + maxLength: 1 + minLength: 0 + type: string + dateTimeFormat: + default: RFC3339 + description: | + The format for timestamps in results. + Default is [`RFC3339` date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). + To include nanoseconds in timestamps, use `RFC3339Nano`. - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - name: Authentication - x-traitTag: true - - description: | - Create and manage authorizations (API tokens). + #### Example formatted date/time values - An _authorization_ contains a list of `read` and `write` - permissions for organization resources and provides an API token for authentication. - An authorization belongs to an organization and only contains permissions for that organization. + | Format | Value | + |:------------|:----------------------------| + | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | + | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | + enum: + - RFC3339 + - RFC3339Nano + type: string + delimiter: + default: ',' + description: The separator used between cells. Default is a comma (`,`). + maxLength: 1 + minLength: 1 + type: string + header: + default: true + description: If true, the results contain a header row. + type: boolean + type: object + DictExpression: + description: Used to create and directly specify the elements of a dictionary + properties: + elements: + description: Elements of the dictionary + items: + $ref: '#/components/schemas/DictItem' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + DictItem: + description: A key-value pair in a dictionary. + properties: + key: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + val: + $ref: '#/components/schemas/Expression' + type: object + Duration: + description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. + properties: + magnitude: + type: integer + type: + $ref: '#/components/schemas/NodeType' + unit: + type: string + type: object + DurationLiteral: + description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration + properties: + type: + $ref: '#/components/schemas/NodeType' + values: + description: Duration values + items: + $ref: '#/components/schemas/Duration' + type: array + type: object + Error: + properties: + code: + $ref: '#/components/schemas/ErrorCode' + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + ErrorCode: + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + Expression: + oneOf: + - $ref: '#/components/schemas/ArrayExpression' + - $ref: '#/components/schemas/DictExpression' + - $ref: '#/components/schemas/FunctionExpression' + - $ref: '#/components/schemas/BinaryExpression' + - $ref: '#/components/schemas/CallExpression' + - $ref: '#/components/schemas/ConditionalExpression' + - $ref: '#/components/schemas/LogicalExpression' + - $ref: '#/components/schemas/MemberExpression' + - $ref: '#/components/schemas/IndexExpression' + - $ref: '#/components/schemas/ObjectExpression' + - $ref: '#/components/schemas/ParenExpression' + - $ref: '#/components/schemas/PipeExpression' + - $ref: '#/components/schemas/UnaryExpression' + - $ref: '#/components/schemas/BooleanLiteral' + - $ref: '#/components/schemas/DateTimeLiteral' + - $ref: '#/components/schemas/DurationLiteral' + - $ref: '#/components/schemas/FloatLiteral' + - $ref: '#/components/schemas/IntegerLiteral' + - $ref: '#/components/schemas/PipeLiteral' + - $ref: '#/components/schemas/RegexpLiteral' + - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/UnsignedIntegerLiteral' + - $ref: '#/components/schemas/Identifier' + ExpressionStatement: + description: May consist of an expression that doesn't return a value and is executed solely for its side-effects + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Field: + properties: + alias: + description: Alias overrides the field name in the returned response. Applies only if type is `func` + type: string + args: + description: Args are the arguments to the function + items: + $ref: '#/components/schemas/Field' + type: array + type: + description: '`type` describes the field type. `func` is a function. `field` is a field reference.' + enum: + - func + - field + - integer + - number + - regex + - wildcard + type: string + value: + description: value is the value of the field. Meaning of the value is implied by the `type` key + type: string + type: object + File: + description: Represents a source from a single file + properties: + body: + description: List of Flux statements + items: + $ref: '#/components/schemas/Statement' + type: array + imports: + description: A list of package imports + items: + $ref: '#/components/schemas/ImportDeclaration' + type: array + name: + description: The name of the file. + type: string + package: + $ref: '#/components/schemas/PackageClause' + type: + $ref: '#/components/schemas/NodeType' + type: object + Flags: + additionalProperties: true + type: object + FloatLiteral: + description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: number + type: object + FluxResponse: + description: Rendered flux that backs the check or notification. + properties: + flux: + type: string + FluxSuggestion: + properties: + name: + type: string + params: + additionalProperties: + type: string + type: object + type: object + FluxSuggestions: + properties: + funcs: + items: + $ref: '#/components/schemas/FluxSuggestion' + type: array + type: object + FunctionExpression: + description: Function expression + properties: + body: + $ref: '#/components/schemas/Node' + params: + description: Function parameters + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + GaugeViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - gauge + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + GeoCircleViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Circle color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + interpolateColors: + description: Interpolate circle color based on displayed value + type: boolean + radius: + description: Maximum radius size in pixels + type: integer + radiusDimension: + $ref: '#/components/schemas/Axis' + radiusField: + description: Radius field + type: string + required: + - radiusField + - radiusDimension + - colorField + - colorDimension + - colors + type: object + GeoHeatMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + blur: + description: Blur for heatmap points + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + intensityDimension: + $ref: '#/components/schemas/Axis' + intensityField: + description: Intensity field + type: string + radius: + description: Radius size in pixels + type: integer + required: + - intensityField + - intensityDimension + - radius + - blur + - colors + type: object + GeoPointMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + isClustered: + description: Cluster close markers together + type: boolean + tooltipColumns: + description: An array for which columns to display in tooltip + items: + type: string + type: array + required: + - colorField + - colorDimension + - colors + type: object + GeoTrackMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + randomColors: + description: Assign different colors to different tracks + type: boolean + speed: + description: Speed of the track animation + type: integer + trackWidth: + description: Width of the track + type: integer + GeoViewLayer: + oneOf: + - $ref: '#/components/schemas/GeoCircleViewLayer' + - $ref: '#/components/schemas/GeoHeatMapViewLayer' + - $ref: '#/components/schemas/GeoPointMapViewLayer' + - $ref: '#/components/schemas/GeoTrackMapViewLayer' + type: object + GeoViewLayerProperties: + properties: + type: + enum: + - heatmap + - circleMap + - pointMap + - trackMap + type: string + required: + - type + type: object + GeoViewProperties: + properties: + allowPanAndZoom: + default: true + description: If true, map zoom and pan controls are enabled on the dashboard view + type: boolean + center: + description: Coordinates of the center of the map + properties: + lat: + description: Latitude of the center of the map + format: double + type: number + lon: + description: Longitude of the center of the map + format: double + type: number + required: + - lat + - lon + type: object + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + detectCoordinateFields: + default: true + description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns + type: boolean + latLonColumns: + $ref: '#/components/schemas/LatLonColumns' + layers: + description: List of individual layers shown in the map + items: + $ref: '#/components/schemas/GeoViewLayer' + type: array + mapStyle: + description: Define map type - regular, satellite etc. + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + s2Column: + description: String to define the column + type: string + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - geo + type: string + useS2CellID: + description: If true, S2 column is used to calculate lat/lon + type: boolean + zoom: + description: Zoom level used for initial display of the map + format: double + maximum: 28 + minimum: 1 + type: number + required: + - type + - shape + - queries + - note + - showNoteWhenEmpty + - center + - zoom + - allowPanAndZoom + - detectCoordinateFields + - layers + type: object + GreaterThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - greater + type: string + value: + format: float + type: number + required: + - type + - value + type: object + HTTPNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer + type: string + contentTemplate: + type: string + headers: + additionalProperties: + type: string + description: Customized headers. + type: object + method: + enum: + - POST + - GET + - PUT + type: string + password: + type: string + token: + type: string + url: + type: string + username: + type: string + required: + - url + - authMethod + - method + type: object + type: object + HTTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' + HTTPNotificationRuleBase: + properties: + type: + enum: + - http + type: string + url: + type: string + required: + - type + type: object + HealthCheck: + properties: + checks: + items: + $ref: '#/components/schemas/HealthCheck' + type: array + commit: + type: string + message: + type: string + name: + type: string + status: + enum: + - pass + - fail + type: string + version: + type: string + required: + - name + - status + type: object + HeatmapViewProperties: + properties: + adaptiveZoomHide: + type: boolean + binSize: + type: number + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - heatmap + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize + type: object + HistogramViewProperties: + properties: + binCount: + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + fillColumns: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - histogram + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + format: float + type: number + type: array + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount + type: object + Identifier: + description: A valid Flux identifier + properties: + name: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + ImportDeclaration: + description: Declares a package import + properties: + as: + $ref: '#/components/schemas/Identifier' + path: + $ref: '#/components/schemas/StringLiteral' + type: + $ref: '#/components/schemas/NodeType' + type: object + IndexExpression: + description: Represents indexing into an array + properties: + array: + $ref: '#/components/schemas/Expression' + index: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + InfluxqlCsvResponse: + description: CSV Response to InfluxQL Query + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + type: string + InfluxqlJsonResponse: + description: JSON Response to InfluxQL Query + properties: + results: + items: + properties: + error: + type: string + series: + items: + properties: + columns: + items: + type: string + type: array + name: + type: string + partial: + type: boolean + tags: + additionalProperties: + type: string + type: object + values: + items: + items: {} + type: array + type: array + type: object + type: array + statement_id: + type: integer + type: object + type: array + type: object + IntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + IsOnboarding: + properties: + allowed: + description: | + If `true`, the InfluxDB instance hasn't had initial setup; + `false` otherwise. + type: boolean + type: object + Label: + properties: + id: + readOnly: true + type: string + name: + type: string + orgID: + readOnly: true + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + type: object + LabelCreateRequest: + properties: + name: + type: string + orgID: + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. - We recommend the following for managing your tokens: + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + required: + - orgID + - name + type: object + LabelMapping: + description: A _label mapping_ contains a `label` ID to attach to a resource. + properties: + labelID: + description: | + A label ID. + Specifies the label to attach. + type: string + required: + - labelID + type: object + LabelResponse: + properties: + label: + $ref: '#/components/schemas/Label' + links: + $ref: '#/components/schemas/Links' + type: object + LabelUpdate: + properties: + name: + type: string + properties: + additionalProperties: + description: | + Key-value pairs associated with this label. - - Create a generic user to create and manage tokens for writing data. - - Store your tokens in a secure password vault for future access. + To remove a property, send an update with an empty value (`""`) for the key. + type: string + example: + color: ffb3b3 + description: this is a description + type: object + type: object + Labels: + items: + $ref: '#/components/schemas/Label' + type: array + LabelsResponse: + properties: + labels: + $ref: '#/components/schemas/Labels' + links: + $ref: '#/components/schemas/Links' + type: object + LanguageRequest: + description: Flux query to be analyzed. + properties: + query: + description: | + The Flux query script to be analyzed. + type: string + required: + - query + type: object + LatLonColumn: + description: Object type for key and column definitions + properties: + column: + description: Column to look up Lat/Lon + type: string + key: + description: Key to determine whether the column is tag/field + type: string + required: + - key + - column + type: object + LatLonColumns: + description: Object type to define lat/lon columns + properties: + lat: + $ref: '#/components/schemas/LatLonColumn' + lon: + $ref: '#/components/schemas/LatLonColumn' + required: + - lat + - lon + type: object + LegacyAuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: The organization ID. Identifies the organization that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions that provide `read` and `write` access to organization resources. + An authorization must contain at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: The name that you provide for the authorization. + type: string + userID: + description: The user ID. Identifies the user that the authorization is scoped to. + type: string + type: object + required: + - orgID + - permissions + LesserThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - lesser + type: string + value: + format: float + type: number + required: + - type + - value + type: object + Limit: + description: These are org limits similar to those configured in/by quartz. + properties: + bucket: + properties: + maxBuckets: + type: integer + maxRetentionDuration: + description: Max bucket retention duration in nanoseconds. 0 is unlimited. + type: integer + required: + - maxBuckets + - maxRetentionDuration + type: object + check: + properties: + maxChecks: + type: integer + required: + - maxChecks + type: object + dashboard: + properties: + maxDashboards: + type: integer + required: + - maxDashboards + type: object + features: + properties: + allowDelete: + description: allow delete predicate endpoint + type: boolean + type: object + notificationEndpoint: + properties: + blockedNotificationEndpoints: + description: comma separated list of notification endpoints + example: http,pagerduty + type: string + required: + - blockNotificationEndpoints + type: object + notificationRule: + properties: + blockedNotificationRules: + description: comma separated list of notification rules + example: http,pagerduty + type: string + maxNotifications: + type: integer + required: + - maxNotifications + - blockNotificationRules + type: object + orgID: + type: string + rate: + properties: + cardinality: + description: Allowed organization total cardinality. 0 is unlimited. + type: integer + concurrentDeleteRequests: + description: Allowed organization concurrent outstanding delete requests. + type: integer + concurrentReadRequests: + description: Allowed concurrent queries. 0 is unlimited. + type: integer + concurrentWriteRequests: + description: Allowed concurrent writes. 0 is unlimited. + type: integer + deleteRequestsPerSecond: + description: Allowed organization delete request rate. + type: integer + queryTime: + description: Query Time in nanoseconds + type: integer + readKBs: + description: Query limit in kb/sec. 0 is unlimited. + type: integer + writeKBs: + description: Write limit in kb/sec. 0 is unlimited. + type: integer + required: + - readKBs + - queryTime + - concurrentReadRequests + - writeKBs + - concurrentWriteRequests + - cardinality + type: object + stack: + properties: + enabled: + type: boolean + required: + - enabled + type: object + task: + properties: + maxTasks: + type: integer + required: + - maxTasks + type: object + timeout: + properties: + queryUnconditionalTimeoutSeconds: + type: integer + queryidleWriteTimeoutSeconds: + type: integer + required: + - queryUnconditionalTimeoutSeconds + - queryidleWriteTimeoutSeconds + type: object + required: + - rate + - bucket + - task + - dashboard + - check + - notificationRule + - notificationEndpoint + type: object + LinePlusSingleStatProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + timeFormat: + type: string + type: + enum: + - line-plus-single-stat + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - prefix + - suffix + - decimalPlaces + - position + type: object + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - invalid + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + required: + - code + - message + Link: + description: URI of resource. + format: uri + readOnly: true + type: string + Links: + description: | + URI pointers for additional paged results. + properties: + next: + $ref: '#/components/schemas/Link' + prev: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + required: + - self + type: object + LogEvent: + properties: + message: + description: A description of the event that occurred. + example: Halt and catch fire + readOnly: true + type: string + runID: + description: The ID of the task run that generated the event. + readOnly: true + type: string + time: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + type: object + LogicalExpression: + description: Represents the rule conditions that collectively evaluate to either true or false + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Logs: + properties: + events: + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + type: object + MapVariableProperties: + properties: + type: + enum: + - map + type: string + values: + additionalProperties: + type: string + type: object + MarkdownViewProperties: + properties: + note: + type: string + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - markdown + type: string + required: + - type + - shape + - note + type: object + MeasurementSchema: + description: Definition of a measurement schema. + example: + bucketID: ba3c5e7f9b0a0010 + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + bucketID: + description: The ID of the bucket that the measurement schema is associated with. + type: string + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + createdAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + name: + nullable: false + type: string + orgID: + description: The ID of the organization. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - columns + - createdAt + - updatedAt + type: object + MeasurementSchemaColumn: + description: Definition of a measurement schema column. + example: + format: unix timestamp + name: time + type: integer + properties: + dataType: + $ref: '#/components/schemas/ColumnDataType' + name: + type: string + type: + $ref: '#/components/schemas/ColumnSemanticType' + required: + - name + - type + type: object + MeasurementSchemaCreateRequest: + description: Create a new measurement schema. + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + name: cpu + properties: + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + name: + description: | + The [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) + name. + type: string + required: + - name + - columns + type: object + MeasurementSchemaList: + description: A list of measurement schemas returning summary information + example: + measurementSchemas: + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8643 + name: memory + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8644 + name: disk + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + measurementSchemas: + items: + $ref: '#/components/schemas/MeasurementSchema' + type: array + required: + - measurementSchemas + type: object + MeasurementSchemaUpdateRequest: + description: Update an existing measurement schema + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + properties: + columns: + description: An ordered collection of column definitions + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + required: + - columns + type: object + MemberAssignment: + description: Object property assignment + properties: + init: + $ref: '#/components/schemas/Expression' + member: + $ref: '#/components/schemas/MemberExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + MemberExpression: + description: Represents accessing a property of an object + properties: + object: + $ref: '#/components/schemas/Expression' + property: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + type: object + MosaicViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - mosaic + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yLabelColumnSeparator: + type: string + yLabelColumns: + items: + type: string + type: array + yPrefix: + type: string + ySeriesColumns: + items: + type: string + type: array + ySuffix: + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - ySeriesColumns + - fillColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + Node: + oneOf: + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' + NodeType: + description: Type of AST node + type: string + NotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + NotificationEndpointBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification endpoint. + type: string + id: + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/notificationEndpoints/1/labels + members: /api/v2/notificationEndpoints/1/members + owners: /api/v2/notificationEndpoints/1/owners + self: /api/v2/notificationEndpoints/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this endpoint. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this endpoint. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this endpoint. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + type: string + orgID: + type: string + status: + default: active + description: The status of the endpoint. + enum: + - active + - inactive + type: string + type: + $ref: '#/components/schemas/NotificationEndpointType' + updatedAt: + format: date-time + readOnly: true + type: string + userID: + type: string + required: + - type + - name + type: object + NotificationEndpointDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationEndpoint' + pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' + slack: '#/components/schemas/SlackNotificationEndpoint' + telegram: '#/components/schemas/TelegramNotificationEndpoint' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' + NotificationEndpointType: + enum: + - slack + - pagerduty + - http + - telegram + type: string + NotificationEndpointUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationEndpoints: + properties: + links: + $ref: '#/components/schemas/Links' + notificationEndpoints: + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + NotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + NotificationRuleBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification rule. + type: string + endpointID: + type: string + every: + description: The notification repetition interval. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + limit: + description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. + type: integer + limitEvery: + description: Don't notify me more than times every seconds. If set, limit cannot be empty. + type: integer + links: + example: + labels: /api/v2/notificationRules/1/labels + members: /api/v2/notificationRules/1/members + owners: /api/v2/notificationRules/1/owners + query: /api/v2/notificationRules/1/query + self: /api/v2/notificationRules/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this notification rule. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this notification rule. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this notification rule. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this notification rule. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + description: Human-readable name describing the notification rule. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + orgID: + description: The ID of the organization that owns this notification rule. + type: string + ownerID: + description: The ID of creator used to create this notification rule. + readOnly: true + type: string + runbookLink: + type: string + sleepUntil: + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + statusRules: + description: List of status rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/StatusRule' + minItems: 1 + type: array + tagRules: + description: List of tag rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/TagRule' + type: array + taskID: + description: The ID of the task associated with this notification rule. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - orgID + - status + - name + - statusRules + - endpointID + type: object + NotificationRuleDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationRule' + pagerduty: '#/components/schemas/PagerDutyNotificationRule' + slack: '#/components/schemas/SlackNotificationRule' + smtp: '#/components/schemas/SMTPNotificationRule' + telegram: '#/components/schemas/TelegramNotificationRule' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' + NotificationRuleUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationRules: + properties: + links: + $ref: '#/components/schemas/Links' + notificationRules: + items: + $ref: '#/components/schemas/NotificationRule' + type: array + ObjectExpression: + description: Allows the declaration of an anonymous object within a declaration + properties: + properties: + description: Object properties + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + OnboardingRequest: + properties: + bucket: + type: string + limit: + $ref: '#/components/schemas/Limit' + org: + type: string + password: + type: string + retentionPeriodHrs: + deprecated: true + type: integer + retentionPeriodSeconds: + type: integer + username: + type: string + required: + - username + - org + - bucket + type: object + OnboardingResponse: + properties: + auth: + $ref: '#/components/schemas/Authorization' + bucket: + $ref: '#/components/schemas/Bucket' + org: + $ref: '#/components/schemas/Organization' + user: + $ref: '#/components/schemas/UserResponse' + type: object + OptionStatement: + description: A single variable declaration + properties: + assignment: + oneOf: + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Organization: + properties: + createdAt: + format: date-time + readOnly: true + type: string + defaultStorageType: + description: Discloses whether the organization uses TSM or IOx. + enum: + - tsm + - iox + type: string + description: + type: string + id: + readOnly: true + type: string + links: + example: + buckets: /api/v2/buckets?org=myorg + dashboards: /api/v2/dashboards?org=myorg + labels: /api/v2/orgs/1/labels + members: /api/v2/orgs/1/members + owners: /api/v2/orgs/1/owners + secrets: /api/v2/orgs/1/secrets + self: /api/v2/orgs/1 + tasks: /api/v2/tasks?org=myorg + properties: + buckets: + $ref: '#/components/schemas/Link' + dashboards: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + secrets: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + tasks: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + type: string + status: + default: active + description: If inactive, the organization is inactive. + enum: + - active + - inactive + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + Organizations: + properties: + links: + $ref: '#/components/schemas/Links' + orgs: + items: + $ref: '#/components/schemas/Organization' + type: array + type: object + Package: + description: Represents a complete package source tree. + properties: + files: + description: Package files + items: + $ref: '#/components/schemas/File' + type: array + package: + description: Package name + type: string + path: + description: Package import path + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + PackageClause: + description: Defines a package identifier + properties: + name: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + PagerDutyNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + clientURL: + type: string + routingKey: + type: string + required: + - routingKey + type: object + type: object + PagerDutyNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' + PagerDutyNotificationRuleBase: + properties: + messageTemplate: + type: string + type: + enum: + - pagerduty + type: string + required: + - type + - messageTemplate + type: object + Params: + properties: + params: + additionalProperties: + enum: + - any + - bool + - duration + - float + - int + - string + - time + - uint + type: string + description: | + The `params` keys and value type defined in the script. + type: object + type: object + ParenExpression: + description: Represents an expression wrapped in parenthesis + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PasswordResetBody: + properties: + password: + type: string + required: + - password + PatchBucketRequest: + description: | + An object that contains updated bucket properties to apply. + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The name of the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/PatchRetentionRules' + type: object + PatchOrganizationRequest: + description: | + An object that contains updated organization properties to apply. + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + type: object + PatchRetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The number of seconds to keep data. + Default duration is `2592000` (30 days). + `0` represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The [shard group duration](/influxdb/cloud-serverless/reference/glossary/#shard). + The number of seconds that each shard group covers. - ### User sessions with authorizations + #### InfluxDB Cloud Serverless - Optionally, when creating an authorization, you can scope it to a specific user. - If the user signs in with username and password, creating a _user session_, - the session carries the permissions granted by all the user's authorizations. - For more information, see [how to assign a token to a specific user](/influxdb/cloud-serverless/security/tokens/create-token/). - To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + - Doesn't use `shardGroupDurationsSeconds`. - ### Related endpoints + #### InfluxDB OSS - - [Signin](#tag/Signin) - - [Signout](#tag/Signout) + - Default value depends on the [bucket retention period](/influxdb/cloud-serverless/reference/internals/shards/#shard-group-duration). - ### Related guides + #### Related guides - - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) - - [Assign a token to a specific user](/influxdb/cloud-serverless/security/tokens/create-token/) - name: Authorizations (API tokens) - - name: Bucket Schemas - - description: | - Store your data in InfluxDB [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket). - A bucket is a named location where time series data is stored. All buckets - have a [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period), - a duration of time that each data point persists. InfluxDB drops all - points with timestamps older than the bucket’s retention period. - A bucket belongs to an organization. + - InfluxDB [shards and shard groups](/influxdb/cloud-serverless/reference/internals/shards/) + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + PatchRetentionRules: + description: Updates to rules to expire or retain data. No rules means no updates. + items: + $ref: '#/components/schemas/PatchRetentionRule' + type: array + Permission: + properties: + action: + enum: + - read + - write + type: string + resource: + $ref: '#/components/schemas/Resource' + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + required: + - action + - resource + PipeExpression: + description: Call expression with pipe argument + properties: + argument: + $ref: '#/components/schemas/Expression' + call: + $ref: '#/components/schemas/CallExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PipeLiteral: + description: Represents a specialized literal value, indicating the left hand value of a pipe expression + properties: + type: + $ref: '#/components/schemas/NodeType' + type: object + PostBucketRequest: + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The bucket name. + type: string + orgID: + description: | + The organization ID. + Specifies the organization that owns the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + default: '0' + description: | + The retention policy for the bucket. + For InfluxDB 1.x, specifies the duration of time that each data point + in the retention policy persists. - ### Related guides + If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; + otherwise, see the `retentionRules` property. - - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) - name: Buckets - - name: Cells - - name: Checks - - description: | - To specify resources, some InfluxDB API endpoints require parameters or - properties in the request--for example, - writing to a `bucket` resource in an `org` (_organization_ resource). + [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) + is an InfluxDB 1.x concept. + The InfluxDB 2.x and Cloud equivalent is + [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + description: | + The schema Type. Default is `implicit`. + required: + - orgID + - name + PostCheck: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + PostNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + PostNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + PostOrganizationRequest: + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + required: + - name + type: object + Property: + description: The value associated with a key + properties: + key: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + value: + $ref: '#/components/schemas/Expression' + type: object + PropertyKey: + oneOf: + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' + Query: + description: Query InfluxDB with the Flux language + properties: + dialect: + $ref: '#/components/schemas/Dialect' + extern: + $ref: '#/components/schemas/File' + now: + description: | + Specifies the time that should be reported as `now` in the query. + Default is the server `now` time. + format: date-time + type: string + params: + additionalProperties: true + description: | + Key-value pairs passed as parameters during query execution. - ### Common parameters + To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example: - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | - | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud-serverless/admin/buckets/view-buckets/). | - | `org` | string | The organization name or ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | - | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud-serverless/organizations/view-orgs/). | - name: Common parameters - x-traitTag: true - - name: Config - - name: Dashboards - - name: Data I/O endpoints - - description: | - The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) - and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). - InfluxDB 2.x replaces databases and retention policies with buckets. - To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, - databases and retention policies are mapped to buckets using the - database and retention policy (DBRP) mapping service. - The DBRP mapping service uses the database and retention policy - specified in 1.x compatibility API requests to route operations to a bucket. + ```json + query: "from(bucket: params.mybucket)\ + |> range(start: params.rangeStart) |> limit(n:1)" + ``` - ### Related guides + and pass _`params`_ with the key-value pairs--for example: - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) - name: DBRPs - - description: | - Delete data from an InfluxDB bucket. - name: Delete - - description: | - InfluxDB HTTP API endpoints use standard HTTP request and response headers. - The following table shows common headers used by many InfluxDB API endpoints. - Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + ```json + params: { + "mybucket": "environment", + "rangeStart": "-30d" + } + ``` - | Header | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `Accept` | string | The content type that the client can understand. | - | `Authorization` | string | The authorization scheme and credential. | - | `Content-Length` | integer | The size of the entity-body, in bytes. | - | `Content-Type` | string | The format of the data in the request body. | - name: Headers - x-traitTag: true - - description: | - Store, manage, and execute scripts in InfluxDB. - A script stores your custom Flux script and provides an invokable - endpoint that accepts runtime parameters. - In a script, you can specify custom runtime parameters - (`params`)--for example, `params.myparameter`. - Once you create a script, InfluxDB generates an - [`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke) - for your organization. - You can run the script from API requests and tasks, defining parameter - values for each run. - When the script runs, InfluxDB replaces `params` references in the - script with the runtime parameter values you define. + During query execution, InfluxDB passes _`params`_ to your script and substitutes the values. - Use the `/api/v2/scripts` endpoints to create and manage scripts. - See related guides to learn how to define parameters and execute scripts. + #### Limitations - - name: Invokable Scripts - - name: Labels - - name: Legacy Authorizations - - name: Limits - - name: NotificationEndpoints - - name: NotificationRules - - description: | - Manage your [organization](/influxdb/cloud-serverless/reference/glossary/#organization). - An organization is a workspace for a group of users. Organizations can be - used to separate different environments, projects, teams or users within - InfluxDB. + - If you use _`params`_, you can't use _`extern`_. + type: object + query: + description: The query script to execute. + type: string + type: + description: The type of query. Must be "flux". + enum: + - flux + type: string + required: + - query + type: object + QueryEditMode: + enum: + - builder + - advanced + type: string + QueryVariableProperties: + properties: + type: + enum: + - query + type: string + values: + properties: + language: + type: string + query: + type: string + type: object + RangeThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + max: + format: float + type: number + min: + format: float + type: number + type: + enum: + - range + type: string + within: + type: boolean + required: + - type + - min + - max + - within + type: object + Ready: + properties: + started: + example: '2019-03-13T10:09:33.891196-04:00' + format: date-time + type: string + status: + enum: + - ready + type: string + up: + example: 14m45.911966424s + type: string + type: object + RegexpLiteral: + description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + RenamableField: + description: Describes a field that can be renamed and made visible or invisible. + properties: + displayName: + description: The name that a field is renamed to by the user. + type: string + internalName: + description: The calculated name of a field. + readOnly: true + type: string + visible: + description: Indicates whether this field should be visible on the table. + type: boolean + type: object + Resource: + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + ResourceMember: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object + ResourceMembers: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceMember' + type: array + type: object + ResourceOwner: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object + ResourceOwners: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceOwner' + type: array + type: object + RetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The duration in seconds for how long data will be kept in the database. + The default duration is 2592000 (30 days). + 0 represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The shard group duration. + The duration or interval (in seconds) that each shard group covers. - Use the `/api/v2/orgs` endpoints to view and manage organizations. - name: Organizations - - description: | - Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + #### InfluxDB Cloud Serverless - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `limit` | integer | The maximum number of records to return (after other parameters are applied). | - | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | - | `after` | string (resource ID) | Only returns resources created after the specified resource. | + - Does not use `shardGroupDurationsSeconds`. + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + RetentionRules: + description: | + Retention rules to expire or retain data. + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period). - ### Limitations + #### InfluxDB Cloud Serverless - - For specific endpoint parameters and examples, see the endpoint definition. - - If you specify an `offset` parameter value greater than the total number of records, - then InfluxDB returns an empty list in the response - (given `offset` skips the specified number of records). + - `retentionRules` is required. - The following example passes `offset=50` to skip the first 50 results, - but the user only has 10 buckets: + #### InfluxDB OSS - ```sh - curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ - --header "Authorization: Token INFLUX_API_TOKEN" - ``` + - `retentionRules` isn't required. + items: + $ref: '#/components/schemas/RetentionRule' + type: array + ReturnStatement: + description: Defines an expression to return + properties: + argument: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Routes: + properties: + authorizations: + format: uri + type: string + buckets: + format: uri + type: string + dashboards: + format: uri + type: string + external: + properties: + statusFeed: + format: uri + type: string + type: object + flags: + format: uri + type: string + me: + format: uri + type: string + orgs: + format: uri + type: string + query: + properties: + analyze: + format: uri + type: string + ast: + format: uri + type: string + self: + format: uri + type: string + suggestions: + format: uri + type: string + type: object + setup: + format: uri + type: string + signin: + format: uri + type: string + signout: + format: uri + type: string + sources: + format: uri + type: string + system: + properties: + debug: + format: uri + type: string + health: + format: uri + type: string + metrics: + format: uri + type: string + type: object + tasks: + format: uri + type: string + telegrafs: + format: uri + type: string + users: + format: uri + type: string + variables: + format: uri + type: string + write: + format: uri + type: string + RuleStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY + type: string + Run: + properties: + finishedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + flux: + description: Flux used for the task + readOnly: true + type: string + id: + readOnly: true + type: string + links: + example: + retry: /api/v2/tasks/1/runs/1/retry + self: /api/v2/tasks/1/runs/1 + task: /api/v2/tasks/1 + properties: + retry: + format: uri + type: string + self: + format: uri + type: string + task: + format: uri + type: string + readOnly: true + type: object + log: + description: An array of logs associated with the run. + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + requestedAt: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + scheduledFor: + description: The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. + format: date-time + type: string + startedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + status: + enum: + - scheduled + - started + - failed + - success + - canceled + readOnly: true + type: string + taskID: + readOnly: true + type: string + RunManually: + properties: + scheduledFor: + description: | + The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) + used for the run's `now` option. + Default is the server _now_ time. + format: date-time + nullable: true + type: string + Runs: + properties: + links: + $ref: '#/components/schemas/Links' + runs: + items: + $ref: '#/components/schemas/Run' + type: array + type: object + SMTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' + SMTPNotificationRuleBase: + properties: + bodyTemplate: + type: string + subjectTemplate: + type: string + to: + type: string + type: + enum: + - smtp + type: string + required: + - type + - subjectTemplate + - to + type: object + ScatterViewProperties: + properties: + adaptiveZoomHide: + type: boolean + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + symbolColumns: + items: + type: string + type: array + timeFormat: + type: string + type: + enum: + - scatter + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + SchemaType: + enum: + - implicit + - explicit + type: string + Script: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + type: string + orgID: + type: string + script: + description: The script to execute. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + url: + description: The invocation endpoint address. + type: string + required: + - name + - orgID + - script + ScriptCreateRequest: + properties: + description: + description: Script description. A description of the script. + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + description: Script name. The name must be unique within the organization. + type: string + script: + description: The script to execute. + type: string + required: + - name + - script + - language + - description + type: object + ScriptHTTPResponseData: + description: | + The response body contains the results of the executed script. + The response is user-defined and dynamic. + format: binary + type: string + ScriptInvocationParams: + properties: + params: + additionalProperties: true + description: | + The script parameters. + `params` contains key-value pairs that map values to the **params.keys** + in a script. + When you invoke a script with `params`, InfluxDB passes the values as + invocation parameters to the script. + type: object + type: object + ScriptLanguage: + enum: + - flux + - sql + type: string + ScriptUpdateRequest: + properties: + description: + description: A description of the script. + type: string + script: + description: The script to execute. + type: string + type: object + Scripts: + properties: + scripts: + items: + $ref: '#/components/schemas/Script' + type: array + type: object + SecretKeys: + properties: + secrets: + items: + type: string + type: array + type: object + SecretKeysResponse: + allOf: + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object + Secrets: + additionalProperties: + type: string + example: + apikey: abc123xyz + SimpleTableViewProperties: + properties: + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showAll: + type: boolean + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - simple-table + type: string + required: + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty + type: object + SingleStatViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - single-stat + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + SlackNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + token: + description: Specifies the API token string. Specify either `URL` or `Token`. + type: string + url: + description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. + type: string + type: object + type: object + SlackNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' + SlackNotificationRuleBase: + properties: + channel: + type: string + messageTemplate: + type: string + type: + enum: + - slack + type: string + required: + - type + - messageTemplate + type: object + Stack: + properties: + createdAt: + format: date-time + readOnly: true + type: string + events: + items: + properties: + description: + type: string + eventType: + type: string + name: + type: string + resources: + items: + properties: + apiVersion: + type: string + associations: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + metaName: + type: string + type: object + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + links: + properties: + self: + type: string + type: object + resourceID: + type: string + templateMetaName: + type: string + type: object + type: array + sources: + items: + type: string + type: array + updatedAt: + format: date-time + readOnly: true + type: string + urls: + items: + type: string + type: array + type: object + type: array + id: + type: string + orgID: + type: string + type: object + Statement: + oneOf: + - $ref: '#/components/schemas/BadStatement' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/ExpressionStatement' + - $ref: '#/components/schemas/ReturnStatement' + - $ref: '#/components/schemas/OptionStatement' + - $ref: '#/components/schemas/BuiltinStatement' + - $ref: '#/components/schemas/TestStatement' + StaticLegend: + description: StaticLegend represents the options specific to the static legend + properties: + colorizeRows: + type: boolean + heightRatio: + format: float + type: number + opacity: + format: float + type: number + orientationThreshold: + type: integer + show: + type: boolean + valueAxis: + type: string + widthRatio: + format: float + type: number + type: object + StatusRule: + properties: + count: + type: integer + currentLevel: + $ref: '#/components/schemas/RuleStatusLevel' + period: + type: string + previousLevel: + $ref: '#/components/schemas/RuleStatusLevel' + type: object + StringLiteral: + description: Expressions begin and end with double quote marks + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + TableViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + fieldOptions: + description: fieldOptions represent the fields retrieved by the query with customization options + items: + $ref: '#/components/schemas/RenamableField' + type: array + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + tableOptions: + properties: + fixFirstColumn: + description: fixFirstColumn indicates whether the first column of the table should be locked + type: boolean + sortBy: + $ref: '#/components/schemas/RenamableField' + verticalTimeAxis: + description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically + type: boolean + wrapping: + description: Wrapping describes the text wrapping style to be used in table views + enum: + - truncate + - wrap + - single-line + type: string + type: object + timeFormat: + description: timeFormat describes the display format for time values according to moment.js date formatting + type: string + type: + enum: + - table + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces + type: object + TagRule: + properties: + key: + type: string + operator: + enum: + - equal + - notequal + - equalregex + - notequalregex + type: string + value: + type: string + type: object + Task: + properties: + authorizationID: + description: | + An authorization ID. + Specifies the authorization used when the task communicates with the query engine. - The response contains the following: + To find an authorization ID, use the + [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to + list authorizations. + type: string + createdAt: + format: date-time + readOnly: true + type: string + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. + type: string + description: + description: A description of the task. + type: string + every: + description: The interval ([duration literal](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. + format: duration + type: string + flux: + description: | + The Flux script that the task executes. - ```json - { - "links": { - "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", - "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" - }, - "buckets": [] - } - ``` - name: Pagination - x-traitTag: true - - name: Ping - - description: | - Query data stored in a bucket. + #### Limitations + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + format: flux + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/tasks/1/labels + logs: /api/v2/tasks/1/logs + members: /api/v2/tasks/1/members + owners: /api/v2/tasks/1/owners + runs: /api/v2/tasks/1/runs + self: /api/v2/tasks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + logs: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + runs: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + description: The name of the task. + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. + Specifies the organization that owns the task. + type: string + orgID: + description: | + An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) ID. + Specifies the organization that owns the task. + type: string + ownerID: + description: | + A [user](/influxdb/cloud-serverless/reference/glossary/#user) ID. + Specifies the owner of the task. - - HTTP clients can query the v1 [`/query` endpoint](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) - using **InfluxQL** and retrieve data in **CSV** or **JSON** format. - - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. + To find a user ID, you can use the + [`GET /api/v2/users` endpoint](#operation/GetUsers) to + list users. + type: string + scriptID: + description: | + A script ID. + Specifies the invokable script that the task executes. - #### Related guides + #### Limitations - - [Get started querying InfluxDB](/influxdb/cloud-serverless/get-started/query/) - - [Execute queries](/influxdb/cloud-serverless/query-data/execute-queries/) - name: Query - - description: | - See the [**Get started**](/influxdb/cloud-serverless/get-started/) tutorial - to get up and running authenticating with tokens, writing to buckets, and querying data. + - If you use the `scriptID` property, you can't use the `flux` property. - [**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-serverless/reference/client-libraries/) - are available to integrate InfluxDB with your application. - name: Quick start - x-traitTag: true - - name: Resources - - description: | - InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. - The response body may include additional details. - For details about a specific operation's response, - see **Responses** and **Response Samples** for that operation. + + type: string + scriptParameters: + description: | + Key-value pairs for `params` in the script. + Defines the invocation parameter values passed to the script specified by `scriptID`. + When running the task, InfluxDB executes the script with the parameters + you provide. - API operations may return the following HTTP status codes: + #### Limitations - |  Code  | Status | Description | - |:-----------:|:------------------------ |:--------------------- | - | `200` | Success | | - | `201` | Created | Successfully created a resource. The response body may contain details. | - | `204` | No content | The request succeeded. InfluxDB doesn't typically return a response body for the operation. The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints return a response body if some points are written and some are rejected. | - | `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.
  • The batch contains a point with the same series as other points, but one of the field values has a different data type.
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| - | `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-serverless/security/tokens/)
| - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `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`. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | - | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | - | `500` | Internal server error | | - | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | - name: Response codes - x-traitTag: true - - name: Routes - - name: Rules - - name: Secrets - - name: Security and access endpoints - - name: Setup - - name: Signin - - name: Signout - - 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" - name: Supported operations - x-traitTag: true - - name: System information endpoints - - description: | - Process and analyze your data with tasks - in the InfluxDB task engine. - Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + - To use `scriptParameters`, you must provide a `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - orgID + type: object + TaskCreateRequest: + properties: + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time. + type: string + description: + description: The description of the task. + type: string + every: + description: | + The interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. + `every` also determines when the task first runs, depending on the specified time. + type: string + flux: + description: | + The Flux script that the task runs. - 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). + #### Limitations - + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + type: string + name: + description: The name of the task + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: The name of the organization that owns the task. + type: string + orgID: + description: The ID of the organization that owns the task. + type: string + scriptID: + description: | + The ID of the script that the task runs. - ### Properties + #### Limitations - A `task` object contains information about an InfluxDB task resource. + - If you use the `scriptID` property, you can't use the `flux` property. + type: string + scriptParameters: + description: | + The parameter key-value pairs passed to the script (referenced by `scriptID`) during the task run. - The following table defines the properties that appear in this object: + #### Limitations - + - `scriptParameters` requires `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + TaskStatusType: + description: | + `inactive` cancels scheduled runs and prevents manual runs of the task. + enum: + - active + - inactive + type: string + TaskUpdateRequest: + properties: + cron: + description: Update the 'cron' option in the flux script. + type: string + description: + description: Update the description of the task. + type: string + every: + description: Update the 'every' option in the flux script. + type: string + flux: + description: Update the Flux script that the task runs. + type: string + name: + description: Update the 'name' option in the flux script. + type: string + offset: + description: Update the 'offset' option in the flux script. + type: string + scriptID: + description: Update the 'scriptID' of the task. + type: string + scriptParameters: + description: Update the 'scriptParameters' of the task. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + Tasks: + properties: + links: + $ref: '#/components/schemas/Links' + readOnly: true + tasks: + items: + $ref: '#/components/schemas/Task' + type: array + type: object + Telegraf: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + labels: /api/v2/telegrafs/1/labels + members: /api/v2/telegrafs/1/members + owners: /api/v2/telegrafs/1/owners + self: /api/v2/telegrafs/1 + properties: + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + type: object + type: object + TelegrafPlugin: + properties: + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + TelegrafPluginRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + plugins: + items: + properties: + alias: + type: string + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + type: array + type: object + TelegrafPlugins: + properties: + os: + type: string + plugins: + items: + $ref: '#/components/schemas/TelegrafPlugin' + type: array + version: + type: string + type: object + TelegrafRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + type: object + Telegrafs: + properties: + configurations: + items: + $ref: '#/components/schemas/Telegraf' + type: array + type: object + TelegramNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . + type: string + token: + description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . + type: string + required: + - token + - channel + type: object + type: object + TelegramNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' + TelegramNotificationRuleBase: + properties: + disableWebPagePreview: + description: Disables preview of web links in the sent messages when "true". Defaults to "false". + type: boolean + messageTemplate: + description: The message template as a flux interpolated string. + type: string + parseMode: + description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". + enum: + - MarkdownV2 + - HTML + - Markdown + type: string + type: + description: The discriminator between other types of notification rules is "telegram". + enum: + - telegram + type: string + required: + - type + - messageTemplate + - channel + type: object + Template: + items: + description: | + A template entry. + Defines an InfluxDB resource in a template. + properties: + apiVersion: + example: influxdata.com/v2alpha1 + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + metadata: + description: | + Metadata properties used for the resource when the template is applied. + properties: + name: + type: string + type: object + spec: + description: | + Configuration properties used for the resource when the template is applied. + Key-value pairs map to the specification for the resource. - - name: Tasks - - name: Telegraf Plugins - - name: Telegrafs - - description: | - Export and apply InfluxDB **templates**. - Manage **stacks** of templated InfluxDB resources. + The following code samples show `spec` configurations for template resources: - InfluxDB templates are prepackaged configurations for resources. - Use InfluxDB templates to configure a fresh instance of InfluxDB, - back up your dashboard configuration, or share your configuration. + - A bucket: - Use the `/api/v2/templates` endpoints to export templates and apply templates. + ```json + { "spec": { + "name": "iot_center", + "retentionRules": [{ + "everySeconds": 2.592e+06, + "type": "expire" + }] + } + } + ``` - **InfluxDB stacks** are stateful InfluxDB templates that let you - add, update, and remove installed template resources over time, avoid duplicating - resources when applying the same or similar templates more than once, and - apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + - A variable: - Use the `/api/v2/stacks` endpoints to manage installed template resources. + ```json + { "spec": { + "language": "flux", + "name": "Node_Service", + "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", + tag: \"service\")", + "type": "query" + } + } + ``` + type: object + type: object + type: array + TemplateApply: + properties: + actions: + description: | + A list of `action` objects. + Actions let you customize how InfluxDB applies templates in the request. - - name: Templates - - name: Usage - - description: | - Retrieve specific users. + You can use the following actions to prevent creating or updating resources: - InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. - To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); - you can't use the InfluxDB API to manage users in InfluxDB Cloud. - Once a user is added to your organization, you can use the - `GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to - view specific members. + - A `skipKind` action skips template resources of a specified `kind`. + - A `skipResource` action skips template resources with a specified `metadata.name` + and `kind`. + items: + oneOf: + - properties: + action: + enum: + - skipKind + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object + type: array + dryRun: + description: | + Only applies a dry run of the templates passed in the request. - ### User sessions with authorizations + - Validates the template and generates a resource diff and summary. + - Doesn't install templates or make changes to the InfluxDB instance. + type: boolean + envRefs: + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + description: | + An object with key-value pairs that map to **environment references** in templates. - Optionally, you can scope an authorization (and its API token) to a user. - If a user signs in with username and password, creating a _user session_, - 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). + Environment references in templates are `envRef` objects with an `envRef.key` + property. + To substitute a custom environment reference value when applying templates, + pass `envRefs` with the `envRef.key` and the value. - ### Related guides + When you apply a template, InfluxDB replaces `envRef` objects in the template + with the values that you provide in the `envRefs` parameter. - - [Manage users](/influxdb/cloud-serverless/organizations/users/) - name: Users - - name: Variables - - name: Views - - description: | - Write time series data to [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket) using InfluxDB v1 or v2 endpoints. - name: Write + The following template fields may use environment references: + + - `metadata.name` + - `spec.endpointName` + - `spec.associations.name` + + + type: object + orgID: + description: | + Organization ID. + InfluxDB applies templates to this organization. + The organization owns all resources created by the template. + + To find your organization, see how to + [view organizations](/influxdb/cloud-serverless/organizations/view-orgs/). + type: string + remotes: + description: | + A list of URLs for template files. + + To apply a template manifest file located at a URL, pass `remotes` + with an array that contains the URL. + items: + properties: + contentType: + type: string + url: + type: string + required: + - url + type: object + type: array + secrets: + additionalProperties: + type: string + description: | + An object with key-value pairs that map to **secrets** in queries. + + Queries may reference secrets stored in InfluxDB--for example, + the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` + secrets and then uses them to connect to a PostgreSQL database: + + ```js + import "sql" + import "influxdata/influxdb/secrets" + + username = secrets.get(key: "POSTGRES_USERNAME") + password = secrets.get(key: "POSTGRES_PASSWORD") + + sql.from( + driverName: "postgres", + dataSourceName: "postgresql://${username}:${password}@localhost:5432", + query: "SELECT * FROM example_table", + ) + ``` + + To define secret values in your `/api/v2/templates/apply` request, + pass the `secrets` parameter with key-value pairs--for example: + + ```json + { + ... + "secrets": { + "POSTGRES_USERNAME": "pguser", + "POSTGRES_PASSWORD": "foo" + } + ... + } + ``` + + InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. + Once stored, you can't view secret values in InfluxDB. + + + type: object + stackID: + description: | + ID of the stack to update. + + To apply templates to an existing stack in the organization, use the `stackID` parameter. + If you apply templates without providing a stack ID, + InfluxDB initializes a new stack with all new resources. + + To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. + + + type: string + template: + description: | + A template object to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Pass `template` to apply only one template object. + If you use `template`, you can't use the `templates` parameter. + If you want to apply multiple template objects, use `templates` instead. + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + templates: + description: | + A list of template objects to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Use the `templates` parameter to apply multiple template objects. + If you use `templates`, you can't use the `template` parameter. + items: + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + type: array + type: object + TemplateChart: + properties: + height: + type: integer + properties: + $ref: '#/components/schemas/ViewProperties' + width: + type: integer + xPos: + type: integer + yPos: + type: integer + type: object + TemplateEnvReferences: + items: + properties: + defaultValue: + description: Default value that will be provided for the reference when no value is provided + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + envRefKey: + description: Key identified as environment reference and is the key identified in the template + type: string + resourceField: + description: Field the environment reference corresponds too + type: string + value: + description: Value provided to fulfill reference + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + required: + - resourceField + - envRefKey + type: object + type: array + TemplateExportByID: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported + type: string + required: + - id + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateExportByName: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + required: + - name + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateKind: + enum: + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable + type: string + TemplateSummary: + properties: + diff: + properties: + buckets: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + old: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + checks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/CheckDiscriminator' + old: + $ref: '#/components/schemas/CheckDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + old: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + old: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationEndpoints: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + old: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + old: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + old: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/TelegrafRequest' + old: + $ref: '#/components/schemas/TelegrafRequest' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + old: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + errors: + items: + properties: + fields: + items: + type: string + type: array + indexes: + items: + type: integer + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + reason: + type: string + type: object + type: array + sources: + items: + type: string + type: array + stackID: + type: string + summary: + properties: + buckets: + items: + properties: + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + retentionPeriod: + type: integer + templateMetaName: + type: string + type: object + type: array + checks: + items: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + missingEnvRefs: + items: + type: string + type: array + missingSecrets: + items: + type: string + type: array + notificationEndpoints: + items: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + description: + type: string + endpointID: + type: string + endpointTemplateMetaName: + type: string + endpointType: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + cron: + type: string + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + type: object + TemplateSummaryLabel: + properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + orgID: + type: string + properties: + properties: + color: + type: string + description: + type: string + type: object + templateMetaName: + type: string + type: object + TestStatement: + description: Declares a Flux test case + properties: + assignment: + $ref: '#/components/schemas/VariableAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Threshold: + discriminator: + mapping: + greater: '#/components/schemas/GreaterThreshold' + lesser: '#/components/schemas/LesserThreshold' + range: '#/components/schemas/RangeThreshold' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' + ThresholdBase: + properties: + allValues: + description: If true, only alert if all values meet threshold. + type: boolean + level: + $ref: '#/components/schemas/CheckStatusLevel' + ThresholdCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + thresholds: + items: + $ref: '#/components/schemas/Threshold' + type: array + type: + enum: + - threshold + type: string + required: + - type + type: object + Token: + properties: + token: + type: string + type: object + UnaryExpression: + description: Uses operators to act on a single operand in an expression + properties: + argument: + $ref: '#/components/schemas/Expression' + operator: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + UnsignedIntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + User: + properties: + id: + readOnly: true + type: string + name: + type: string + org_id: + type: string + role: + enum: + - owner + - member + type: string + status: + default: active + description: If inactive the user is inactive. + enum: + - active + - inactive + type: string + required: + - name + UserResponse: + properties: + id: + description: | + The user ID. + readOnly: true + type: string + links: + example: + self: /api/v2/users/1 + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: | + The user name. + type: string + status: + default: active + description: | + The status of a user. + An inactive user can't read or write resources. + enum: + - active + - inactive + type: string + required: + - name + Users: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + type: object + Variable: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + createdAt: + format: date-time + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + properties: + labels: + format: uri + type: string + org: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + name: + type: string + orgID: + type: string + selected: + items: + type: string + type: array + sort_order: + type: integer + updatedAt: + format: date-time + type: string + required: + - name + - orgID + - arguments + type: object + VariableAssignment: + description: Represents the declaration of a variable + properties: + id: + $ref: '#/components/schemas/Identifier' + init: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + VariableProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariableProperties' + - $ref: '#/components/schemas/ConstantVariableProperties' + - $ref: '#/components/schemas/MapVariableProperties' + type: object + Variables: + example: + variables: + - arguments: + type: constant + values: + - howdy + - hello + - hi + - yo + - oy + id: '1221432' + name: ':ok:' + selected: + - hello + - arguments: + type: map + values: + a: fdjaklfdjkldsfjlkjdsa + b: dfaksjfkljekfajekdljfas + c: fdjksajfdkfeawfeea + id: '1221432' + name: ':ok:' + selected: + - c + - arguments: + language: flux + query: 'from(bucket: "foo") |> showMeasurements()' + type: query + id: '1221432' + name: ':ok:' + selected: + - host + properties: + variables: + items: + $ref: '#/components/schemas/Variable' + type: array + type: object + View: + properties: + id: + readOnly: true + type: string + links: + properties: + self: + type: string + readOnly: true + type: object + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + required: + - name + - properties + ViewProperties: + oneOf: + - $ref: '#/components/schemas/LinePlusSingleStatProperties' + - $ref: '#/components/schemas/XYViewProperties' + - $ref: '#/components/schemas/SingleStatViewProperties' + - $ref: '#/components/schemas/HistogramViewProperties' + - $ref: '#/components/schemas/GaugeViewProperties' + - $ref: '#/components/schemas/TableViewProperties' + - $ref: '#/components/schemas/SimpleTableViewProperties' + - $ref: '#/components/schemas/MarkdownViewProperties' + - $ref: '#/components/schemas/CheckViewProperties' + - $ref: '#/components/schemas/ScatterViewProperties' + - $ref: '#/components/schemas/HeatmapViewProperties' + - $ref: '#/components/schemas/MosaicViewProperties' + - $ref: '#/components/schemas/BandViewProperties' + - $ref: '#/components/schemas/GeoViewProperties' + Views: + properties: + links: + properties: + self: + type: string + type: object + views: + items: + $ref: '#/components/schemas/View' + type: array + type: object + WritePrecision: + enum: + - ms + - s + - us + - ns + type: string + XYGeom: + enum: + - line + - step + - stacked + - bar + - monotoneX + - stepBefore + - stepAfter + type: string + XYViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colorMapping: + $ref: '#/components/schemas/ColorMapping' + description: An object that contains information about the color mapping + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - xy + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position + type: object + securitySchemes: + BasicAuthentication: + description: | + ### Basic authentication scheme + + Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: + + ### Syntax + + `Authorization: Basic BASE64_ENCODED_CREDENTIALS` + + To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and + the password with a colon (`USERNAME:PASSWORD`), and then encode the + resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). + Many HTTP clients encode the credentials for you before sending the + request. + + _**Warning**: Base64-encoding can easily be reversed to obtain the original + username and password. It is used to keep the data intact and does not provide + security. You should always use HTTPS when authenticating or sending a request with + sensitive information._ + + ### Examples + + In the examples, replace the following: + + - **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with) + - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb/cloud-serverless/reference/glossary/#token) + - **`INFLUX_URL`**: your InfluxDB Cloud URL + + #### Encode credentials with cURL + + The following example shows how to use cURL to send an API request that uses Basic authentication. + With the `--user` option, cURL encodes the credentials and passes them + in the `Authorization: Basic` header. + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --user "EMAIL_ADDRESS":"PASSWORD" + ``` + + #### Encode credentials with Flux + + The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded + basic authentication header using a specified username and password combination. + + #### Encode credentials with JavaScript + + The following example shows how to use the JavaScript `btoa()` function + to create a Base64-encoded string: + + ```js + btoa('EMAIL_ADDRESS:PASSWORD') + ``` + + The output is the following: + + ```js + 'VVNFUk5BTUU6UEFTU1dPUkQ=' + ``` + + Once you have the Base64-encoded credentials, you can pass them in the + `Authorization` header--for example: + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" + ``` + + To learn more about HTTP authentication, see + [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ + scheme: basic + type: http + TokenAuthentication: + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + ### Syntax + + `Authorization: Token INFLUX_API_TOKEN` + + ### Example + + #### Use Token authentication with cURL + + The following example shows how to use cURL to send an API request that uses Token authentication: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + Replace the following: + + - *`INFLUX_URL`*: your InfluxDB Cloud URL + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud-serverless/reference/glossary/#token) + + ### Related endpoints + + - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) + in: header + name: Authorization + type: apiKey x-tagGroups: - name: Using the InfluxDB HTTP API tags: diff --git a/api-docs/cloud/.config.yml b/api-docs/cloud/.config.yml new file mode 100644 index 000000000..46849d74f --- /dev/null +++ b/api-docs/cloud/.config.yml @@ -0,0 +1,13 @@ +plugins: + - '../openapi/plugins/docs-plugin.js' +extends: + - recommended + - docs/all +x-influxdata-product-name: InfluxDB v2 Cloud + +apis: + v2@2: + root: v2/ref.yml + x-influxdata-default: true + v1-compatibility@2: + root: v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/cloud/content/info.yml b/api-docs/cloud/content/info.yml deleted file mode 100644 index 1ad053feb..000000000 --- a/api-docs/cloud/content/info.yml +++ /dev/null @@ -1,11 +0,0 @@ -title: InfluxDB Cloud API Service -description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. - Access the InfluxDB API using the `/api/v2/` endpoint. - - This documentation is generated from the - [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). -version: Cloud 2.x -license: - name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file diff --git a/api-docs/cloud/v1-compatibility/content/info.yml b/api-docs/cloud/v1-compatibility/content/info.yml new file mode 100644 index 000000000..a74f1ce5f --- /dev/null +++ b/api-docs/cloud/v1-compatibility/content/info.yml @@ -0,0 +1,10 @@ +title: InfluxDB v1 HTTP API for InfluxDB Cloud +summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints. +description: | + The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud/swaggerV1Compat.yml b/api-docs/cloud/v1-compatibility/swaggerV1Compat.yml similarity index 98% rename from api-docs/cloud/swaggerV1Compat.yml rename to api-docs/cloud/v1-compatibility/swaggerV1Compat.yml index edda47f3d..4f61b3946 100644 --- a/api-docs/cloud/swaggerV1Compat.yml +++ b/api-docs/cloud/v1-compatibility/swaggerV1Compat.yml @@ -1,19 +1,38 @@ openapi: 3.0.0 info: - title: InfluxDB Cloud v1 compatibility API documentation - version: 0.1.0 + title: InfluxDB v1 HTTP API for InfluxDB Cloud + version: '' description: | The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. - If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud/api/). - This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). license: name: MIT url: https://opensource.org/licenses/MIT + summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints. servers: - url: / +security: + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + The InfluxDB 1.x API requires authentication for all requests. + InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. + + + For more information, see the following: + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + + x-traitTag: true + - name: Query + - name: Write paths: /write: post: @@ -409,23 +428,3 @@ components: For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). -security: - - TokenAuthentication: [] - - BasicAuthentication: [] - - QuerystringAuthentication: [] -tags: - - name: Authentication - description: | - The InfluxDB 1.x API requires authentication for all requests. - InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. - - - For more information, see the following: - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - - x-traitTag: true - - name: Query - - name: Write diff --git a/api-docs/cloud/v2/content/info.yml b/api-docs/cloud/v2/content/info.yml new file mode 100644 index 000000000..1e7aa0467 --- /dev/null +++ b/api-docs/cloud/v2/content/info.yml @@ -0,0 +1,11 @@ +title: InfluxDB Cloud API Service +summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. +description: | + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). +version: 2.x +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/cloud/content/servers.yml b/api-docs/cloud/v2/content/servers.yml similarity index 100% rename from api-docs/cloud/content/servers.yml rename to api-docs/cloud/v2/content/servers.yml diff --git a/api-docs/cloud/content/tag-groups.yml b/api-docs/cloud/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud/content/tag-groups.yml rename to api-docs/cloud/v2/content/tag-groups.yml diff --git a/api-docs/cloud/ref.yml b/api-docs/cloud/v2/ref.yml similarity index 99% rename from api-docs/cloud/ref.yml rename to api-docs/cloud/v2/ref.yml index 2e21a1d2a..2cee4fcb2 100644 --- a/api-docs/cloud/ref.yml +++ b/api-docs/cloud/v2/ref.yml @@ -1,6740 +1,328 @@ -components: - examples: - AuthorizationPostRequest: - description: Creates an authorization. - summary: An authorization for a resource type - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - type: buckets - AuthorizationWithResourcePostRequest: - description: Creates an authorization for access to a specific resource. - summary: An authorization for a resource - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - id: INFLUX_BUCKET_ID - type: buckets - AuthorizationWithUserPostRequest: - description: Creates an authorization scoped to a specific user. - summary: An authorization scoped to a user - value: - description: iot_user write to bucket - orgID: INFLUX_ORG_ID - permissions: - - action: write - resource: - id: INFLUX_BUCKET_ID - type: buckets - userID: INFLUX_USER_ID - TaskWithFluxRequest: - description: Sets the `flux` property with Flux task options and a query. - summary: A task with Flux - value: - description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. - flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" - status: active - TaskWithScriptRequest: - description: | - Sets properties for a task that runs an _invokable script_. - summary: A task with an invokable script - value: - description: This task runs an invokable script every hour with the defined parameters. - every: 1h - name: CPU Total 1 Hour New - scriptID: SCRIPT_ID - scriptParameters: - bucket: telegraf - filterField: cpu-total - rangeStart: '-1h' - status: active - parameters: - After: - description: | - A resource ID to seek from. - Returns records created after the specified record; - results don't include the specified record. - - Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](/influxdb/cloud/api/#tag/Pagination). - in: query - name: after - required: false - schema: - type: string - Descending: - in: query - name: descending - required: false - schema: - default: false - type: boolean - Limit: - description: | - Limits the number of records returned. Default is `20`. - in: query - name: limit - required: false - schema: - default: 20 - maximum: 100 - minimum: 1 - type: integer - Offset: - description: | - The offset for pagination. - The number of records to skip. - - For more information about pagination parameters, see [Pagination](/influxdb/cloud/api/#tag/Pagination). - in: query - name: offset - required: false - schema: - minimum: 0 - type: integer - SortBy: - in: query - name: sortBy - required: false - schema: - type: string - TraceSpan: - description: OpenTracing span context - example: - baggage: - key: value - span_id: '1' - trace_id: '1' - in: header - name: Zap-Trace-Span - required: false - schema: - type: string - responses: - AuthorizationError: - content: - application/json: - examples: - tokenNotAuthorized: - summary: Token is not authorized to access a resource - value: - code: unauthorized - message: unauthorized access - schema: - properties: - code: - description: | - The HTTP status code description. Default is `unauthorized`. - enum: - - unauthorized - readOnly: true - type: string - message: - description: A human-readable message that may contain detail about the error. - readOnly: true - type: string - description: | - Unauthorized. The error may indicate one of the following: - - * The `Authorization: Token` header is missing or malformed. - * The API token value is missing from the header. - * The token doesn't have sufficient permissions to write to this organization and bucket. - BadRequestError: - content: - application/json: - examples: - orgProvidedNotFound: - summary: The org or orgID passed doesn't own the token passed in the header - value: - code: invalid - message: 'failed to decode request body: organization not found' - schema: - $ref: '#/components/schemas/Error' - description: | - Bad request. - The response body contains detail about the error. - - #### InfluxDB OSS - - - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. - GeneralServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - InternalServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: | - Internal server error. - The server encountered an unexpected situation. - ResourceNotFoundError: - content: - application/json: - examples: - bucket-not-found: - summary: Bucket name not found - value: - code: not found - message: bucket "air_sensor" not found - org-not-found: - summary: Organization name not found - value: - code: not found - message: organization name "my-org" not found - orgID-not-found: - summary: Organization ID not found - value: - code: not found - message: organization not found - schema: - $ref: '#/components/schemas/Error' - description: | - Not found. - A requested resource was not found. - The response body contains the requested resource type and the name value - (if you passed it)--for example: - - - `"organization name \"my-org\" not found"` - - `"organization not found"`: indicates you passed an ID that did not match - an organization. - ServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - schemas: - ASTResponse: - description: Contains the AST for the supplied Flux query - properties: - ast: - $ref: '#/components/schemas/Package' - type: object - AddResourceMemberRequestBody: - properties: - id: - description: | - The ID of the user to add to the resource. - type: string - name: - description: | - The name of the user to add to the resource. - type: string - required: - - id - type: object - AnalyzeQueryResponse: - properties: - errors: - items: - properties: - character: - type: integer - column: - type: integer - line: - type: integer - message: - type: string - type: object - type: array - type: object - ArrayExpression: - description: Used to create and directly specify the elements of an array object - properties: - elements: - description: Elements of the array - items: - $ref: '#/components/schemas/Expression' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - Authorization: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - createdAt: - format: date-time - readOnly: true - type: string - id: - description: The authorization ID. - readOnly: true - type: string - links: - example: - self: /api/v2/authorizations/1 - user: /api/v2/users/12 - properties: - self: - $ref: '#/components/schemas/Link' - readOnly: true - user: - $ref: '#/components/schemas/Link' - readOnly: true - readOnly: true - type: object - org: - description: | - The organization name. - Specifies the [organization](/influxdb/cloud/reference/glossary/#organization) - that the token is scoped to. - readOnly: true - type: string - orgID: - description: | - The organization ID. - Specifies the [organization](/influxdb/cloud/reference/glossary/#organization) that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions. - An authorization must have at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: | - The API token. - The token value is unique to the authorization. - [API tokens](/influxdb/cloud/reference/glossary/#token) are - used to authenticate and authorize InfluxDB API requests and `influx` - CLI commands--after receiving the request, InfluxDB checks that the - token is valid and that the `permissions` allow the requested action(s). - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: | - The user name. - Specifies the [user](/influxdb/cloud/reference/glossary/#user) that owns the authorization. - If the authorization is _scoped_ to a user, the user; - otherwise, the creator of the authorization. - readOnly: true - type: string - userID: - description: The user ID. Specifies the [user](/influxdb/cloud/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. - readOnly: true - type: string - type: object - required: - - orgID - - permissions - AuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: | - An organization ID. - Specifies the organization that owns the authorization. - type: string - permissions: - description: | - A list of permissions for an authorization. - In the list, provide at least one `permission` object. - - In a `permission`, the `resource.type` property grants access to all - resources of the specified type. - To grant access to only a specific resource, specify the - `resource.id` property. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - userID: - description: | - A user ID. - Specifies the user that the authorization is scoped to. - - When a user authenticates with username and password, - InfluxDB generates a _user session_ with all the permissions - specified by all the user's authorizations. - type: string - type: object - required: - - orgID - - permissions - AuthorizationUpdateRequest: - properties: - description: - description: A description of the token. - type: string - status: - default: active - description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. - enum: - - active - - inactive - type: string - Authorizations: - properties: - authorizations: - items: - $ref: '#/components/schemas/Authorization' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - Axes: - description: The viewport for a View's visualizations - properties: - x: - $ref: '#/components/schemas/Axis' - 'y': - $ref: '#/components/schemas/Axis' - required: - - x - - 'y' - type: object - Axis: - description: Axis used in a visualization. - properties: - base: - description: Radix for formatting axis values. - enum: - - '' - - '2' - - '10' - type: string - bounds: - description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. - items: - type: string - maxItems: 2 - minItems: 0 - type: array - label: - description: Description of the axis. - type: string - prefix: - description: Label prefix for formatting axis values. - type: string - scale: - $ref: '#/components/schemas/AxisScale' - suffix: - description: Label suffix for formatting axis values. - type: string - type: object - AxisScale: - description: 'Scale is the axis formatting scale. Supported: "log", "linear"' - enum: - - log - - linear - type: string - BadStatement: - description: A placeholder for statements for which no correct statement nodes can be created - properties: - text: - description: Raw source text - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - BandViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - lowerColumn: - type: string - mainColumn: - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - band - type: string - upperColumn: - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - type: object - BinaryExpression: - description: uses binary operators to act on two operands in an expression - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Block: - description: A set of statements - properties: - body: - description: Block body - items: - $ref: '#/components/schemas/Statement' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - BooleanLiteral: - description: Represents boolean values - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: boolean - type: object - Bucket: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/buckets/1/labels - members: /api/v2/buckets/1/members - org: /api/v2/orgs/2 - owners: /api/v2/buckets/1/owners - self: /api/v2/buckets/1 - write: /api/v2/write?org=2&bucket=1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this bucket. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members that can read this bucket. - org: - $ref: '#/components/schemas/Link' - description: The URL to retrieve parent organization for this bucket. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners that can read and write to this bucket. - self: - $ref: '#/components/schemas/Link' - description: The URL for this bucket. - write: - $ref: '#/components/schemas/Link' - description: The URL to write line protocol to this bucket. - readOnly: true - type: object - name: - type: string - orgID: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - type: - default: user - enum: - - user - - system - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - retentionRules - Buckets: - properties: - buckets: - items: - $ref: '#/components/schemas/Bucket' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - BuilderAggregateFunctionType: - enum: - - filter - - group - type: string - BuilderConfig: - properties: - aggregateWindow: - properties: - fillValues: - type: boolean - period: - type: string - type: object - buckets: - items: - type: string - type: array - functions: - items: - $ref: '#/components/schemas/BuilderFunctionsType' - type: array - tags: - items: - $ref: '#/components/schemas/BuilderTagsType' - type: array - type: object - BuilderFunctionsType: - properties: - name: - type: string - type: object - BuilderTagsType: - properties: - aggregateFunctionType: - $ref: '#/components/schemas/BuilderAggregateFunctionType' - key: - type: string - values: - items: - type: string - type: array - type: object - BuiltinStatement: - description: Declares a builtin identifier and its type - properties: - id: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - CallExpression: - description: Represents a function call - properties: - arguments: - description: Function arguments - items: - $ref: '#/components/schemas/Expression' - type: array - callee: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Cell: - properties: - h: - format: int32 - type: integer - id: - type: string - links: - properties: - self: - type: string - view: - type: string - type: object - viewID: - description: The reference to a view from the views API. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellUpdate: - properties: - h: - format: int32 - type: integer - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellWithViewProperties: - allOf: - - $ref: '#/components/schemas/Cell' - - properties: - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - type: object - type: object - Cells: - items: - $ref: '#/components/schemas/Cell' - type: array - CellsWithViewProperties: - items: - $ref: '#/components/schemas/CellWithViewProperties' - type: array - Check: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - CheckBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the check. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/checks/1/labels - members: /api/v2/checks/1/members - owners: /api/v2/checks/1/owners - query: /api/v2/checks/1/query - self: /api/v2/checks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this check. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this check. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this check. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this check. - self: - $ref: '#/components/schemas/Link' - description: The URL for this check. - readOnly: true - type: object - name: - type: string - orgID: - description: The ID of the organization that owns this check. - type: string - ownerID: - description: The ID of creator used to create this check. - readOnly: true - type: string - query: - $ref: '#/components/schemas/DashboardQuery' - status: - $ref: '#/components/schemas/TaskStatusType' - taskID: - description: The ID of the task associated with this check. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - orgID - - query - CheckDiscriminator: - discriminator: - mapping: - custom: '#/components/schemas/CustomCheck' - deadman: '#/components/schemas/DeadmanCheck' - threshold: '#/components/schemas/ThresholdCheck' - propertyName: type - oneOf: - - $ref: '#/components/schemas/DeadmanCheck' - - $ref: '#/components/schemas/ThresholdCheck' - - $ref: '#/components/schemas/CustomCheck' - CheckPatch: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - CheckStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - type: string - CheckViewProperties: - properties: - adaptiveZoomHide: - type: boolean - check: - $ref: '#/components/schemas/Check' - checkID: - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - check - type: string - required: - - type - - shape - - checkID - - queries - - colors - type: object - Checks: - properties: - checks: - items: - $ref: '#/components/schemas/Check' - type: array - links: - $ref: '#/components/schemas/Links' - ColorMapping: - additionalProperties: - type: string - description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. - example: - configcat_deployments-autopromotionblocker: '#663cd0' - measurement_birdmigration_europe: '#663cd0' - series_id_1: '#edf529' - series_id_2: '#edf529' - type: object - ColumnDataType: - enum: - - integer - - float - - boolean - - string - - unsigned - type: string - ColumnSemanticType: - enum: - - timestamp - - tag - - field - nullable: false - type: string - ConditionalExpression: - description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` - properties: - alternate: - $ref: '#/components/schemas/Expression' - consequent: - $ref: '#/components/schemas/Expression' - test: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - ConstantVariableProperties: - properties: - type: - enum: - - constant - type: string - values: - items: - type: string - type: array - CreateCell: - properties: - h: - format: int32 - type: integer - name: - type: string - usingView: - description: Makes a copy of the provided view. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CreateDashboardRequest: - properties: - description: - description: The user-facing description of the dashboard. - type: string - name: - description: The user-facing name of the dashboard. - type: string - orgID: - description: The ID of the organization that owns the dashboard. - type: string - required: - - orgID - - name - CustomCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - type: - enum: - - custom - type: string - required: - - type - type: object - DBRP: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - If set to `true`, this DBRP mapping is the default retention policy - for the database (specified by the `database` property's value). - type: boolean - id: - description: | - The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. - readOnly: true - type: string - links: - $ref: '#/components/schemas/Links' - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - virtual: - description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. - type: boolean - required: - - id - - orgID - - bucketID - - database - - retention_policy - - default - type: object - DBRPCreate: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - type: boolean - org: - description: | - An organization name. - Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. - type: string - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - required: - - bucketID - - database - - retention_policy - type: object - DBRPGet: - properties: - content: - $ref: '#/components/schemas/DBRP' - required: true - type: object - DBRPUpdate: - properties: - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - To remove the default mapping, set to `false`. - type: boolean - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - DBRPs: - properties: - content: - items: - $ref: '#/components/schemas/DBRP' - type: array - Dashboard: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/Cells' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - DashboardColor: - description: Defines an encoding of data value into color space. - properties: - hex: - description: The hex number of the color - maxLength: 7 - minLength: 7 - type: string - id: - description: The unique ID of the view color. - type: string - name: - description: The user-facing name of the hex color. - type: string - type: - description: Type is how the color is used. - enum: - - min - - max - - threshold - - scale - - text - - background - type: string - value: - description: The data value mapped to this color. - format: float - type: number - required: - - id - - type - - hex - - name - - value - type: object - DashboardQuery: - properties: - builderConfig: - $ref: '#/components/schemas/BuilderConfig' - editMode: - $ref: '#/components/schemas/QueryEditMode' - name: - type: string - text: - description: The text of the Flux query. - type: string - type: object - DashboardWithViewProperties: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/CellsWithViewProperties' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - Dashboards: - properties: - dashboards: - items: - $ref: '#/components/schemas/Dashboard' - type: array - links: - $ref: '#/components/schemas/Links' - type: object - DateTimeLiteral: - description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp). - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - format: date-time - type: string - type: object - DeadmanCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - level: - $ref: '#/components/schemas/CheckStatusLevel' - offset: - description: Duration to delay after the schedule, before executing check. - type: string - reportZero: - description: If only zero values reported since time, trigger an alert - type: boolean - staleTime: - description: String duration for time that a series is considered stale and should not trigger deadman. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - timeSince: - description: String duration before deadman triggers. - type: string - type: - enum: - - deadman - type: string - required: - - type - type: object - DecimalPlaces: - description: Indicates whether decimal places should be enforced, and how many digits it should show. - properties: - digits: - description: The number of digits after decimal to display - format: int32 - type: integer - isEnforced: - description: Indicates whether decimal point setting should be enforced - type: boolean - type: object - DeletePredicateRequest: - description: The delete predicate request. - properties: - predicate: - description: | - An expression in [delete predicate syntax](/influxdb/cloud/reference/syntax/delete-predicate/). - example: tag1="value1" and (tag2="value2" and tag3!="value3") - type: string - start: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)). - The earliest time to delete from. - format: date-time - type: string - stop: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)). - The latest time to delete from. - format: date-time - type: string - required: - - start - - stop - type: object - Dialect: - description: | - Options for tabular data output. - Default output is [annotated CSV](/influxdb/cloud/reference/syntax/annotated-csv/#csv-response-format) with headers. - - For more information about tabular data **dialect**, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). - properties: - annotations: - description: | - Annotation rows to include in the results. - An _annotation_ is metadata associated with an object (column) in the data model. - - #### Related guides - - - See [Annotated CSV annotations](/influxdb/cloud/reference/syntax/annotated-csv/#annotations) for examples and more information. - - For more information about **annotations** in tabular data, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). - items: - enum: - - group - - datatype - - default - type: string - type: array - uniqueItems: true - commentPrefix: - default: '#' - description: The character prefixed to comment strings. Default is a number sign (`#`). - maxLength: 1 - minLength: 0 - type: string - dateTimeFormat: - default: RFC3339 - description: | - The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp). - To include nanoseconds in timestamps, use `RFC3339Nano`. - - #### Example formatted date/time values - - | Format | Value | - |:------------|:----------------------------| - | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | - | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | - enum: - - RFC3339 - - RFC3339Nano - type: string - delimiter: - default: ',' - description: The separator used between cells. Default is a comma (`,`). - maxLength: 1 - minLength: 1 - type: string - header: - default: true - description: If true, the results contain a header row. - type: boolean - type: object - DictExpression: - description: Used to create and directly specify the elements of a dictionary - properties: - elements: - description: Elements of the dictionary - items: - $ref: '#/components/schemas/DictItem' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - DictItem: - description: A key-value pair in a dictionary. - properties: - key: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - val: - $ref: '#/components/schemas/Expression' - type: object - Duration: - description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. - properties: - magnitude: - type: integer - type: - $ref: '#/components/schemas/NodeType' - unit: - type: string - type: object - DurationLiteral: - description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration - properties: - type: - $ref: '#/components/schemas/NodeType' - values: - description: Duration values - items: - $ref: '#/components/schemas/Duration' - type: array - type: object - Error: - properties: - code: - $ref: '#/components/schemas/ErrorCode' - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - ErrorCode: - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - Expression: - oneOf: - - $ref: '#/components/schemas/ArrayExpression' - - $ref: '#/components/schemas/DictExpression' - - $ref: '#/components/schemas/FunctionExpression' - - $ref: '#/components/schemas/BinaryExpression' - - $ref: '#/components/schemas/CallExpression' - - $ref: '#/components/schemas/ConditionalExpression' - - $ref: '#/components/schemas/LogicalExpression' - - $ref: '#/components/schemas/MemberExpression' - - $ref: '#/components/schemas/IndexExpression' - - $ref: '#/components/schemas/ObjectExpression' - - $ref: '#/components/schemas/ParenExpression' - - $ref: '#/components/schemas/PipeExpression' - - $ref: '#/components/schemas/UnaryExpression' - - $ref: '#/components/schemas/BooleanLiteral' - - $ref: '#/components/schemas/DateTimeLiteral' - - $ref: '#/components/schemas/DurationLiteral' - - $ref: '#/components/schemas/FloatLiteral' - - $ref: '#/components/schemas/IntegerLiteral' - - $ref: '#/components/schemas/PipeLiteral' - - $ref: '#/components/schemas/RegexpLiteral' - - $ref: '#/components/schemas/StringLiteral' - - $ref: '#/components/schemas/UnsignedIntegerLiteral' - - $ref: '#/components/schemas/Identifier' - ExpressionStatement: - description: May consist of an expression that doesn't return a value and is executed solely for its side-effects - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Field: - properties: - alias: - description: Alias overrides the field name in the returned response. Applies only if type is `func` - type: string - args: - description: Args are the arguments to the function - items: - $ref: '#/components/schemas/Field' - type: array - type: - description: '`type` describes the field type. `func` is a function. `field` is a field reference.' - enum: - - func - - field - - integer - - number - - regex - - wildcard - type: string - value: - description: value is the value of the field. Meaning of the value is implied by the `type` key - type: string - type: object - File: - description: Represents a source from a single file - properties: - body: - description: List of Flux statements - items: - $ref: '#/components/schemas/Statement' - type: array - imports: - description: A list of package imports - items: - $ref: '#/components/schemas/ImportDeclaration' - type: array - name: - description: The name of the file. - type: string - package: - $ref: '#/components/schemas/PackageClause' - type: - $ref: '#/components/schemas/NodeType' - type: object - Flags: - additionalProperties: true - type: object - FloatLiteral: - description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: number - type: object - FluxResponse: - description: Rendered flux that backs the check or notification. - properties: - flux: - type: string - FluxSuggestion: - properties: - name: - type: string - params: - additionalProperties: - type: string - type: object - type: object - FluxSuggestions: - properties: - funcs: - items: - $ref: '#/components/schemas/FluxSuggestion' - type: array - type: object - FunctionExpression: - description: Function expression - properties: - body: - $ref: '#/components/schemas/Node' - params: - description: Function parameters - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - GaugeViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - gauge - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - GeoCircleViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Circle color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - interpolateColors: - description: Interpolate circle color based on displayed value - type: boolean - radius: - description: Maximum radius size in pixels - type: integer - radiusDimension: - $ref: '#/components/schemas/Axis' - radiusField: - description: Radius field - type: string - required: - - radiusField - - radiusDimension - - colorField - - colorDimension - - colors - type: object - GeoHeatMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - blur: - description: Blur for heatmap points - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - intensityDimension: - $ref: '#/components/schemas/Axis' - intensityField: - description: Intensity field - type: string - radius: - description: Radius size in pixels - type: integer - required: - - intensityField - - intensityDimension - - radius - - blur - - colors - type: object - GeoPointMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Marker color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - isClustered: - description: Cluster close markers together - type: boolean - tooltipColumns: - description: An array for which columns to display in tooltip - items: - type: string - type: array - required: - - colorField - - colorDimension - - colors - type: object - GeoTrackMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - required: - - trackWidth - - speed - - randomColors - - trackPointVisualization - type: object - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - randomColors: - description: Assign different colors to different tracks - type: boolean - speed: - description: Speed of the track animation - type: integer - trackWidth: - description: Width of the track - type: integer - GeoViewLayer: - oneOf: - - $ref: '#/components/schemas/GeoCircleViewLayer' - - $ref: '#/components/schemas/GeoHeatMapViewLayer' - - $ref: '#/components/schemas/GeoPointMapViewLayer' - - $ref: '#/components/schemas/GeoTrackMapViewLayer' - type: object - GeoViewLayerProperties: - properties: - type: - enum: - - heatmap - - circleMap - - pointMap - - trackMap - type: string - required: - - type - type: object - GeoViewProperties: - properties: - allowPanAndZoom: - default: true - description: If true, map zoom and pan controls are enabled on the dashboard view - type: boolean - center: - description: Coordinates of the center of the map - properties: - lat: - description: Latitude of the center of the map - format: double - type: number - lon: - description: Longitude of the center of the map - format: double - type: number - required: - - lat - - lon - type: object - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - detectCoordinateFields: - default: true - description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns - type: boolean - latLonColumns: - $ref: '#/components/schemas/LatLonColumns' - layers: - description: List of individual layers shown in the map - items: - $ref: '#/components/schemas/GeoViewLayer' - type: array - mapStyle: - description: Define map type - regular, satellite etc. - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - s2Column: - description: String to define the column - type: string - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - geo - type: string - useS2CellID: - description: If true, S2 column is used to calculate lat/lon - type: boolean - zoom: - description: Zoom level used for initial display of the map - format: double - maximum: 28 - minimum: 1 - type: number - required: - - type - - shape - - queries - - note - - showNoteWhenEmpty - - center - - zoom - - allowPanAndZoom - - detectCoordinateFields - - layers - type: object - GreaterThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - greater - type: string - value: - format: float - type: number - required: - - type - - value - type: object - HTTPNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - authMethod: - enum: - - none - - basic - - bearer - type: string - contentTemplate: - type: string - headers: - additionalProperties: - type: string - description: Customized headers. - type: object - method: - enum: - - POST - - GET - - PUT - type: string - password: - type: string - token: - type: string - url: - type: string - username: - type: string - required: - - url - - authMethod - - method - type: object - type: object - HTTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/HTTPNotificationRuleBase' - HTTPNotificationRuleBase: - properties: - type: - enum: - - http - type: string - url: - type: string - required: - - type - type: object - HealthCheck: - properties: - checks: - items: - $ref: '#/components/schemas/HealthCheck' - type: array - commit: - type: string - message: - type: string - name: - type: string - status: - enum: - - pass - - fail - type: string - version: - type: string - required: - - name - - status - type: object - HeatmapViewProperties: - properties: - adaptiveZoomHide: - type: boolean - binSize: - type: number - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - heatmap - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - - binSize - type: object - HistogramViewProperties: - properties: - binCount: - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - fillColumns: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - histogram - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - format: float - type: number - type: array - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - fillColumns - - xDomain - - xAxisLabel - - position - - binCount - type: object - Identifier: - description: A valid Flux identifier - properties: - name: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - ImportDeclaration: - description: Declares a package import - properties: - as: - $ref: '#/components/schemas/Identifier' - path: - $ref: '#/components/schemas/StringLiteral' - type: - $ref: '#/components/schemas/NodeType' - type: object - IndexExpression: - description: Represents indexing into an array - properties: - array: - $ref: '#/components/schemas/Expression' - index: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - InfluxqlCsvResponse: - description: CSV Response to InfluxQL Query - example: | - name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value - type: string - InfluxqlJsonResponse: - description: JSON Response to InfluxQL Query - properties: - results: - items: - properties: - error: - type: string - series: - items: - properties: - columns: - items: - type: string - type: array - name: - type: string - partial: - type: boolean - tags: - additionalProperties: - type: string - type: object - values: - items: - items: {} - type: array - type: array - type: object - type: array - statement_id: - type: integer - type: object - type: array - type: object - IntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - IsOnboarding: - properties: - allowed: - description: | - If `true`, the InfluxDB instance hasn't had initial setup; - `false` otherwise. - type: boolean - type: object - Label: - properties: - id: - readOnly: true - type: string - name: - type: string - orgID: - readOnly: true - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - type: object - LabelCreateRequest: - properties: - name: - type: string - orgID: - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - required: - - orgID - - name - type: object - LabelMapping: - description: A _label mapping_ contains a `label` ID to attach to a resource. - properties: - labelID: - description: | - A label ID. - Specifies the label to attach. - type: string - required: - - labelID - type: object - LabelResponse: - properties: - label: - $ref: '#/components/schemas/Label' - links: - $ref: '#/components/schemas/Links' - type: object - LabelUpdate: - properties: - name: - type: string - properties: - additionalProperties: - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - type: string - example: - color: ffb3b3 - description: this is a description - type: object - type: object - Labels: - items: - $ref: '#/components/schemas/Label' - type: array - LabelsResponse: - properties: - labels: - $ref: '#/components/schemas/Labels' - links: - $ref: '#/components/schemas/Links' - type: object - LanguageRequest: - description: Flux query to be analyzed. - properties: - query: - description: | - The Flux query script to be analyzed. - type: string - required: - - query - type: object - LatLonColumn: - description: Object type for key and column definitions - properties: - column: - description: Column to look up Lat/Lon - type: string - key: - description: Key to determine whether the column is tag/field - type: string - required: - - key - - column - type: object - LatLonColumns: - description: Object type to define lat/lon columns - properties: - lat: - $ref: '#/components/schemas/LatLonColumn' - lon: - $ref: '#/components/schemas/LatLonColumn' - required: - - lat - - lon - type: object - LegacyAuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: The organization ID. Identifies the organization that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions that provide `read` and `write` access to organization resources. - An authorization must contain at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: The name that you provide for the authorization. - type: string - userID: - description: The user ID. Identifies the user that the authorization is scoped to. - type: string - type: object - required: - - orgID - - permissions - LesserThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - lesser - type: string - value: - format: float - type: number - required: - - type - - value - type: object - Limit: - description: These are org limits similar to those configured in/by quartz. - properties: - bucket: - properties: - maxBuckets: - type: integer - maxRetentionDuration: - description: Max bucket retention duration in nanoseconds. 0 is unlimited. - type: integer - required: - - maxBuckets - - maxRetentionDuration - type: object - check: - properties: - maxChecks: - type: integer - required: - - maxChecks - type: object - dashboard: - properties: - maxDashboards: - type: integer - required: - - maxDashboards - type: object - features: - properties: - allowDelete: - description: allow delete predicate endpoint - type: boolean - type: object - notificationEndpoint: - properties: - blockedNotificationEndpoints: - description: comma separated list of notification endpoints - example: http,pagerduty - type: string - required: - - blockNotificationEndpoints - type: object - notificationRule: - properties: - blockedNotificationRules: - description: comma separated list of notification rules - example: http,pagerduty - type: string - maxNotifications: - type: integer - required: - - maxNotifications - - blockNotificationRules - type: object - orgID: - type: string - rate: - properties: - cardinality: - description: Allowed organization total cardinality. 0 is unlimited. - type: integer - concurrentDeleteRequests: - description: Allowed organization concurrent outstanding delete requests. - type: integer - concurrentReadRequests: - description: Allowed concurrent queries. 0 is unlimited. - type: integer - concurrentWriteRequests: - description: Allowed concurrent writes. 0 is unlimited. - type: integer - deleteRequestsPerSecond: - description: Allowed organization delete request rate. - type: integer - queryTime: - description: Query Time in nanoseconds - type: integer - readKBs: - description: Query limit in kb/sec. 0 is unlimited. - type: integer - writeKBs: - description: Write limit in kb/sec. 0 is unlimited. - type: integer - required: - - readKBs - - queryTime - - concurrentReadRequests - - writeKBs - - concurrentWriteRequests - - cardinality - type: object - stack: - properties: - enabled: - type: boolean - required: - - enabled - type: object - task: - properties: - maxTasks: - type: integer - required: - - maxTasks - type: object - timeout: - properties: - queryUnconditionalTimeoutSeconds: - type: integer - queryidleWriteTimeoutSeconds: - type: integer - required: - - queryUnconditionalTimeoutSeconds - - queryidleWriteTimeoutSeconds - type: object - required: - - rate - - bucket - - task - - dashboard - - check - - notificationRule - - notificationEndpoint - type: object - LinePlusSingleStatProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - timeFormat: - type: string - type: - enum: - - line-plus-single-stat - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - prefix - - suffix - - decimalPlaces - - position - type: object - LineProtocolError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - internal error - - not found - - conflict - - invalid - - empty value - - unavailable - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - line: - description: First line in the request body that contains malformed data. - format: int32 - readOnly: true - type: integer - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - LineProtocolLengthError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - invalid - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - required: - - code - - message - Link: - description: URI of resource. - format: uri - readOnly: true - type: string - Links: - description: | - URI pointers for additional paged results. - properties: - next: - $ref: '#/components/schemas/Link' - prev: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - required: - - self - type: object - LogEvent: - properties: - message: - description: A description of the event that occurred. - example: Halt and catch fire - readOnly: true - type: string - runID: - description: The ID of the task run that generated the event. - readOnly: true - type: string - time: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - type: object - LogicalExpression: - description: Represents the rule conditions that collectively evaluate to either true or false - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Logs: - properties: - events: - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - type: object - MapVariableProperties: - properties: - type: - enum: - - map - type: string - values: - additionalProperties: - type: string - type: object - MarkdownViewProperties: - properties: - note: - type: string - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - markdown - type: string - required: - - type - - shape - - note - type: object - MeasurementSchema: - description: Definition of a measurement schema. - example: - bucketID: ba3c5e7f9b0a0010 - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8642 - name: cpu - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - properties: - bucketID: - description: The ID of the bucket that the measurement schema is associated with. - type: string - columns: - description: Ordered collection of column definitions. - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - createdAt: - format: date-time - readOnly: true - type: string - id: - readOnly: true - type: string - name: - nullable: false - type: string - orgID: - description: The ID of the organization. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - id - - name - - columns - - createdAt - - updatedAt - type: object - MeasurementSchemaColumn: - description: Definition of a measurement schema column. - example: - format: unix timestamp - name: time - type: integer - properties: - dataType: - $ref: '#/components/schemas/ColumnDataType' - name: - type: string - type: - $ref: '#/components/schemas/ColumnSemanticType' - required: - - name - - type - type: object - MeasurementSchemaCreateRequest: - description: Create a new measurement schema. - example: - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - name: cpu - properties: - columns: - description: Ordered collection of column definitions. - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - name: - description: | - The [measurement](/influxdb/cloud/reference/glossary/#measurement) - name. - type: string - required: - - name - - columns - type: object - MeasurementSchemaList: - description: A list of measurement schemas returning summary information - example: - measurementSchemas: - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8642 - name: cpu - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8643 - name: memory - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - - bucketID: ba3c5e7f9b0a0010 - createdAt: '2021-01-21T00:48:40.993Z' - id: 1a3c5e7f9b0a8644 - name: disk - orgID: 0a3c5e7f9b0a0001 - updatedAt: '2021-01-21T00:48:40.993Z' - properties: - measurementSchemas: - items: - $ref: '#/components/schemas/MeasurementSchema' - type: array - required: - - measurementSchemas - type: object - MeasurementSchemaUpdateRequest: - description: Update an existing measurement schema - example: - columns: - - format: unix timestamp - name: time - type: integer - - name: host - type: tag - - name: region - type: tag - - dataType: float - name: usage_user - type: field - - dataType: float - name: usage_user - type: field - properties: - columns: - description: An ordered collection of column definitions - items: - $ref: '#/components/schemas/MeasurementSchemaColumn' - type: array - required: - - columns - type: object - MemberAssignment: - description: Object property assignment - properties: - init: - $ref: '#/components/schemas/Expression' - member: - $ref: '#/components/schemas/MemberExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - MemberExpression: - description: Represents accessing a property of an object - properties: - object: - $ref: '#/components/schemas/Expression' - property: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - type: object - MosaicViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - mosaic - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yLabelColumnSeparator: - type: string - yLabelColumns: - items: - type: string - type: array - yPrefix: - type: string - ySeriesColumns: - items: - type: string - type: array - ySuffix: - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - ySeriesColumns - - fillColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - Node: - oneOf: - - $ref: '#/components/schemas/Expression' - - $ref: '#/components/schemas/Block' - NodeType: - description: Type of AST node - type: string - NotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - NotificationEndpointBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification endpoint. - type: string - id: - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/notificationEndpoints/1/labels - members: /api/v2/notificationEndpoints/1/members - owners: /api/v2/notificationEndpoints/1/owners - self: /api/v2/notificationEndpoints/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this endpoint. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this endpoint. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this endpoint. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - type: string - orgID: - type: string - status: - default: active - description: The status of the endpoint. - enum: - - active - - inactive - type: string - type: - $ref: '#/components/schemas/NotificationEndpointType' - updatedAt: - format: date-time - readOnly: true - type: string - userID: - type: string - required: - - type - - name - type: object - NotificationEndpointDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationEndpoint' - pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' - slack: '#/components/schemas/SlackNotificationEndpoint' - telegram: '#/components/schemas/TelegramNotificationEndpoint' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationEndpoint' - - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - - $ref: '#/components/schemas/HTTPNotificationEndpoint' - - $ref: '#/components/schemas/TelegramNotificationEndpoint' - NotificationEndpointType: - enum: - - slack - - pagerduty - - http - - telegram - type: string - NotificationEndpointUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationEndpoints: - properties: - links: - $ref: '#/components/schemas/Links' - notificationEndpoints: - items: - $ref: '#/components/schemas/NotificationEndpoint' - type: array - NotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - NotificationRuleBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification rule. - type: string - endpointID: - type: string - every: - description: The notification repetition interval. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - limit: - description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. - type: integer - limitEvery: - description: Don't notify me more than times every seconds. If set, limit cannot be empty. - type: integer - links: - example: - labels: /api/v2/notificationRules/1/labels - members: /api/v2/notificationRules/1/members - owners: /api/v2/notificationRules/1/owners - query: /api/v2/notificationRules/1/query - self: /api/v2/notificationRules/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this notification rule. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this notification rule. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this notification rule. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this notification rule. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - description: Human-readable name describing the notification rule. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - orgID: - description: The ID of the organization that owns this notification rule. - type: string - ownerID: - description: The ID of creator used to create this notification rule. - readOnly: true - type: string - runbookLink: - type: string - sleepUntil: - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - statusRules: - description: List of status rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/StatusRule' - minItems: 1 - type: array - tagRules: - description: List of tag rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/TagRule' - type: array - taskID: - description: The ID of the task associated with this notification rule. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - orgID - - status - - name - - statusRules - - endpointID - type: object - NotificationRuleDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationRule' - pagerduty: '#/components/schemas/PagerDutyNotificationRule' - slack: '#/components/schemas/SlackNotificationRule' - smtp: '#/components/schemas/SMTPNotificationRule' - telegram: '#/components/schemas/TelegramNotificationRule' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationRule' - - $ref: '#/components/schemas/SMTPNotificationRule' - - $ref: '#/components/schemas/PagerDutyNotificationRule' - - $ref: '#/components/schemas/HTTPNotificationRule' - - $ref: '#/components/schemas/TelegramNotificationRule' - NotificationRuleUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationRules: - properties: - links: - $ref: '#/components/schemas/Links' - notificationRules: - items: - $ref: '#/components/schemas/NotificationRule' - type: array - ObjectExpression: - description: Allows the declaration of an anonymous object within a declaration - properties: - properties: - description: Object properties - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - OnboardingRequest: - properties: - bucket: - type: string - limit: - $ref: '#/components/schemas/Limit' - org: - type: string - password: - type: string - retentionPeriodHrs: - deprecated: true - type: integer - retentionPeriodSeconds: - type: integer - username: - type: string - required: - - username - - org - - bucket - type: object - OnboardingResponse: - properties: - auth: - $ref: '#/components/schemas/Authorization' - bucket: - $ref: '#/components/schemas/Bucket' - org: - $ref: '#/components/schemas/Organization' - user: - $ref: '#/components/schemas/UserResponse' - type: object - OptionStatement: - description: A single variable declaration - properties: - assignment: - oneOf: - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Organization: - properties: - createdAt: - format: date-time - readOnly: true - type: string - defaultStorageType: - description: Discloses whether the organization uses TSM or IOx. - enum: - - tsm - - iox - type: string - description: - type: string - id: - readOnly: true - type: string - links: - example: - buckets: /api/v2/buckets?org=myorg - dashboards: /api/v2/dashboards?org=myorg - labels: /api/v2/orgs/1/labels - members: /api/v2/orgs/1/members - owners: /api/v2/orgs/1/owners - secrets: /api/v2/orgs/1/secrets - self: /api/v2/orgs/1 - tasks: /api/v2/tasks?org=myorg - properties: - buckets: - $ref: '#/components/schemas/Link' - dashboards: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - secrets: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - tasks: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - type: string - status: - default: active - description: If inactive, the organization is inactive. - enum: - - active - - inactive - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - Organizations: - properties: - links: - $ref: '#/components/schemas/Links' - orgs: - items: - $ref: '#/components/schemas/Organization' - type: array - type: object - Package: - description: Represents a complete package source tree. - properties: - files: - description: Package files - items: - $ref: '#/components/schemas/File' - type: array - package: - description: Package name - type: string - path: - description: Package import path - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - PackageClause: - description: Defines a package identifier - properties: - name: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - PagerDutyNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - clientURL: - type: string - routingKey: - type: string - required: - - routingKey - type: object - type: object - PagerDutyNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' - PagerDutyNotificationRuleBase: - properties: - messageTemplate: - type: string - type: - enum: - - pagerduty - type: string - required: - - type - - messageTemplate - type: object - Params: - properties: - params: - additionalProperties: - enum: - - any - - bool - - duration - - float - - int - - string - - time - - uint - type: string - description: | - The `params` keys and value type defined in the script. - type: object - type: object - ParenExpression: - description: Represents an expression wrapped in parenthesis - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PasswordResetBody: - properties: - password: - type: string - required: - - password - PatchBucketRequest: - description: | - An object that contains updated bucket properties to apply. - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The name of the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/PatchRetentionRules' - type: object - PatchOrganizationRequest: - description: | - An object that contains updated organization properties to apply. - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - type: object - PatchRetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The number of seconds to keep data. - Default duration is `2592000` (30 days). - `0` represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The [shard group duration](/influxdb/cloud/reference/glossary/#shard). - The number of seconds that each shard group covers. - - #### InfluxDB Cloud - - - Doesn't use `shardGroupDurationsSeconds`. - - #### InfluxDB OSS - - - Default value depends on the [bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration). - - #### Related guides - - - InfluxDB [shards and shard groups](/influxdb/cloud/reference/internals/shards/) - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - PatchRetentionRules: - description: Updates to rules to expire or retain data. No rules means no updates. - items: - $ref: '#/components/schemas/PatchRetentionRule' - type: array - Permission: - properties: - action: - enum: - - read - - write - type: string - resource: - $ref: '#/components/schemas/Resource' - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - required: - - action - - resource - PipeExpression: - description: Call expression with pipe argument - properties: - argument: - $ref: '#/components/schemas/Expression' - call: - $ref: '#/components/schemas/CallExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PipeLiteral: - description: Represents a specialized literal value, indicating the left hand value of a pipe expression - properties: - type: - $ref: '#/components/schemas/NodeType' - type: object - PostBucketRequest: - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The bucket name. - type: string - orgID: - description: | - The organization ID. - Specifies the organization that owns the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - default: '0' - description: | - The retention policy for the bucket. - For InfluxDB 1.x, specifies the duration of time that each data point - in the retention policy persists. - - If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; - otherwise, see the `retentionRules` property. - - [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) - is an InfluxDB 1.x concept. - The InfluxDB 2.x and Cloud equivalent is - [retention period](/influxdb/cloud/reference/glossary/#retention-period). - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - description: | - The schema Type. Default is `implicit`. - - #### InfluxDB Cloud - - - Use `explicit` to enforce column names, tags, fields, and data types for - your data. - - #### InfluxDB OSS - - - Doesn't support `explicit` bucket schemas. - required: - - orgID - - name - PostCheck: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - PostNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - PostNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - PostOrganizationRequest: - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - required: - - name - type: object - Property: - description: The value associated with a key - properties: - key: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - value: - $ref: '#/components/schemas/Expression' - type: object - PropertyKey: - oneOf: - - $ref: '#/components/schemas/Identifier' - - $ref: '#/components/schemas/StringLiteral' - Query: - description: Query InfluxDB with the Flux language - properties: - dialect: - $ref: '#/components/schemas/Dialect' - extern: - $ref: '#/components/schemas/File' - now: - description: | - Specifies the time that should be reported as `now` in the query. - Default is the server `now` time. - format: date-time - type: string - params: - additionalProperties: true - description: | - Key-value pairs passed as parameters during query execution. - - To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example: - - ```json - query: "from(bucket: params.mybucket)\ - |> range(start: params.rangeStart) |> limit(n:1)" - ``` - - and pass _`params`_ with the key-value pairs--for example: - - ```json - params: { - "mybucket": "environment", - "rangeStart": "-30d" - } - ``` - - During query execution, InfluxDB passes _`params`_ to your script and substitutes the values. - - #### Limitations - - - If you use _`params`_, you can't use _`extern`_. - type: object - query: - description: The query script to execute. - type: string - type: - description: The type of query. Must be "flux". - enum: - - flux - type: string - required: - - query - type: object - QueryEditMode: - enum: - - builder - - advanced - type: string - QueryVariableProperties: - properties: - type: - enum: - - query - type: string - values: - properties: - language: - type: string - query: - type: string - type: object - RangeThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - max: - format: float - type: number - min: - format: float - type: number - type: - enum: - - range - type: string - within: - type: boolean - required: - - type - - min - - max - - within - type: object - Ready: - properties: - started: - example: '2019-03-13T10:09:33.891196-04:00' - format: date-time - type: string - status: - enum: - - ready - type: string - up: - example: 14m45.911966424s - type: string - type: object - RegexpLiteral: - description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - RenamableField: - description: Describes a field that can be renamed and made visible or invisible. - properties: - displayName: - description: The name that a field is renamed to by the user. - type: string - internalName: - description: The calculated name of a field. - readOnly: true - type: string - visible: - description: Indicates whether this field should be visible on the table. - type: boolean - type: object - Resource: - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - ResourceMember: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: member - enum: - - member - type: string - type: object - ResourceMembers: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceMember' - type: array - type: object - ResourceOwner: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: owner - enum: - - owner - type: string - type: object - ResourceOwners: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceOwner' - type: array - type: object - RetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The duration in seconds for how long data will be kept in the database. - The default duration is 2592000 (30 days). - 0 represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The shard group duration. - The duration or interval (in seconds) that each shard group covers. - - #### InfluxDB Cloud - - - Does not use `shardGroupDurationsSeconds`. - - #### InfluxDB OSS - - - Default value depends on the - [bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration). - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - RetentionRules: - description: | - Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud/reference/glossary/#retention-period). - - #### InfluxDB Cloud - - - `retentionRules` is required. - - #### InfluxDB OSS - - - `retentionRules` isn't required. - items: - $ref: '#/components/schemas/RetentionRule' - type: array - ReturnStatement: - description: Defines an expression to return - properties: - argument: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Routes: - properties: - authorizations: - format: uri - type: string - buckets: - format: uri - type: string - dashboards: - format: uri - type: string - external: - properties: - statusFeed: - format: uri - type: string - type: object - flags: - format: uri - type: string - me: - format: uri - type: string - orgs: - format: uri - type: string - query: - properties: - analyze: - format: uri - type: string - ast: - format: uri - type: string - self: - format: uri - type: string - suggestions: - format: uri - type: string - type: object - setup: - format: uri - type: string - signin: - format: uri - type: string - signout: - format: uri - type: string - sources: - format: uri - type: string - system: - properties: - debug: - format: uri - type: string - health: - format: uri - type: string - metrics: - format: uri - type: string - type: object - tasks: - format: uri - type: string - telegrafs: - format: uri - type: string - users: - format: uri - type: string - variables: - format: uri - type: string - write: - format: uri - type: string - RuleStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - - ANY - type: string - Run: - properties: - finishedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - flux: - description: Flux used for the task - readOnly: true - type: string - id: - readOnly: true - type: string - links: - example: - retry: /api/v2/tasks/1/runs/1/retry - self: /api/v2/tasks/1/runs/1 - task: /api/v2/tasks/1 - properties: - retry: - format: uri - type: string - self: - format: uri - type: string - task: - format: uri - type: string - readOnly: true - type: object - log: - description: An array of logs associated with the run. - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - requestedAt: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - scheduledFor: - description: The time [RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. - format: date-time - type: string - startedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - status: - enum: - - scheduled - - started - - failed - - success - - canceled - readOnly: true - type: string - taskID: - readOnly: true - type: string - RunManually: - properties: - scheduledFor: - description: | - The time [RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp) - used for the run's `now` option. - Default is the server _now_ time. - format: date-time - nullable: true - type: string - Runs: - properties: - links: - $ref: '#/components/schemas/Links' - runs: - items: - $ref: '#/components/schemas/Run' - type: array - type: object - SMTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SMTPNotificationRuleBase' - SMTPNotificationRuleBase: - properties: - bodyTemplate: - type: string - subjectTemplate: - type: string - to: - type: string - type: - enum: - - smtp - type: string - required: - - type - - subjectTemplate - - to - type: object - ScatterViewProperties: - properties: - adaptiveZoomHide: - type: boolean - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - symbolColumns: - items: - type: string - type: array - timeFormat: - type: string - type: - enum: - - scatter - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - fillColumns - - symbolColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - SchemaType: - enum: - - implicit - - explicit - type: string - Script: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - language: - $ref: '#/components/schemas/ScriptLanguage' - name: - type: string - orgID: - type: string - script: - description: The script to execute. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - url: - description: The invocation endpoint address. - type: string - required: - - name - - orgID - - script - ScriptCreateRequest: - properties: - description: - description: Script description. A description of the script. - type: string - language: - $ref: '#/components/schemas/ScriptLanguage' - name: - description: Script name. The name must be unique within the organization. - type: string - script: - description: The script to execute. - type: string - required: - - name - - script - - language - - description - type: object - ScriptHTTPResponseData: - description: | - The response body contains the results of the executed script. - The response is user-defined and dynamic. - format: binary - type: string - ScriptInvocationParams: - properties: - params: - additionalProperties: true - description: | - The script parameters. - `params` contains key-value pairs that map values to the **params.keys** - in a script. - When you invoke a script with `params`, InfluxDB passes the values as - invocation parameters to the script. - type: object - type: object - ScriptLanguage: - enum: - - flux - - sql - type: string - ScriptUpdateRequest: - properties: - description: - description: A description of the script. - type: string - script: - description: The script to execute. - type: string - type: object - Scripts: - properties: - scripts: - items: - $ref: '#/components/schemas/Script' - type: array - type: object - SecretKeys: - properties: - secrets: - items: - type: string - type: array - type: object - SecretKeysResponse: - allOf: - - $ref: '#/components/schemas/SecretKeys' - - properties: - links: - properties: - org: - type: string - self: - type: string - readOnly: true - type: object - type: object - Secrets: - additionalProperties: - type: string - example: - apikey: abc123xyz - SimpleTableViewProperties: - properties: - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showAll: - type: boolean - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - simple-table - type: string - required: - - type - - showAll - - queries - - shape - - note - - showNoteWhenEmpty - type: object - SingleStatViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - single-stat - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - SlackNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - token: - description: Specifies the API token string. Specify either `URL` or `Token`. - type: string - url: - description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. - type: string - type: object - type: object - SlackNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SlackNotificationRuleBase' - SlackNotificationRuleBase: - properties: - channel: - type: string - messageTemplate: - type: string - type: - enum: - - slack - type: string - required: - - type - - messageTemplate - type: object - Stack: - properties: - createdAt: - format: date-time - readOnly: true - type: string - events: - items: - properties: - description: - type: string - eventType: - type: string - name: - type: string - resources: - items: - properties: - apiVersion: - type: string - associations: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - metaName: - type: string - type: object - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - links: - properties: - self: - type: string - type: object - resourceID: - type: string - templateMetaName: - type: string - type: object - type: array - sources: - items: - type: string - type: array - updatedAt: - format: date-time - readOnly: true - type: string - urls: - items: - type: string - type: array - type: object - type: array - id: - type: string - orgID: - type: string - type: object - Statement: - oneOf: - - $ref: '#/components/schemas/BadStatement' - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - - $ref: '#/components/schemas/ExpressionStatement' - - $ref: '#/components/schemas/ReturnStatement' - - $ref: '#/components/schemas/OptionStatement' - - $ref: '#/components/schemas/BuiltinStatement' - - $ref: '#/components/schemas/TestStatement' - StaticLegend: - description: StaticLegend represents the options specific to the static legend - properties: - colorizeRows: - type: boolean - heightRatio: - format: float - type: number - opacity: - format: float - type: number - orientationThreshold: - type: integer - show: - type: boolean - valueAxis: - type: string - widthRatio: - format: float - type: number - type: object - StatusRule: - properties: - count: - type: integer - currentLevel: - $ref: '#/components/schemas/RuleStatusLevel' - period: - type: string - previousLevel: - $ref: '#/components/schemas/RuleStatusLevel' - type: object - StringLiteral: - description: Expressions begin and end with double quote marks - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - TableViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - fieldOptions: - description: fieldOptions represent the fields retrieved by the query with customization options - items: - $ref: '#/components/schemas/RenamableField' - type: array - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - tableOptions: - properties: - fixFirstColumn: - description: fixFirstColumn indicates whether the first column of the table should be locked - type: boolean - sortBy: - $ref: '#/components/schemas/RenamableField' - verticalTimeAxis: - description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically - type: boolean - wrapping: - description: Wrapping describes the text wrapping style to be used in table views - enum: - - truncate - - wrap - - single-line - type: string - type: object - timeFormat: - description: timeFormat describes the display format for time values according to moment.js date formatting - type: string - type: - enum: - - table - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - tableOptions - - fieldOptions - - timeFormat - - decimalPlaces - type: object - TagRule: - properties: - key: - type: string - operator: - enum: - - equal - - notequal - - equalregex - - notequalregex - type: string - value: - type: string - type: object - Task: - properties: - authorizationID: - description: | - An authorization ID. - Specifies the authorization used when the task communicates with the query engine. - - To find an authorization ID, use the - [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to - list authorizations. - type: string - createdAt: - format: date-time - readOnly: true - type: string - cron: - description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. - type: string - description: - description: A description of the task. - type: string - every: - description: The interval ([duration literal](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. - format: duration - type: string - flux: - description: | - The Flux script that the task executes. - - #### Limitations - - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. - format: flux - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/tasks/1/labels - logs: /api/v2/tasks/1/logs - members: /api/v2/tasks/1/members - owners: /api/v2/tasks/1/owners - runs: /api/v2/tasks/1/runs - self: /api/v2/tasks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - logs: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - runs: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - description: The name of the task. - type: string - offset: - description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. - format: duration - type: string - org: - description: | - An [organization](/influxdb/cloud/reference/glossary/#organization) name. - Specifies the organization that owns the task. - type: string - orgID: - description: | - An [organization](/influxdb/cloud/reference/glossary/#organization) ID. - Specifies the organization that owns the task. - type: string - ownerID: - description: | - A [user](/influxdb/cloud/reference/glossary/#user) ID. - Specifies the owner of the task. - - To find a user ID, you can use the - [`GET /api/v2/users` endpoint](#operation/GetUsers) to - list users. - type: string - scriptID: - description: | - A script ID. - Specifies the [invokable script](#tag/Invokable-Scripts) that the task executes. - - #### Limitations - - - If you use the `scriptID` property, you can't use the `flux` property. - - #### Related guides - - - [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script) - type: string - scriptParameters: - description: | - Key-value pairs for `params` in the script. - Defines the invocation parameter values passed to the script specified by `scriptID`. - When running the task, InfluxDB executes the script with the parameters - you provide. - - #### Limitations - - - To use `scriptParameters`, you must provide a `scriptID`. - - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - updatedAt: - format: date-time - readOnly: true - type: string - required: - - id - - name - - orgID - type: object - TaskCreateRequest: - properties: - cron: - description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time. - type: string - description: - description: The description of the task. - type: string - every: - description: | - The interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. - `every` also determines when the task first runs, depending on the specified time. - type: string - flux: - description: | - The Flux script that the task runs. - - #### Limitations - - - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. - type: string - name: - description: The name of the task - type: string - offset: - description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. - format: duration - type: string - org: - description: The name of the organization that owns the task. - type: string - orgID: - description: The ID of the organization that owns the task. - type: string - scriptID: - description: | - The ID of the script that the task runs. - - #### Limitations - - - If you use the `scriptID` property, you can't use the `flux` property. - type: string - scriptParameters: - description: | - The parameter key-value pairs passed to the script (referenced by `scriptID`) during the task run. - - #### Limitations - - - `scriptParameters` requires `scriptID`. - - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - type: object - TaskStatusType: - description: | - `inactive` cancels scheduled runs and prevents manual runs of the task. - enum: - - active - - inactive - type: string - TaskUpdateRequest: - properties: - cron: - description: Update the 'cron' option in the flux script. - type: string - description: - description: Update the description of the task. - type: string - every: - description: Update the 'every' option in the flux script. - type: string - flux: - description: Update the Flux script that the task runs. - type: string - name: - description: Update the 'name' option in the flux script. - type: string - offset: - description: Update the 'offset' option in the flux script. - type: string - scriptID: - description: Update the 'scriptID' of the task. - type: string - scriptParameters: - description: Update the 'scriptParameters' of the task. - type: object - status: - $ref: '#/components/schemas/TaskStatusType' - type: object - Tasks: - properties: - links: - $ref: '#/components/schemas/Links' - readOnly: true - tasks: - items: - $ref: '#/components/schemas/Task' - type: array - type: object - Telegraf: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - readOnly: true - links: - example: - labels: /api/v2/telegrafs/1/labels - members: /api/v2/telegrafs/1/members - owners: /api/v2/telegrafs/1/owners - self: /api/v2/telegrafs/1 - properties: - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - type: object - type: object - TelegrafPlugin: - properties: - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - TelegrafPluginRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - plugins: - items: - properties: - alias: - type: string - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - type: array - type: object - TelegrafPlugins: - properties: - os: - type: string - plugins: - items: - $ref: '#/components/schemas/TelegrafPlugin' - type: array - version: - type: string - type: object - TelegrafRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - type: object - Telegrafs: - properties: - configurations: - items: - $ref: '#/components/schemas/Telegraf' - type: array - type: object - TelegramNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - channel: - description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . - type: string - token: - description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . - type: string - required: - - token - - channel - type: object - type: object - TelegramNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/TelegramNotificationRuleBase' - TelegramNotificationRuleBase: - properties: - disableWebPagePreview: - description: Disables preview of web links in the sent messages when "true". Defaults to "false". - type: boolean - messageTemplate: - description: The message template as a flux interpolated string. - type: string - parseMode: - description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". - enum: - - MarkdownV2 - - HTML - - Markdown - type: string - type: - description: The discriminator between other types of notification rules is "telegram". - enum: - - telegram - type: string - required: - - type - - messageTemplate - - channel - type: object - Template: - items: - description: | - A template entry. - Defines an InfluxDB resource in a template. - properties: - apiVersion: - example: influxdata.com/v2alpha1 - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - metadata: - description: | - Metadata properties used for the resource when the template is applied. - properties: - name: - type: string - type: object - spec: - description: | - Configuration properties used for the resource when the template is applied. - Key-value pairs map to the specification for the resource. - - The following code samples show `spec` configurations for template resources: - - - A bucket: - - ```json - { "spec": { - "name": "iot_center", - "retentionRules": [{ - "everySeconds": 2.592e+06, - "type": "expire" - }] - } - } - ``` - - - A variable: - - ```json - { "spec": { - "language": "flux", - "name": "Node_Service", - "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", - tag: \"service\")", - "type": "query" - } - } - ``` - type: object - type: object - type: array - TemplateApply: - properties: - actions: - description: | - A list of `action` objects. - Actions let you customize how InfluxDB applies templates in the request. - - You can use the following actions to prevent creating or updating resources: - - - A `skipKind` action skips template resources of a specified `kind`. - - A `skipResource` action skips template resources with a specified `metadata.name` - and `kind`. - items: - oneOf: - - properties: - action: - enum: - - skipKind - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - required: - - kind - type: object - type: object - - properties: - action: - enum: - - skipResource - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - resourceTemplateName: - type: string - required: - - kind - - resourceTemplateName - type: object - type: object - type: array - dryRun: - description: | - Only applies a dry run of the templates passed in the request. - - - Validates the template and generates a resource diff and summary. - - Doesn't install templates or make changes to the InfluxDB instance. - type: boolean - envRefs: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - description: | - An object with key-value pairs that map to **environment references** in templates. - - Environment references in templates are `envRef` objects with an `envRef.key` - property. - To substitute a custom environment reference value when applying templates, - pass `envRefs` with the `envRef.key` and the value. - - When you apply a template, InfluxDB replaces `envRef` objects in the template - with the values that you provide in the `envRefs` parameter. - For more examples, see how to [define environment references](/influxdb/cloud/influxdb-templates/use/#define-environment-references). - - The following template fields may use environment references: - - - `metadata.name` - - `spec.endpointName` - - `spec.associations.name` - - For more information about including environment references in template fields, see how to - [include user-definable resource names](/influxdb/cloud/influxdb-templates/create/#include-user-definable-resource-names). - type: object - orgID: - description: | - Organization ID. - InfluxDB applies templates to this organization. - The organization owns all resources created by the template. - - To find your organization, see how to - [view organizations](/influxdb/cloud/organizations/view-orgs/). - type: string - remotes: - description: | - A list of URLs for template files. - - To apply a template manifest file located at a URL, pass `remotes` - with an array that contains the URL. - items: - properties: - contentType: - type: string - url: - type: string - required: - - url - type: object - type: array - secrets: - additionalProperties: - type: string - description: | - An object with key-value pairs that map to **secrets** in queries. - - Queries may reference secrets stored in InfluxDB--for example, - the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` - secrets and then uses them to connect to a PostgreSQL database: - - ```js - import "sql" - import "influxdata/influxdb/secrets" - - username = secrets.get(key: "POSTGRES_USERNAME") - password = secrets.get(key: "POSTGRES_PASSWORD") - - sql.from( - driverName: "postgres", - dataSourceName: "postgresql://${username}:${password}@localhost:5432", - query: "SELECT * FROM example_table", - ) - ``` - - To define secret values in your `/api/v2/templates/apply` request, - pass the `secrets` parameter with key-value pairs--for example: - - ```json - { - ... - "secrets": { - "POSTGRES_USERNAME": "pguser", - "POSTGRES_PASSWORD": "foo" - } - ... - } - ``` - - InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. - Once stored, you can't view secret values in InfluxDB. - - #### Related guides - - - [How to pass secrets when installing a template](/influxdb/cloud/influxdb-templates/use/#pass-secrets-when-installing-a-template) - type: object - stackID: - description: | - ID of the stack to update. - - To apply templates to an existing stack in the organization, use the `stackID` parameter. - If you apply templates without providing a stack ID, - InfluxDB initializes a new stack with all new resources. - - To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. - - #### Related guides - - - [Stacks](/influxdb/cloud/influxdb-templates/stacks/) - - [View stacks](/influxdb/cloud/influxdb-templates/stacks/view/) - type: string - template: - description: | - A template object to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Pass `template` to apply only one template object. - If you use `template`, you can't use the `templates` parameter. - If you want to apply multiple template objects, use `templates` instead. - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - templates: - description: | - A list of template objects to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Use the `templates` parameter to apply multiple template objects. - If you use `templates`, you can't use the `template` parameter. - items: - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - type: array - type: object - TemplateChart: - properties: - height: - type: integer - properties: - $ref: '#/components/schemas/ViewProperties' - width: - type: integer - xPos: - type: integer - yPos: - type: integer - type: object - TemplateEnvReferences: - items: - properties: - defaultValue: - description: Default value that will be provided for the reference when no value is provided - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - envRefKey: - description: Key identified as environment reference and is the key identified in the template - type: string - resourceField: - description: Field the environment reference corresponds too - type: string - value: - description: Value provided to fulfill reference - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - required: - - resourceField - - envRefKey - type: object - type: array - TemplateExportByID: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported - type: string - required: - - id - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateExportByName: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - required: - - name - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateKind: - enum: - - Bucket - - Check - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpoint - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable - type: string - TemplateSummary: - properties: - diff: - properties: - buckets: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - old: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - checks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/CheckDiscriminator' - old: - $ref: '#/components/schemas/CheckDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - old: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - old: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationEndpoints: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - old: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - old: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - old: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/TelegrafRequest' - old: - $ref: '#/components/schemas/TelegrafRequest' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - old: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - errors: - items: - properties: - fields: - items: - type: string - type: array - indexes: - items: - type: integer - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - reason: - type: string - type: object - type: array - sources: - items: - type: string - type: array - stackID: - type: string - summary: - properties: - buckets: - items: - properties: - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - retentionPeriod: - type: integer - templateMetaName: - type: string - type: object - type: array - checks: - items: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - missingEnvRefs: - items: - type: string - type: array - missingSecrets: - items: - type: string - type: array - notificationEndpoints: - items: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - description: - type: string - endpointID: - type: string - endpointTemplateMetaName: - type: string - endpointType: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - cron: - type: string - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - type: object - TemplateSummaryLabel: - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - orgID: - type: string - properties: - properties: - color: - type: string - description: - type: string - type: object - templateMetaName: - type: string - type: object - TestStatement: - description: Declares a Flux test case - properties: - assignment: - $ref: '#/components/schemas/VariableAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Threshold: - discriminator: - mapping: - greater: '#/components/schemas/GreaterThreshold' - lesser: '#/components/schemas/LesserThreshold' - range: '#/components/schemas/RangeThreshold' - propertyName: type - oneOf: - - $ref: '#/components/schemas/GreaterThreshold' - - $ref: '#/components/schemas/LesserThreshold' - - $ref: '#/components/schemas/RangeThreshold' - ThresholdBase: - properties: - allValues: - description: If true, only alert if all values meet threshold. - type: boolean - level: - $ref: '#/components/schemas/CheckStatusLevel' - ThresholdCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - thresholds: - items: - $ref: '#/components/schemas/Threshold' - type: array - type: - enum: - - threshold - type: string - required: - - type - type: object - Token: - properties: - token: - type: string - type: object - UnaryExpression: - description: Uses operators to act on a single operand in an expression - properties: - argument: - $ref: '#/components/schemas/Expression' - operator: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - UnsignedIntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - User: - properties: - id: - readOnly: true - type: string - name: - type: string - org_id: - type: string - role: - enum: - - owner - - member - type: string - status: - default: active - description: If inactive the user is inactive. - enum: - - active - - inactive - type: string - required: - - name - UserResponse: - properties: - id: - description: | - The user ID. - readOnly: true - type: string - links: - example: - self: /api/v2/users/1 - properties: - self: - format: uri - type: string - readOnly: true - type: object - name: - description: | - The user name. - type: string - status: - default: active - description: | - The status of a user. - An inactive user can't read or write resources. - enum: - - active - - inactive - type: string - required: - - name - Users: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/UserResponse' - type: array - type: object - Variable: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - createdAt: - format: date-time - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - properties: - labels: - format: uri - type: string - org: - format: uri - type: string - self: - format: uri - type: string - readOnly: true - type: object - name: - type: string - orgID: - type: string - selected: - items: - type: string - type: array - sort_order: - type: integer - updatedAt: - format: date-time - type: string - required: - - name - - orgID - - arguments - type: object - VariableAssignment: - description: Represents the declaration of a variable - properties: - id: - $ref: '#/components/schemas/Identifier' - init: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - VariableProperties: - oneOf: - - $ref: '#/components/schemas/QueryVariableProperties' - - $ref: '#/components/schemas/ConstantVariableProperties' - - $ref: '#/components/schemas/MapVariableProperties' - type: object - Variables: - example: - variables: - - arguments: - type: constant - values: - - howdy - - hello - - hi - - yo - - oy - id: '1221432' - name: ':ok:' - selected: - - hello - - arguments: - type: map - values: - a: fdjaklfdjkldsfjlkjdsa - b: dfaksjfkljekfajekdljfas - c: fdjksajfdkfeawfeea - id: '1221432' - name: ':ok:' - selected: - - c - - arguments: - language: flux - query: 'from(bucket: "foo") |> showMeasurements()' - type: query - id: '1221432' - name: ':ok:' - selected: - - host - properties: - variables: - items: - $ref: '#/components/schemas/Variable' - type: array - type: object - View: - properties: - id: - readOnly: true - type: string - links: - properties: - self: - type: string - readOnly: true - type: object - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - required: - - name - - properties - ViewProperties: - oneOf: - - $ref: '#/components/schemas/LinePlusSingleStatProperties' - - $ref: '#/components/schemas/XYViewProperties' - - $ref: '#/components/schemas/SingleStatViewProperties' - - $ref: '#/components/schemas/HistogramViewProperties' - - $ref: '#/components/schemas/GaugeViewProperties' - - $ref: '#/components/schemas/TableViewProperties' - - $ref: '#/components/schemas/SimpleTableViewProperties' - - $ref: '#/components/schemas/MarkdownViewProperties' - - $ref: '#/components/schemas/CheckViewProperties' - - $ref: '#/components/schemas/ScatterViewProperties' - - $ref: '#/components/schemas/HeatmapViewProperties' - - $ref: '#/components/schemas/MosaicViewProperties' - - $ref: '#/components/schemas/BandViewProperties' - - $ref: '#/components/schemas/GeoViewProperties' - Views: - properties: - links: - properties: - self: - type: string - type: object - views: - items: - $ref: '#/components/schemas/View' - type: array - type: object - WritePrecision: - enum: - - ms - - s - - us - - ns - type: string - XYGeom: - enum: - - line - - step - - stacked - - bar - - monotoneX - - stepBefore - - stepAfter - type: string - XYViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colorMapping: - $ref: '#/components/schemas/ColorMapping' - description: An object that contains information about the color mapping - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - xy - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - position - type: object - securitySchemes: - BasicAuthentication: - description: | - ### Basic authentication scheme - - Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: - - ### Syntax - - `Authorization: Basic BASE64_ENCODED_CREDENTIALS` - - To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and - the password with a colon (`USERNAME:PASSWORD`), and then encode the - resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). - Many HTTP clients encode the credentials for you before sending the - request. - - _**Warning**: Base64-encoding can easily be reversed to obtain the original - username and password. It is used to keep the data intact and does not provide - security. You should always use HTTPS when authenticating or sending a request with - sensitive information._ - - ### Examples - - In the examples, replace the following: - - - **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with) - - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb/cloud/reference/glossary/#token) - - **`INFLUX_URL`**: your InfluxDB Cloud URL - - #### Encode credentials with cURL - - The following example shows how to use cURL to send an API request that uses Basic authentication. - With the `--user` option, cURL encodes the credentials and passes them - in the `Authorization: Basic` header. - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --user "EMAIL_ADDRESS":"PASSWORD" - ``` - - #### Encode credentials with Flux - - The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded - basic authentication header using a specified username and password combination. - - #### Encode credentials with JavaScript - - The following example shows how to use the JavaScript `btoa()` function - to create a Base64-encoded string: - - ```js - btoa('EMAIL_ADDRESS:PASSWORD') - ``` - - The output is the following: - - ```js - 'VVNFUk5BTUU6UEFTU1dPUkQ=' - ``` - - Once you have the Base64-encoded credentials, you can pass them in the - `Authorization` header--for example: - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" - ``` - - To learn more about HTTP authentication, see - [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ - scheme: basic - type: http - TokenAuthentication: - description: | - Use the [Token authentication](#section/Authentication/TokenAuthentication) - scheme to authenticate to the InfluxDB API. - - In your API requests, send an `Authorization` header. - For the header value, provide the word `Token` followed by a space and an InfluxDB API token. - The word `Token` is case-sensitive. - - ### Syntax - - `Authorization: Token INFLUX_API_TOKEN` - - ### Example - - #### Use Token authentication with cURL - - The following example shows how to use cURL to send an API request that uses Token authentication: - - ```sh - curl --request GET "INFLUX_URL/api/v2/buckets" \ - --header "Authorization: Token INFLUX_API_TOKEN" - ``` - - Replace the following: - - - *`INFLUX_URL`*: your InfluxDB Cloud URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token) - - ### Related endpoints - - - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) - - ### Related guides - - - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/cloud/security/tokens/) - in: header - name: Authorization - type: apiKey +openapi: 3.0.0 info: title: InfluxDB Cloud API Service - version: Cloud 2.x + version: 2.x description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. - Access the InfluxDB API using the `/api/v2/` endpoint. + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). license: name: MIT url: https://opensource.org/licenses/MIT -openapi: 3.0.0 + summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. +servers: + - url: https://{baseurl} + description: InfluxDB Cloud API URL + variables: + baseurl: + enum: + - us-east-1-1.aws.cloud2.influxdata.com + default: us-east-1-1.aws.cloud2.influxdata.com + description: InfluxDB Cloud URL +security: + - TokenAuthentication: [] +tags: + - 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) + + name: Authentication + x-traitTag: true + - description: | + Create and manage authorizations (API tokens). + + An _authorization_ contains a list of `read` and `write` + permissions for organization resources and provides an API token for authentication. + An authorization belongs to an organization and only contains permissions for that organization. + + We recommend the following for managing your tokens: + + - Create a generic user to create and manage tokens for writing data. + - Store your tokens in a secure password vault for future access. + + ### User sessions with authorizations + + Optionally, when creating an authorization, you can scope it to a specific user. + If the user signs in with username and password, creating a _user session_, + the session carries the permissions granted by all the user's authorizations. + For more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/). + To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + + ### Related endpoints + + - [Signin](#tag/Signin) + - [Signout](#tag/Signout) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud/security/tokens/) + - [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/) + name: Authorizations (API tokens) + - name: Bucket Schemas + - description: | + Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/#bucket). + A bucket is a named location where time series data is stored. All buckets + have a [retention period](/influxdb/cloud/reference/glossary/#retention-period), + a duration of time that each data point persists. InfluxDB drops all + points with timestamps older than the bucket’s retention period. + A bucket belongs to an organization. + + ### Related guides + + - [Manage buckets](/influxdb/cloud/organizations/buckets/) + name: Buckets + - name: Cells + - name: Checks + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `bucket` resource in an `org` (_organization_ resource). + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). | + name: Common parameters + x-traitTag: true + - name: Config + - name: Dashboards + - name: Data I/O endpoints + - description: | + The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) + and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). + InfluxDB 2.x replaces databases and retention policies with buckets. + To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, + databases and retention policies are mapped to buckets using the + database and retention policy (DBRP) mapping service. + The DBRP mapping service uses the database and retention policy + specified in 1.x compatibility API requests to route operations to a bucket. + + ### Related guides + + - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) + name: DBRPs + - description: | + Delete data from an InfluxDB bucket. + name: Delete + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - description: | + Store, manage, and execute scripts in InfluxDB. + A script stores your custom Flux script and provides an invokable + endpoint that accepts runtime parameters. + In a script, you can specify custom runtime parameters + (`params`)--for example, `params.myparameter`. + Once you create a script, InfluxDB generates an + [`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke) + for your organization. + You can run the script from API requests and tasks, defining parameter + values for each run. + When the script runs, InfluxDB replaces `params` references in the + script with the runtime parameter values you define. + + Use the `/api/v2/scripts` endpoints to create and manage scripts. + See related guides to learn how to define parameters and execute scripts. + + ### Related guides + + - [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests. + - [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script) + name: Invokable Scripts + - name: Labels + - name: Legacy Authorizations + - name: Legacy Query + - name: Legacy Write + - name: Limits + - name: NotificationEndpoints + - name: NotificationRules + - description: | + Manage your [organization](/influxdb/cloud/reference/glossary/#organization). + An organization is a workspace for a group of users. Organizations can be + used to separate different environments, projects, teams or users within + InfluxDB. + + Use the `/api/v2/orgs` endpoints to view and manage organizations. + name: Organizations + - description: | + Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `limit` | integer | The maximum number of records to return (after other parameters are applied). | + | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | + | `after` | string (resource ID) | Only returns resources created after the specified resource. | + + ### Limitations + + - For specific endpoint parameters and examples, see the endpoint definition. + - If you specify an `offset` parameter value greater than the total number of records, + then InfluxDB returns an empty list in the response + (given `offset` skips the specified number of records). + + The following example passes `offset=50` to skip the first 50 results, + but the user only has 10 buckets: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + The response contains the following: + + ```json + { + "links": { + "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", + "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" + }, + "buckets": [] + } + ``` + name: Pagination + x-traitTag: true + - name: Ping + - description: | + Retrieve data, analyze queries, and get query suggestions. + name: Query + - 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. + + [**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/) + are available for popular languages and ready to import into your application. + name: Quick start + x-traitTag: true + - name: Resources + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `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. | + | `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.
| + | `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/)
| + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `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`. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: Routes + - name: Rules + - name: Secrets + - name: Security and access endpoints + - name: Setup + - name: Signin + - name: Signout + - 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" + name: Supported operations + x-traitTag: true + - name: System information endpoints + - description: | + Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/#task) + in the InfluxDB task engine. + Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + + 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). + + + + ### Properties + + A `task` object contains information about an InfluxDB task resource. + + The following table defines the properties that appear in this object: + + + + ### Related guides + + - [Get started with tasks](/influxdb/cloud/process-data/get-started/) + - [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/) + - [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script) + name: Tasks + - name: Telegraf Plugins + - name: Telegrafs + - description: | + Export and apply InfluxDB **templates**. + Manage **stacks** of templated InfluxDB resources. + + InfluxDB templates are prepackaged configurations for resources. + Use InfluxDB templates to configure a fresh instance of InfluxDB, + back up your dashboard configuration, or share your configuration. + + Use the `/api/v2/templates` endpoints to export templates and apply templates. + + **InfluxDB stacks** are stateful InfluxDB templates that let you + add, update, and remove installed template resources over time, avoid duplicating + resources when applying the same or similar templates more than once, and + apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + + Use the `/api/v2/stacks` endpoints to manage installed template resources. + + ### Related guides + + - [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/) + - [InfluxDB templates](/influxdb/cloud/influxdb-templates/) + name: Templates + - name: Usage + - description: | + Retrieve specific users. + + InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. + To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); + you can't use the InfluxDB API to manage users in InfluxDB Cloud. + Once a user is added to your organization, you can use the + `GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to + view specific members. + + ### User sessions with authorizations + + Optionally, you can scope an authorization (and its API token) to a user. + If a user signs in with username and password, creating a _user session_, + 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). + + ### Related guides + + - [Manage users](/influxdb/cloud/organizations/users/) + name: Users + - name: Variables + - name: Views + - description: | + Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket). + name: Write paths: /api/v2: get: @@ -18795,311 +12383,6730 @@ paths: summary: Write time series data into InfluxDB in a V1-compatible format tags: - Legacy Write -security: - - TokenAuthentication: [] -servers: - - url: / -tags: - - description: | - Use one of the following schemes to authenticate to the InfluxDB API: +components: + examples: + AuthorizationPostRequest: + description: Creates an authorization. + summary: An authorization for a resource type + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + type: buckets + AuthorizationWithResourcePostRequest: + description: Creates an authorization for access to a specific resource. + summary: An authorization for a resource + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + id: INFLUX_BUCKET_ID + type: buckets + AuthorizationWithUserPostRequest: + description: Creates an authorization scoped to a specific user. + summary: An authorization scoped to a user + value: + description: iot_user write to bucket + orgID: INFLUX_ORG_ID + permissions: + - action: write + resource: + id: INFLUX_BUCKET_ID + type: buckets + userID: INFLUX_USER_ID + TaskWithFluxRequest: + description: Sets the `flux` property with Flux task options and a query. + summary: A task with Flux + value: + description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. + flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" + status: active + TaskWithScriptRequest: + description: | + Sets properties for a task that runs an _invokable script_. + summary: A task with an invokable script + value: + description: This task runs an invokable script every hour with the defined parameters. + every: 1h + name: CPU Total 1 Hour New + scriptID: SCRIPT_ID + scriptParameters: + bucket: telegraf + filterField: cpu-total + rangeStart: '-1h' + status: active + parameters: + After: + description: | + A resource ID to seek from. + Returns records created after the specified record; + results don't include the specified record. - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - name: Authentication - x-traitTag: true - - description: | - Create and manage authorizations (API tokens). + Use `after` instead of the `offset` parameter. + For more information about pagination parameters, see [Pagination](/influxdb/cloud/api/#tag/Pagination). + in: query + name: after + required: false + schema: + type: string + Descending: + in: query + name: descending + required: false + schema: + default: false + type: boolean + Limit: + description: | + Limits the number of records returned. Default is `20`. + in: query + name: limit + required: false + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + Offset: + description: | + The offset for pagination. + The number of records to skip. - An _authorization_ contains a list of `read` and `write` - permissions for organization resources and provides an API token for authentication. - An authorization belongs to an organization and only contains permissions for that organization. + For more information about pagination parameters, see [Pagination](/influxdb/cloud/api/#tag/Pagination). + in: query + name: offset + required: false + schema: + minimum: 0 + type: integer + SortBy: + in: query + name: sortBy + required: false + schema: + type: string + TraceSpan: + description: OpenTracing span context + example: + baggage: + key: value + span_id: '1' + trace_id: '1' + in: header + name: Zap-Trace-Span + required: false + schema: + type: string + responses: + AuthorizationError: + content: + application/json: + examples: + tokenNotAuthorized: + summary: Token is not authorized to access a resource + value: + code: unauthorized + message: unauthorized access + schema: + properties: + code: + description: | + The HTTP status code description. Default is `unauthorized`. + enum: + - unauthorized + readOnly: true + type: string + message: + description: A human-readable message that may contain detail about the error. + readOnly: true + type: string + description: | + Unauthorized. The error may indicate one of the following: - We recommend the following for managing your tokens: + * The `Authorization: Token` header is missing or malformed. + * The API token value is missing from the header. + * The token doesn't have sufficient permissions to write to this organization and bucket. + BadRequestError: + content: + application/json: + examples: + orgProvidedNotFound: + summary: The org or orgID passed doesn't own the token passed in the header + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. - - Create a generic user to create and manage tokens for writing data. - - Store your tokens in a secure password vault for future access. + #### InfluxDB OSS - ### User sessions with authorizations + - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. + GeneralServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + InternalServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + The server encountered an unexpected situation. + ResourceNotFoundError: + content: + application/json: + examples: + bucket-not-found: + summary: Bucket name not found + value: + code: not found + message: bucket "air_sensor" not found + org-not-found: + summary: Organization name not found + value: + code: not found + message: organization name "my-org" not found + orgID-not-found: + summary: Organization ID not found + value: + code: not found + message: organization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + A requested resource was not found. + The response body contains the requested resource type and the name value + (if you passed it)--for example: - Optionally, when creating an authorization, you can scope it to a specific user. - If the user signs in with username and password, creating a _user session_, - the session carries the permissions granted by all the user's authorizations. - For more information, see [how to assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/). - To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + - `"organization name \"my-org\" not found"` + - `"organization not found"`: indicates you passed an ID that did not match + an organization. + ServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + schemas: + ASTResponse: + description: Contains the AST for the supplied Flux query + properties: + ast: + $ref: '#/components/schemas/Package' + type: object + AddResourceMemberRequestBody: + properties: + id: + description: | + The ID of the user to add to the resource. + type: string + name: + description: | + The name of the user to add to the resource. + type: string + required: + - id + type: object + AnalyzeQueryResponse: + properties: + errors: + items: + properties: + character: + type: integer + column: + type: integer + line: + type: integer + message: + type: string + type: object + type: array + type: object + ArrayExpression: + description: Used to create and directly specify the elements of an array object + properties: + elements: + description: Elements of the array + items: + $ref: '#/components/schemas/Expression' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + Authorization: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + id: + description: The authorization ID. + readOnly: true + type: string + links: + example: + self: /api/v2/authorizations/1 + user: /api/v2/users/12 + properties: + self: + $ref: '#/components/schemas/Link' + readOnly: true + user: + $ref: '#/components/schemas/Link' + readOnly: true + readOnly: true + type: object + org: + description: | + The organization name. + Specifies the [organization](/influxdb/cloud/reference/glossary/#organization) + that the token is scoped to. + readOnly: true + type: string + orgID: + description: | + The organization ID. + Specifies the [organization](/influxdb/cloud/reference/glossary/#organization) that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions. + An authorization must have at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: | + The API token. + The token value is unique to the authorization. + [API tokens](/influxdb/cloud/reference/glossary/#token) are + used to authenticate and authorize InfluxDB API requests and `influx` + CLI commands--after receiving the request, InfluxDB checks that the + token is valid and that the `permissions` allow the requested action(s). + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: | + The user name. + Specifies the [user](/influxdb/cloud/reference/glossary/#user) that owns the authorization. + If the authorization is _scoped_ to a user, the user; + otherwise, the creator of the authorization. + readOnly: true + type: string + userID: + description: The user ID. Specifies the [user](/influxdb/cloud/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. + readOnly: true + type: string + type: object + required: + - orgID + - permissions + AuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: | + An organization ID. + Specifies the organization that owns the authorization. + type: string + permissions: + description: | + A list of permissions for an authorization. + In the list, provide at least one `permission` object. - ### Related endpoints + In a `permission`, the `resource.type` property grants access to all + resources of the specified type. + To grant access to only a specific resource, specify the + `resource.id` property. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + userID: + description: | + A user ID. + Specifies the user that the authorization is scoped to. - - [Signin](#tag/Signin) - - [Signout](#tag/Signout) + When a user authenticates with username and password, + InfluxDB generates a _user session_ with all the permissions + specified by all the user's authorizations. + type: string + type: object + required: + - orgID + - permissions + AuthorizationUpdateRequest: + properties: + description: + description: A description of the token. + type: string + status: + default: active + description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. + enum: + - active + - inactive + type: string + Authorizations: + properties: + authorizations: + items: + $ref: '#/components/schemas/Authorization' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + Axes: + description: The viewport for a View's visualizations + properties: + x: + $ref: '#/components/schemas/Axis' + 'y': + $ref: '#/components/schemas/Axis' + required: + - x + - 'y' + type: object + Axis: + description: Axis used in a visualization. + properties: + base: + description: Radix for formatting axis values. + enum: + - '' + - '2' + - '10' + type: string + bounds: + description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. + items: + type: string + maxItems: 2 + minItems: 0 + type: array + label: + description: Description of the axis. + type: string + prefix: + description: Label prefix for formatting axis values. + type: string + scale: + $ref: '#/components/schemas/AxisScale' + suffix: + description: Label suffix for formatting axis values. + type: string + type: object + AxisScale: + description: 'Scale is the axis formatting scale. Supported: "log", "linear"' + enum: + - log + - linear + type: string + BadStatement: + description: A placeholder for statements for which no correct statement nodes can be created + properties: + text: + description: Raw source text + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + BandViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + lowerColumn: + type: string + mainColumn: + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - band + type: string + upperColumn: + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + type: object + BinaryExpression: + description: uses binary operators to act on two operands in an expression + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Block: + description: A set of statements + properties: + body: + description: Block body + items: + $ref: '#/components/schemas/Statement' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + BooleanLiteral: + description: Represents boolean values + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: boolean + type: object + Bucket: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/buckets/1/labels + members: /api/v2/buckets/1/members + org: /api/v2/orgs/2 + owners: /api/v2/buckets/1/owners + self: /api/v2/buckets/1 + write: /api/v2/write?org=2&bucket=1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this bucket. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members that can read this bucket. + org: + $ref: '#/components/schemas/Link' + description: The URL to retrieve parent organization for this bucket. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners that can read and write to this bucket. + self: + $ref: '#/components/schemas/Link' + description: The URL for this bucket. + write: + $ref: '#/components/schemas/Link' + description: The URL to write line protocol to this bucket. + readOnly: true + type: object + name: + type: string + orgID: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + type: + default: user + enum: + - user + - system + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - retentionRules + Buckets: + properties: + buckets: + items: + $ref: '#/components/schemas/Bucket' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + BuilderAggregateFunctionType: + enum: + - filter + - group + type: string + BuilderConfig: + properties: + aggregateWindow: + properties: + fillValues: + type: boolean + period: + type: string + type: object + buckets: + items: + type: string + type: array + functions: + items: + $ref: '#/components/schemas/BuilderFunctionsType' + type: array + tags: + items: + $ref: '#/components/schemas/BuilderTagsType' + type: array + type: object + BuilderFunctionsType: + properties: + name: + type: string + type: object + BuilderTagsType: + properties: + aggregateFunctionType: + $ref: '#/components/schemas/BuilderAggregateFunctionType' + key: + type: string + values: + items: + type: string + type: array + type: object + BuiltinStatement: + description: Declares a builtin identifier and its type + properties: + id: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + CallExpression: + description: Represents a function call + properties: + arguments: + description: Function arguments + items: + $ref: '#/components/schemas/Expression' + type: array + callee: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Cell: + properties: + h: + format: int32 + type: integer + id: + type: string + links: + properties: + self: + type: string + view: + type: string + type: object + viewID: + description: The reference to a view from the views API. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellUpdate: + properties: + h: + format: int32 + type: integer + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellWithViewProperties: + allOf: + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object + type: object + Cells: + items: + $ref: '#/components/schemas/Cell' + type: array + CellsWithViewProperties: + items: + $ref: '#/components/schemas/CellWithViewProperties' + type: array + Check: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + CheckBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the check. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/checks/1/labels + members: /api/v2/checks/1/members + owners: /api/v2/checks/1/owners + query: /api/v2/checks/1/query + self: /api/v2/checks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this check. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this check. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this check. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this check. + self: + $ref: '#/components/schemas/Link' + description: The URL for this check. + readOnly: true + type: object + name: + type: string + orgID: + description: The ID of the organization that owns this check. + type: string + ownerID: + description: The ID of creator used to create this check. + readOnly: true + type: string + query: + $ref: '#/components/schemas/DashboardQuery' + status: + $ref: '#/components/schemas/TaskStatusType' + taskID: + description: The ID of the task associated with this check. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - orgID + - query + CheckDiscriminator: + discriminator: + mapping: + custom: '#/components/schemas/CustomCheck' + deadman: '#/components/schemas/DeadmanCheck' + threshold: '#/components/schemas/ThresholdCheck' + propertyName: type + oneOf: + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' + CheckPatch: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + CheckStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + type: string + CheckViewProperties: + properties: + adaptiveZoomHide: + type: boolean + check: + $ref: '#/components/schemas/Check' + checkID: + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - check + type: string + required: + - type + - shape + - checkID + - queries + - colors + type: object + Checks: + properties: + checks: + items: + $ref: '#/components/schemas/Check' + type: array + links: + $ref: '#/components/schemas/Links' + ColorMapping: + additionalProperties: + type: string + description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. + example: + configcat_deployments-autopromotionblocker: '#663cd0' + measurement_birdmigration_europe: '#663cd0' + series_id_1: '#edf529' + series_id_2: '#edf529' + type: object + ColumnDataType: + enum: + - integer + - float + - boolean + - string + - unsigned + type: string + ColumnSemanticType: + enum: + - timestamp + - tag + - field + nullable: false + type: string + ConditionalExpression: + description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` + properties: + alternate: + $ref: '#/components/schemas/Expression' + consequent: + $ref: '#/components/schemas/Expression' + test: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + ConstantVariableProperties: + properties: + type: + enum: + - constant + type: string + values: + items: + type: string + type: array + CreateCell: + properties: + h: + format: int32 + type: integer + name: + type: string + usingView: + description: Makes a copy of the provided view. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CreateDashboardRequest: + properties: + description: + description: The user-facing description of the dashboard. + type: string + name: + description: The user-facing name of the dashboard. + type: string + orgID: + description: The ID of the organization that owns the dashboard. + type: string + required: + - orgID + - name + CustomCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object + DBRP: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + If set to `true`, this DBRP mapping is the default retention policy + for the database (specified by the `database` property's value). + type: boolean + id: + description: | + The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. + readOnly: true + type: string + links: + $ref: '#/components/schemas/Links' + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + virtual: + description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. + type: boolean + required: + - id + - orgID + - bucketID + - database + - retention_policy + - default + type: object + DBRPCreate: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + type: boolean + org: + description: | + An organization name. + Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. + type: string + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + required: + - bucketID + - database + - retention_policy + type: object + DBRPGet: + properties: + content: + $ref: '#/components/schemas/DBRP' + required: true + type: object + DBRPUpdate: + properties: + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + To remove the default mapping, set to `false`. + type: boolean + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + DBRPs: + properties: + content: + items: + $ref: '#/components/schemas/DBRP' + type: array + Dashboard: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/Cells' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + DashboardColor: + description: Defines an encoding of data value into color space. + properties: + hex: + description: The hex number of the color + maxLength: 7 + minLength: 7 + type: string + id: + description: The unique ID of the view color. + type: string + name: + description: The user-facing name of the hex color. + type: string + type: + description: Type is how the color is used. + enum: + - min + - max + - threshold + - scale + - text + - background + type: string + value: + description: The data value mapped to this color. + format: float + type: number + required: + - id + - type + - hex + - name + - value + type: object + DashboardQuery: + properties: + builderConfig: + $ref: '#/components/schemas/BuilderConfig' + editMode: + $ref: '#/components/schemas/QueryEditMode' + name: + type: string + text: + description: The text of the Flux query. + type: string + type: object + DashboardWithViewProperties: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/CellsWithViewProperties' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + Dashboards: + properties: + dashboards: + items: + $ref: '#/components/schemas/Dashboard' + type: array + links: + $ref: '#/components/schemas/Links' + type: object + DateTimeLiteral: + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp). + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + format: date-time + type: string + type: object + DeadmanCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + level: + $ref: '#/components/schemas/CheckStatusLevel' + offset: + description: Duration to delay after the schedule, before executing check. + type: string + reportZero: + description: If only zero values reported since time, trigger an alert + type: boolean + staleTime: + description: String duration for time that a series is considered stale and should not trigger deadman. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + timeSince: + description: String duration before deadman triggers. + type: string + type: + enum: + - deadman + type: string + required: + - type + type: object + DecimalPlaces: + description: Indicates whether decimal places should be enforced, and how many digits it should show. + properties: + digits: + description: The number of digits after decimal to display + format: int32 + type: integer + isEnforced: + description: Indicates whether decimal point setting should be enforced + type: boolean + type: object + DeletePredicateRequest: + description: The delete predicate request. + properties: + predicate: + description: | + An expression in [delete predicate syntax](/influxdb/cloud/reference/syntax/delete-predicate/). + example: tag1="value1" and (tag2="value2" and tag3!="value3") + type: string + start: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)). + The earliest time to delete from. + format: date-time + type: string + stop: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)). + The latest time to delete from. + format: date-time + type: string + required: + - start + - stop + type: object + Dialect: + description: | + Options for tabular data output. + Default output is [annotated CSV](/influxdb/cloud/reference/syntax/annotated-csv/#csv-response-format) with headers. - ### Related guides + For more information about tabular data **dialect**, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). + properties: + annotations: + description: | + Annotation rows to include in the results. + An _annotation_ is metadata associated with an object (column) in the data model. - - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/cloud/security/tokens/) - - [Assign a token to a specific user](/influxdb/cloud/security/tokens/create-token/) - name: Authorizations (API tokens) - - name: Bucket Schemas - - description: | - Store your data in InfluxDB [buckets](/influxdb/cloud/reference/glossary/#bucket). - A bucket is a named location where time series data is stored. All buckets - have a [retention period](/influxdb/cloud/reference/glossary/#retention-period), - a duration of time that each data point persists. InfluxDB drops all - points with timestamps older than the bucket’s retention period. - A bucket belongs to an organization. + #### Related guides - ### Related guides + - See [Annotated CSV annotations](/influxdb/cloud/reference/syntax/annotated-csv/#annotations) for examples and more information. - - [Manage buckets](/influxdb/cloud/organizations/buckets/) - name: Buckets - - name: Cells - - name: Checks - - description: | - To specify resources, some InfluxDB API endpoints require parameters or - properties in the request--for example, - writing to a `bucket` resource in an `org` (_organization_ resource). + For more information about **annotations** in tabular data, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). + items: + enum: + - group + - datatype + - default + type: string + type: array + uniqueItems: true + commentPrefix: + default: '#' + description: The character prefixed to comment strings. Default is a number sign (`#`). + maxLength: 1 + minLength: 0 + type: string + dateTimeFormat: + default: RFC3339 + description: | + The format for timestamps in results. + Default is [`RFC3339` date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp). + To include nanoseconds in timestamps, use `RFC3339Nano`. - ### Common parameters + #### Example formatted date/time values - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). | - | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/cloud/organizations/buckets/view-buckets/). | - | `org` | string | The organization name or ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). | - | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/cloud/organizations/view-orgs/). | - name: Common parameters - x-traitTag: true - - name: Config - - name: Dashboards - - name: Data I/O endpoints - - description: | - The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) - and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). - InfluxDB 2.x replaces databases and retention policies with buckets. - To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, - databases and retention policies are mapped to buckets using the - database and retention policy (DBRP) mapping service. - The DBRP mapping service uses the database and retention policy - specified in 1.x compatibility API requests to route operations to a bucket. + | Format | Value | + |:------------|:----------------------------| + | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | + | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | + enum: + - RFC3339 + - RFC3339Nano + type: string + delimiter: + default: ',' + description: The separator used between cells. Default is a comma (`,`). + maxLength: 1 + minLength: 1 + type: string + header: + default: true + description: If true, the results contain a header row. + type: boolean + type: object + DictExpression: + description: Used to create and directly specify the elements of a dictionary + properties: + elements: + description: Elements of the dictionary + items: + $ref: '#/components/schemas/DictItem' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + DictItem: + description: A key-value pair in a dictionary. + properties: + key: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + val: + $ref: '#/components/schemas/Expression' + type: object + Duration: + description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. + properties: + magnitude: + type: integer + type: + $ref: '#/components/schemas/NodeType' + unit: + type: string + type: object + DurationLiteral: + description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration + properties: + type: + $ref: '#/components/schemas/NodeType' + values: + description: Duration values + items: + $ref: '#/components/schemas/Duration' + type: array + type: object + Error: + properties: + code: + $ref: '#/components/schemas/ErrorCode' + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + ErrorCode: + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + Expression: + oneOf: + - $ref: '#/components/schemas/ArrayExpression' + - $ref: '#/components/schemas/DictExpression' + - $ref: '#/components/schemas/FunctionExpression' + - $ref: '#/components/schemas/BinaryExpression' + - $ref: '#/components/schemas/CallExpression' + - $ref: '#/components/schemas/ConditionalExpression' + - $ref: '#/components/schemas/LogicalExpression' + - $ref: '#/components/schemas/MemberExpression' + - $ref: '#/components/schemas/IndexExpression' + - $ref: '#/components/schemas/ObjectExpression' + - $ref: '#/components/schemas/ParenExpression' + - $ref: '#/components/schemas/PipeExpression' + - $ref: '#/components/schemas/UnaryExpression' + - $ref: '#/components/schemas/BooleanLiteral' + - $ref: '#/components/schemas/DateTimeLiteral' + - $ref: '#/components/schemas/DurationLiteral' + - $ref: '#/components/schemas/FloatLiteral' + - $ref: '#/components/schemas/IntegerLiteral' + - $ref: '#/components/schemas/PipeLiteral' + - $ref: '#/components/schemas/RegexpLiteral' + - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/UnsignedIntegerLiteral' + - $ref: '#/components/schemas/Identifier' + ExpressionStatement: + description: May consist of an expression that doesn't return a value and is executed solely for its side-effects + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Field: + properties: + alias: + description: Alias overrides the field name in the returned response. Applies only if type is `func` + type: string + args: + description: Args are the arguments to the function + items: + $ref: '#/components/schemas/Field' + type: array + type: + description: '`type` describes the field type. `func` is a function. `field` is a field reference.' + enum: + - func + - field + - integer + - number + - regex + - wildcard + type: string + value: + description: value is the value of the field. Meaning of the value is implied by the `type` key + type: string + type: object + File: + description: Represents a source from a single file + properties: + body: + description: List of Flux statements + items: + $ref: '#/components/schemas/Statement' + type: array + imports: + description: A list of package imports + items: + $ref: '#/components/schemas/ImportDeclaration' + type: array + name: + description: The name of the file. + type: string + package: + $ref: '#/components/schemas/PackageClause' + type: + $ref: '#/components/schemas/NodeType' + type: object + Flags: + additionalProperties: true + type: object + FloatLiteral: + description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: number + type: object + FluxResponse: + description: Rendered flux that backs the check or notification. + properties: + flux: + type: string + FluxSuggestion: + properties: + name: + type: string + params: + additionalProperties: + type: string + type: object + type: object + FluxSuggestions: + properties: + funcs: + items: + $ref: '#/components/schemas/FluxSuggestion' + type: array + type: object + FunctionExpression: + description: Function expression + properties: + body: + $ref: '#/components/schemas/Node' + params: + description: Function parameters + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + GaugeViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - gauge + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + GeoCircleViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Circle color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + interpolateColors: + description: Interpolate circle color based on displayed value + type: boolean + radius: + description: Maximum radius size in pixels + type: integer + radiusDimension: + $ref: '#/components/schemas/Axis' + radiusField: + description: Radius field + type: string + required: + - radiusField + - radiusDimension + - colorField + - colorDimension + - colors + type: object + GeoHeatMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + blur: + description: Blur for heatmap points + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + intensityDimension: + $ref: '#/components/schemas/Axis' + intensityField: + description: Intensity field + type: string + radius: + description: Radius size in pixels + type: integer + required: + - intensityField + - intensityDimension + - radius + - blur + - colors + type: object + GeoPointMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + isClustered: + description: Cluster close markers together + type: boolean + tooltipColumns: + description: An array for which columns to display in tooltip + items: + type: string + type: array + required: + - colorField + - colorDimension + - colors + type: object + GeoTrackMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + randomColors: + description: Assign different colors to different tracks + type: boolean + speed: + description: Speed of the track animation + type: integer + trackWidth: + description: Width of the track + type: integer + GeoViewLayer: + oneOf: + - $ref: '#/components/schemas/GeoCircleViewLayer' + - $ref: '#/components/schemas/GeoHeatMapViewLayer' + - $ref: '#/components/schemas/GeoPointMapViewLayer' + - $ref: '#/components/schemas/GeoTrackMapViewLayer' + type: object + GeoViewLayerProperties: + properties: + type: + enum: + - heatmap + - circleMap + - pointMap + - trackMap + type: string + required: + - type + type: object + GeoViewProperties: + properties: + allowPanAndZoom: + default: true + description: If true, map zoom and pan controls are enabled on the dashboard view + type: boolean + center: + description: Coordinates of the center of the map + properties: + lat: + description: Latitude of the center of the map + format: double + type: number + lon: + description: Longitude of the center of the map + format: double + type: number + required: + - lat + - lon + type: object + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + detectCoordinateFields: + default: true + description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns + type: boolean + latLonColumns: + $ref: '#/components/schemas/LatLonColumns' + layers: + description: List of individual layers shown in the map + items: + $ref: '#/components/schemas/GeoViewLayer' + type: array + mapStyle: + description: Define map type - regular, satellite etc. + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + s2Column: + description: String to define the column + type: string + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - geo + type: string + useS2CellID: + description: If true, S2 column is used to calculate lat/lon + type: boolean + zoom: + description: Zoom level used for initial display of the map + format: double + maximum: 28 + minimum: 1 + type: number + required: + - type + - shape + - queries + - note + - showNoteWhenEmpty + - center + - zoom + - allowPanAndZoom + - detectCoordinateFields + - layers + type: object + GreaterThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - greater + type: string + value: + format: float + type: number + required: + - type + - value + type: object + HTTPNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer + type: string + contentTemplate: + type: string + headers: + additionalProperties: + type: string + description: Customized headers. + type: object + method: + enum: + - POST + - GET + - PUT + type: string + password: + type: string + token: + type: string + url: + type: string + username: + type: string + required: + - url + - authMethod + - method + type: object + type: object + HTTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' + HTTPNotificationRuleBase: + properties: + type: + enum: + - http + type: string + url: + type: string + required: + - type + type: object + HealthCheck: + properties: + checks: + items: + $ref: '#/components/schemas/HealthCheck' + type: array + commit: + type: string + message: + type: string + name: + type: string + status: + enum: + - pass + - fail + type: string + version: + type: string + required: + - name + - status + type: object + HeatmapViewProperties: + properties: + adaptiveZoomHide: + type: boolean + binSize: + type: number + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - heatmap + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize + type: object + HistogramViewProperties: + properties: + binCount: + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + fillColumns: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - histogram + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + format: float + type: number + type: array + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount + type: object + Identifier: + description: A valid Flux identifier + properties: + name: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + ImportDeclaration: + description: Declares a package import + properties: + as: + $ref: '#/components/schemas/Identifier' + path: + $ref: '#/components/schemas/StringLiteral' + type: + $ref: '#/components/schemas/NodeType' + type: object + IndexExpression: + description: Represents indexing into an array + properties: + array: + $ref: '#/components/schemas/Expression' + index: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + InfluxqlCsvResponse: + description: CSV Response to InfluxQL Query + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + type: string + InfluxqlJsonResponse: + description: JSON Response to InfluxQL Query + properties: + results: + items: + properties: + error: + type: string + series: + items: + properties: + columns: + items: + type: string + type: array + name: + type: string + partial: + type: boolean + tags: + additionalProperties: + type: string + type: object + values: + items: + items: {} + type: array + type: array + type: object + type: array + statement_id: + type: integer + type: object + type: array + type: object + IntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + IsOnboarding: + properties: + allowed: + description: | + If `true`, the InfluxDB instance hasn't had initial setup; + `false` otherwise. + type: boolean + type: object + Label: + properties: + id: + readOnly: true + type: string + name: + type: string + orgID: + readOnly: true + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + type: object + LabelCreateRequest: + properties: + name: + type: string + orgID: + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. - ### Related guides + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + required: + - orgID + - name + type: object + LabelMapping: + description: A _label mapping_ contains a `label` ID to attach to a resource. + properties: + labelID: + description: | + A label ID. + Specifies the label to attach. + type: string + required: + - labelID + type: object + LabelResponse: + properties: + label: + $ref: '#/components/schemas/Label' + links: + $ref: '#/components/schemas/Links' + type: object + LabelUpdate: + properties: + name: + type: string + properties: + additionalProperties: + description: | + Key-value pairs associated with this label. - - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) - name: DBRPs - - description: | - Delete data from an InfluxDB bucket. - name: Delete - - description: | - InfluxDB HTTP API endpoints use standard HTTP request and response headers. - The following table shows common headers used by many InfluxDB API endpoints. - Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + To remove a property, send an update with an empty value (`""`) for the key. + type: string + example: + color: ffb3b3 + description: this is a description + type: object + type: object + Labels: + items: + $ref: '#/components/schemas/Label' + type: array + LabelsResponse: + properties: + labels: + $ref: '#/components/schemas/Labels' + links: + $ref: '#/components/schemas/Links' + type: object + LanguageRequest: + description: Flux query to be analyzed. + properties: + query: + description: | + The Flux query script to be analyzed. + type: string + required: + - query + type: object + LatLonColumn: + description: Object type for key and column definitions + properties: + column: + description: Column to look up Lat/Lon + type: string + key: + description: Key to determine whether the column is tag/field + type: string + required: + - key + - column + type: object + LatLonColumns: + description: Object type to define lat/lon columns + properties: + lat: + $ref: '#/components/schemas/LatLonColumn' + lon: + $ref: '#/components/schemas/LatLonColumn' + required: + - lat + - lon + type: object + LegacyAuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: The organization ID. Identifies the organization that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions that provide `read` and `write` access to organization resources. + An authorization must contain at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: The name that you provide for the authorization. + type: string + userID: + description: The user ID. Identifies the user that the authorization is scoped to. + type: string + type: object + required: + - orgID + - permissions + LesserThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - lesser + type: string + value: + format: float + type: number + required: + - type + - value + type: object + Limit: + description: These are org limits similar to those configured in/by quartz. + properties: + bucket: + properties: + maxBuckets: + type: integer + maxRetentionDuration: + description: Max bucket retention duration in nanoseconds. 0 is unlimited. + type: integer + required: + - maxBuckets + - maxRetentionDuration + type: object + check: + properties: + maxChecks: + type: integer + required: + - maxChecks + type: object + dashboard: + properties: + maxDashboards: + type: integer + required: + - maxDashboards + type: object + features: + properties: + allowDelete: + description: allow delete predicate endpoint + type: boolean + type: object + notificationEndpoint: + properties: + blockedNotificationEndpoints: + description: comma separated list of notification endpoints + example: http,pagerduty + type: string + required: + - blockNotificationEndpoints + type: object + notificationRule: + properties: + blockedNotificationRules: + description: comma separated list of notification rules + example: http,pagerduty + type: string + maxNotifications: + type: integer + required: + - maxNotifications + - blockNotificationRules + type: object + orgID: + type: string + rate: + properties: + cardinality: + description: Allowed organization total cardinality. 0 is unlimited. + type: integer + concurrentDeleteRequests: + description: Allowed organization concurrent outstanding delete requests. + type: integer + concurrentReadRequests: + description: Allowed concurrent queries. 0 is unlimited. + type: integer + concurrentWriteRequests: + description: Allowed concurrent writes. 0 is unlimited. + type: integer + deleteRequestsPerSecond: + description: Allowed organization delete request rate. + type: integer + queryTime: + description: Query Time in nanoseconds + type: integer + readKBs: + description: Query limit in kb/sec. 0 is unlimited. + type: integer + writeKBs: + description: Write limit in kb/sec. 0 is unlimited. + type: integer + required: + - readKBs + - queryTime + - concurrentReadRequests + - writeKBs + - concurrentWriteRequests + - cardinality + type: object + stack: + properties: + enabled: + type: boolean + required: + - enabled + type: object + task: + properties: + maxTasks: + type: integer + required: + - maxTasks + type: object + timeout: + properties: + queryUnconditionalTimeoutSeconds: + type: integer + queryidleWriteTimeoutSeconds: + type: integer + required: + - queryUnconditionalTimeoutSeconds + - queryidleWriteTimeoutSeconds + type: object + required: + - rate + - bucket + - task + - dashboard + - check + - notificationRule + - notificationEndpoint + type: object + LinePlusSingleStatProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + timeFormat: + type: string + type: + enum: + - line-plus-single-stat + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - prefix + - suffix + - decimalPlaces + - position + type: object + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - invalid + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + required: + - code + - message + Link: + description: URI of resource. + format: uri + readOnly: true + type: string + Links: + description: | + URI pointers for additional paged results. + properties: + next: + $ref: '#/components/schemas/Link' + prev: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + required: + - self + type: object + LogEvent: + properties: + message: + description: A description of the event that occurred. + example: Halt and catch fire + readOnly: true + type: string + runID: + description: The ID of the task run that generated the event. + readOnly: true + type: string + time: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + type: object + LogicalExpression: + description: Represents the rule conditions that collectively evaluate to either true or false + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Logs: + properties: + events: + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + type: object + MapVariableProperties: + properties: + type: + enum: + - map + type: string + values: + additionalProperties: + type: string + type: object + MarkdownViewProperties: + properties: + note: + type: string + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - markdown + type: string + required: + - type + - shape + - note + type: object + MeasurementSchema: + description: Definition of a measurement schema. + example: + bucketID: ba3c5e7f9b0a0010 + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + bucketID: + description: The ID of the bucket that the measurement schema is associated with. + type: string + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + createdAt: + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: string + name: + nullable: false + type: string + orgID: + description: The ID of the organization. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - columns + - createdAt + - updatedAt + type: object + MeasurementSchemaColumn: + description: Definition of a measurement schema column. + example: + format: unix timestamp + name: time + type: integer + properties: + dataType: + $ref: '#/components/schemas/ColumnDataType' + name: + type: string + type: + $ref: '#/components/schemas/ColumnSemanticType' + required: + - name + - type + type: object + MeasurementSchemaCreateRequest: + description: Create a new measurement schema. + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + name: cpu + properties: + columns: + description: Ordered collection of column definitions. + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + name: + description: | + The [measurement](/influxdb/cloud/reference/glossary/#measurement) + name. + type: string + required: + - name + - columns + type: object + MeasurementSchemaList: + description: A list of measurement schemas returning summary information + example: + measurementSchemas: + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8642 + name: cpu + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8643 + name: memory + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + - bucketID: ba3c5e7f9b0a0010 + createdAt: '2021-01-21T00:48:40.993Z' + id: 1a3c5e7f9b0a8644 + name: disk + orgID: 0a3c5e7f9b0a0001 + updatedAt: '2021-01-21T00:48:40.993Z' + properties: + measurementSchemas: + items: + $ref: '#/components/schemas/MeasurementSchema' + type: array + required: + - measurementSchemas + type: object + MeasurementSchemaUpdateRequest: + description: Update an existing measurement schema + example: + columns: + - format: unix timestamp + name: time + type: integer + - name: host + type: tag + - name: region + type: tag + - dataType: float + name: usage_user + type: field + - dataType: float + name: usage_user + type: field + properties: + columns: + description: An ordered collection of column definitions + items: + $ref: '#/components/schemas/MeasurementSchemaColumn' + type: array + required: + - columns + type: object + MemberAssignment: + description: Object property assignment + properties: + init: + $ref: '#/components/schemas/Expression' + member: + $ref: '#/components/schemas/MemberExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + MemberExpression: + description: Represents accessing a property of an object + properties: + object: + $ref: '#/components/schemas/Expression' + property: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + type: object + MosaicViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - mosaic + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yLabelColumnSeparator: + type: string + yLabelColumns: + items: + type: string + type: array + yPrefix: + type: string + ySeriesColumns: + items: + type: string + type: array + ySuffix: + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - ySeriesColumns + - fillColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + Node: + oneOf: + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' + NodeType: + description: Type of AST node + type: string + NotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + NotificationEndpointBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification endpoint. + type: string + id: + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/notificationEndpoints/1/labels + members: /api/v2/notificationEndpoints/1/members + owners: /api/v2/notificationEndpoints/1/owners + self: /api/v2/notificationEndpoints/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this endpoint. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this endpoint. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this endpoint. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + type: string + orgID: + type: string + status: + default: active + description: The status of the endpoint. + enum: + - active + - inactive + type: string + type: + $ref: '#/components/schemas/NotificationEndpointType' + updatedAt: + format: date-time + readOnly: true + type: string + userID: + type: string + required: + - type + - name + type: object + NotificationEndpointDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationEndpoint' + pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' + slack: '#/components/schemas/SlackNotificationEndpoint' + telegram: '#/components/schemas/TelegramNotificationEndpoint' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' + NotificationEndpointType: + enum: + - slack + - pagerduty + - http + - telegram + type: string + NotificationEndpointUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationEndpoints: + properties: + links: + $ref: '#/components/schemas/Links' + notificationEndpoints: + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + NotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + NotificationRuleBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification rule. + type: string + endpointID: + type: string + every: + description: The notification repetition interval. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + limit: + description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. + type: integer + limitEvery: + description: Don't notify me more than times every seconds. If set, limit cannot be empty. + type: integer + links: + example: + labels: /api/v2/notificationRules/1/labels + members: /api/v2/notificationRules/1/members + owners: /api/v2/notificationRules/1/owners + query: /api/v2/notificationRules/1/query + self: /api/v2/notificationRules/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this notification rule. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this notification rule. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this notification rule. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this notification rule. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + description: Human-readable name describing the notification rule. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + orgID: + description: The ID of the organization that owns this notification rule. + type: string + ownerID: + description: The ID of creator used to create this notification rule. + readOnly: true + type: string + runbookLink: + type: string + sleepUntil: + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + statusRules: + description: List of status rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/StatusRule' + minItems: 1 + type: array + tagRules: + description: List of tag rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/TagRule' + type: array + taskID: + description: The ID of the task associated with this notification rule. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - orgID + - status + - name + - statusRules + - endpointID + type: object + NotificationRuleDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationRule' + pagerduty: '#/components/schemas/PagerDutyNotificationRule' + slack: '#/components/schemas/SlackNotificationRule' + smtp: '#/components/schemas/SMTPNotificationRule' + telegram: '#/components/schemas/TelegramNotificationRule' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' + NotificationRuleUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationRules: + properties: + links: + $ref: '#/components/schemas/Links' + notificationRules: + items: + $ref: '#/components/schemas/NotificationRule' + type: array + ObjectExpression: + description: Allows the declaration of an anonymous object within a declaration + properties: + properties: + description: Object properties + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + OnboardingRequest: + properties: + bucket: + type: string + limit: + $ref: '#/components/schemas/Limit' + org: + type: string + password: + type: string + retentionPeriodHrs: + deprecated: true + type: integer + retentionPeriodSeconds: + type: integer + username: + type: string + required: + - username + - org + - bucket + type: object + OnboardingResponse: + properties: + auth: + $ref: '#/components/schemas/Authorization' + bucket: + $ref: '#/components/schemas/Bucket' + org: + $ref: '#/components/schemas/Organization' + user: + $ref: '#/components/schemas/UserResponse' + type: object + OptionStatement: + description: A single variable declaration + properties: + assignment: + oneOf: + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Organization: + properties: + createdAt: + format: date-time + readOnly: true + type: string + defaultStorageType: + description: Discloses whether the organization uses TSM or IOx. + enum: + - tsm + - iox + type: string + description: + type: string + id: + readOnly: true + type: string + links: + example: + buckets: /api/v2/buckets?org=myorg + dashboards: /api/v2/dashboards?org=myorg + labels: /api/v2/orgs/1/labels + members: /api/v2/orgs/1/members + owners: /api/v2/orgs/1/owners + secrets: /api/v2/orgs/1/secrets + self: /api/v2/orgs/1 + tasks: /api/v2/tasks?org=myorg + properties: + buckets: + $ref: '#/components/schemas/Link' + dashboards: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + secrets: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + tasks: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + type: string + status: + default: active + description: If inactive, the organization is inactive. + enum: + - active + - inactive + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + Organizations: + properties: + links: + $ref: '#/components/schemas/Links' + orgs: + items: + $ref: '#/components/schemas/Organization' + type: array + type: object + Package: + description: Represents a complete package source tree. + properties: + files: + description: Package files + items: + $ref: '#/components/schemas/File' + type: array + package: + description: Package name + type: string + path: + description: Package import path + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + PackageClause: + description: Defines a package identifier + properties: + name: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + PagerDutyNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + clientURL: + type: string + routingKey: + type: string + required: + - routingKey + type: object + type: object + PagerDutyNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' + PagerDutyNotificationRuleBase: + properties: + messageTemplate: + type: string + type: + enum: + - pagerduty + type: string + required: + - type + - messageTemplate + type: object + Params: + properties: + params: + additionalProperties: + enum: + - any + - bool + - duration + - float + - int + - string + - time + - uint + type: string + description: | + The `params` keys and value type defined in the script. + type: object + type: object + ParenExpression: + description: Represents an expression wrapped in parenthesis + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PasswordResetBody: + properties: + password: + type: string + required: + - password + PatchBucketRequest: + description: | + An object that contains updated bucket properties to apply. + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The name of the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/PatchRetentionRules' + type: object + PatchOrganizationRequest: + description: | + An object that contains updated organization properties to apply. + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + type: object + PatchRetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The number of seconds to keep data. + Default duration is `2592000` (30 days). + `0` represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The [shard group duration](/influxdb/cloud/reference/glossary/#shard). + The number of seconds that each shard group covers. - | Header | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `Accept` | string | The content type that the client can understand. | - | `Authorization` | string | The authorization scheme and credential. | - | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | - | `Content-Type` | string | The format of the data in the request body. | - name: Headers - x-traitTag: true - - description: | - Store, manage, and execute scripts in InfluxDB. - A script stores your custom Flux script and provides an invokable - endpoint that accepts runtime parameters. - In a script, you can specify custom runtime parameters - (`params`)--for example, `params.myparameter`. - Once you create a script, InfluxDB generates an - [`/api/v2/scripts/SCRIPT_ID/invoke` endpoint](#operation/PostScriptsIDInvoke) - for your organization. - You can run the script from API requests and tasks, defining parameter - values for each run. - When the script runs, InfluxDB replaces `params` references in the - script with the runtime parameter values you define. + #### InfluxDB Cloud - Use the `/api/v2/scripts` endpoints to create and manage scripts. - See related guides to learn how to define parameters and execute scripts. + - Doesn't use `shardGroupDurationsSeconds`. - ### Related guides + #### InfluxDB OSS - - [Invoke custom scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) from API requests. - - [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script) - name: Invokable Scripts - - name: Labels - - name: Legacy Authorizations - - name: Legacy Query - - name: Legacy Write - - name: Limits - - name: NotificationEndpoints - - name: NotificationRules - - description: | - Manage your [organization](/influxdb/cloud/reference/glossary/#organization). - An organization is a workspace for a group of users. Organizations can be - used to separate different environments, projects, teams or users within - InfluxDB. + - Default value depends on the [bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration). - Use the `/api/v2/orgs` endpoints to view and manage organizations. - name: Organizations - - description: | - Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + #### Related guides - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `limit` | integer | The maximum number of records to return (after other parameters are applied). | - | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | - | `after` | string (resource ID) | Only returns resources created after the specified resource. | + - InfluxDB [shards and shard groups](/influxdb/cloud/reference/internals/shards/) + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + PatchRetentionRules: + description: Updates to rules to expire or retain data. No rules means no updates. + items: + $ref: '#/components/schemas/PatchRetentionRule' + type: array + Permission: + properties: + action: + enum: + - read + - write + type: string + resource: + $ref: '#/components/schemas/Resource' + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + required: + - action + - resource + PipeExpression: + description: Call expression with pipe argument + properties: + argument: + $ref: '#/components/schemas/Expression' + call: + $ref: '#/components/schemas/CallExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PipeLiteral: + description: Represents a specialized literal value, indicating the left hand value of a pipe expression + properties: + type: + $ref: '#/components/schemas/NodeType' + type: object + PostBucketRequest: + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The bucket name. + type: string + orgID: + description: | + The organization ID. + Specifies the organization that owns the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + default: '0' + description: | + The retention policy for the bucket. + For InfluxDB 1.x, specifies the duration of time that each data point + in the retention policy persists. - ### Limitations + If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; + otherwise, see the `retentionRules` property. - - For specific endpoint parameters and examples, see the endpoint definition. - - If you specify an `offset` parameter value greater than the total number of records, - then InfluxDB returns an empty list in the response - (given `offset` skips the specified number of records). + [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) + is an InfluxDB 1.x concept. + The InfluxDB 2.x and Cloud equivalent is + [retention period](/influxdb/cloud/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + description: | + The schema Type. Default is `implicit`. - The following example passes `offset=50` to skip the first 50 results, - but the user only has 10 buckets: + #### InfluxDB Cloud - ```sh - curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ - --header "Authorization: Token INFLUX_API_TOKEN" - ``` + - Use `explicit` to enforce column names, tags, fields, and data types for + your data. - The response contains the following: + #### InfluxDB OSS - ```json - { - "links": { - "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", - "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" - }, - "buckets": [] - } - ``` - name: Pagination - x-traitTag: true - - name: Ping - - description: | - Retrieve data, analyze queries, and get query suggestions. - name: Query - - 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. + - Doesn't support `explicit` bucket schemas. + required: + - orgID + - name + PostCheck: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + PostNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + PostNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + PostOrganizationRequest: + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + required: + - name + type: object + Property: + description: The value associated with a key + properties: + key: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + value: + $ref: '#/components/schemas/Expression' + type: object + PropertyKey: + oneOf: + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' + Query: + description: Query InfluxDB with the Flux language + properties: + dialect: + $ref: '#/components/schemas/Dialect' + extern: + $ref: '#/components/schemas/File' + now: + description: | + Specifies the time that should be reported as `now` in the query. + Default is the server `now` time. + format: date-time + type: string + params: + additionalProperties: true + description: | + Key-value pairs passed as parameters during query execution. - [**InfluxDB API client libraries**](/influxdb/cloud/api-guide/client-libraries/) - are available for popular languages and ready to import into your application. - name: Quick start - x-traitTag: true - - name: Resources - - description: | - InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. - The response body may include additional details. - For details about a specific operation's response, - see **Responses** and **Response Samples** for that operation. + To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example: - API operations may return the following HTTP status codes: + ```json + query: "from(bucket: params.mybucket)\ + |> range(start: params.rangeStart) |> limit(n:1)" + ``` - |  Code  | Status | Description | - |:-----------:|:------------------------ |:--------------------- | - | `200` | Success | | - | `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. | - | `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.
| - | `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/)
| - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `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`. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | - | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | - | `500` | Internal server error | | - | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | - name: Response codes - x-traitTag: true - - name: Routes - - name: Rules - - name: Secrets - - name: Security and access endpoints - - name: Setup - - name: Signin - - name: Signout - - 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" - name: Supported operations - x-traitTag: true - - name: System information endpoints - - description: | - Process and analyze your data with [tasks](/influxdb/cloud/reference/glossary/#task) - in the InfluxDB task engine. - Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + and pass _`params`_ with the key-value pairs--for example: - 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). + ```json + params: { + "mybucket": "environment", + "rangeStart": "-30d" + } + ``` - + During query execution, InfluxDB passes _`params`_ to your script and substitutes the values. - ### Properties + #### Limitations - A `task` object contains information about an InfluxDB task resource. + - If you use _`params`_, you can't use _`extern`_. + type: object + query: + description: The query script to execute. + type: string + type: + description: The type of query. Must be "flux". + enum: + - flux + type: string + required: + - query + type: object + QueryEditMode: + enum: + - builder + - advanced + type: string + QueryVariableProperties: + properties: + type: + enum: + - query + type: string + values: + properties: + language: + type: string + query: + type: string + type: object + RangeThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + max: + format: float + type: number + min: + format: float + type: number + type: + enum: + - range + type: string + within: + type: boolean + required: + - type + - min + - max + - within + type: object + Ready: + properties: + started: + example: '2019-03-13T10:09:33.891196-04:00' + format: date-time + type: string + status: + enum: + - ready + type: string + up: + example: 14m45.911966424s + type: string + type: object + RegexpLiteral: + description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + RenamableField: + description: Describes a field that can be renamed and made visible or invisible. + properties: + displayName: + description: The name that a field is renamed to by the user. + type: string + internalName: + description: The calculated name of a field. + readOnly: true + type: string + visible: + description: Indicates whether this field should be visible on the table. + type: boolean + type: object + Resource: + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + ResourceMember: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object + ResourceMembers: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceMember' + type: array + type: object + ResourceOwner: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object + ResourceOwners: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceOwner' + type: array + type: object + RetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The duration in seconds for how long data will be kept in the database. + The default duration is 2592000 (30 days). + 0 represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The shard group duration. + The duration or interval (in seconds) that each shard group covers. - The following table defines the properties that appear in this object: + #### InfluxDB Cloud - + - Does not use `shardGroupDurationsSeconds`. - ### Related guides + #### InfluxDB OSS - - [Get started with tasks](/influxdb/cloud/process-data/get-started/) - - [Common data processing tasks](/influxdb/cloud/process-data/common-tasks/) - - [Create a script](/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script) - name: Tasks - - name: Telegraf Plugins - - name: Telegrafs - - description: | - Export and apply InfluxDB **templates**. - Manage **stacks** of templated InfluxDB resources. + - Default value depends on the + [bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration). + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + RetentionRules: + description: | + Retention rules to expire or retain data. + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud/reference/glossary/#retention-period). - InfluxDB templates are prepackaged configurations for resources. - Use InfluxDB templates to configure a fresh instance of InfluxDB, - back up your dashboard configuration, or share your configuration. + #### InfluxDB Cloud - Use the `/api/v2/templates` endpoints to export templates and apply templates. + - `retentionRules` is required. - **InfluxDB stacks** are stateful InfluxDB templates that let you - add, update, and remove installed template resources over time, avoid duplicating - resources when applying the same or similar templates more than once, and - apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + #### InfluxDB OSS - Use the `/api/v2/stacks` endpoints to manage installed template resources. + - `retentionRules` isn't required. + items: + $ref: '#/components/schemas/RetentionRule' + type: array + ReturnStatement: + description: Defines an expression to return + properties: + argument: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Routes: + properties: + authorizations: + format: uri + type: string + buckets: + format: uri + type: string + dashboards: + format: uri + type: string + external: + properties: + statusFeed: + format: uri + type: string + type: object + flags: + format: uri + type: string + me: + format: uri + type: string + orgs: + format: uri + type: string + query: + properties: + analyze: + format: uri + type: string + ast: + format: uri + type: string + self: + format: uri + type: string + suggestions: + format: uri + type: string + type: object + setup: + format: uri + type: string + signin: + format: uri + type: string + signout: + format: uri + type: string + sources: + format: uri + type: string + system: + properties: + debug: + format: uri + type: string + health: + format: uri + type: string + metrics: + format: uri + type: string + type: object + tasks: + format: uri + type: string + telegrafs: + format: uri + type: string + users: + format: uri + type: string + variables: + format: uri + type: string + write: + format: uri + type: string + RuleStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY + type: string + Run: + properties: + finishedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + flux: + description: Flux used for the task + readOnly: true + type: string + id: + readOnly: true + type: string + links: + example: + retry: /api/v2/tasks/1/runs/1/retry + self: /api/v2/tasks/1/runs/1 + task: /api/v2/tasks/1 + properties: + retry: + format: uri + type: string + self: + format: uri + type: string + task: + format: uri + type: string + readOnly: true + type: object + log: + description: An array of logs associated with the run. + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + requestedAt: + description: The time ([RFC3339Nano date/time format](/influxdb/cloud/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + scheduledFor: + description: The time [RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. + format: date-time + type: string + startedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + status: + enum: + - scheduled + - started + - failed + - success + - canceled + readOnly: true + type: string + taskID: + readOnly: true + type: string + RunManually: + properties: + scheduledFor: + description: | + The time [RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp) + used for the run's `now` option. + Default is the server _now_ time. + format: date-time + nullable: true + type: string + Runs: + properties: + links: + $ref: '#/components/schemas/Links' + runs: + items: + $ref: '#/components/schemas/Run' + type: array + type: object + SMTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' + SMTPNotificationRuleBase: + properties: + bodyTemplate: + type: string + subjectTemplate: + type: string + to: + type: string + type: + enum: + - smtp + type: string + required: + - type + - subjectTemplate + - to + type: object + ScatterViewProperties: + properties: + adaptiveZoomHide: + type: boolean + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + symbolColumns: + items: + type: string + type: array + timeFormat: + type: string + type: + enum: + - scatter + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + SchemaType: + enum: + - implicit + - explicit + type: string + Script: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + type: string + orgID: + type: string + script: + description: The script to execute. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + url: + description: The invocation endpoint address. + type: string + required: + - name + - orgID + - script + ScriptCreateRequest: + properties: + description: + description: Script description. A description of the script. + type: string + language: + $ref: '#/components/schemas/ScriptLanguage' + name: + description: Script name. The name must be unique within the organization. + type: string + script: + description: The script to execute. + type: string + required: + - name + - script + - language + - description + type: object + ScriptHTTPResponseData: + description: | + The response body contains the results of the executed script. + The response is user-defined and dynamic. + format: binary + type: string + ScriptInvocationParams: + properties: + params: + additionalProperties: true + description: | + The script parameters. + `params` contains key-value pairs that map values to the **params.keys** + in a script. + When you invoke a script with `params`, InfluxDB passes the values as + invocation parameters to the script. + type: object + type: object + ScriptLanguage: + enum: + - flux + - sql + type: string + ScriptUpdateRequest: + properties: + description: + description: A description of the script. + type: string + script: + description: The script to execute. + type: string + type: object + Scripts: + properties: + scripts: + items: + $ref: '#/components/schemas/Script' + type: array + type: object + SecretKeys: + properties: + secrets: + items: + type: string + type: array + type: object + SecretKeysResponse: + allOf: + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object + Secrets: + additionalProperties: + type: string + example: + apikey: abc123xyz + SimpleTableViewProperties: + properties: + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showAll: + type: boolean + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - simple-table + type: string + required: + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty + type: object + SingleStatViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - single-stat + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + SlackNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + token: + description: Specifies the API token string. Specify either `URL` or `Token`. + type: string + url: + description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. + type: string + type: object + type: object + SlackNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' + SlackNotificationRuleBase: + properties: + channel: + type: string + messageTemplate: + type: string + type: + enum: + - slack + type: string + required: + - type + - messageTemplate + type: object + Stack: + properties: + createdAt: + format: date-time + readOnly: true + type: string + events: + items: + properties: + description: + type: string + eventType: + type: string + name: + type: string + resources: + items: + properties: + apiVersion: + type: string + associations: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + metaName: + type: string + type: object + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + links: + properties: + self: + type: string + type: object + resourceID: + type: string + templateMetaName: + type: string + type: object + type: array + sources: + items: + type: string + type: array + updatedAt: + format: date-time + readOnly: true + type: string + urls: + items: + type: string + type: array + type: object + type: array + id: + type: string + orgID: + type: string + type: object + Statement: + oneOf: + - $ref: '#/components/schemas/BadStatement' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/ExpressionStatement' + - $ref: '#/components/schemas/ReturnStatement' + - $ref: '#/components/schemas/OptionStatement' + - $ref: '#/components/schemas/BuiltinStatement' + - $ref: '#/components/schemas/TestStatement' + StaticLegend: + description: StaticLegend represents the options specific to the static legend + properties: + colorizeRows: + type: boolean + heightRatio: + format: float + type: number + opacity: + format: float + type: number + orientationThreshold: + type: integer + show: + type: boolean + valueAxis: + type: string + widthRatio: + format: float + type: number + type: object + StatusRule: + properties: + count: + type: integer + currentLevel: + $ref: '#/components/schemas/RuleStatusLevel' + period: + type: string + previousLevel: + $ref: '#/components/schemas/RuleStatusLevel' + type: object + StringLiteral: + description: Expressions begin and end with double quote marks + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + TableViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + fieldOptions: + description: fieldOptions represent the fields retrieved by the query with customization options + items: + $ref: '#/components/schemas/RenamableField' + type: array + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + tableOptions: + properties: + fixFirstColumn: + description: fixFirstColumn indicates whether the first column of the table should be locked + type: boolean + sortBy: + $ref: '#/components/schemas/RenamableField' + verticalTimeAxis: + description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically + type: boolean + wrapping: + description: Wrapping describes the text wrapping style to be used in table views + enum: + - truncate + - wrap + - single-line + type: string + type: object + timeFormat: + description: timeFormat describes the display format for time values according to moment.js date formatting + type: string + type: + enum: + - table + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces + type: object + TagRule: + properties: + key: + type: string + operator: + enum: + - equal + - notequal + - equalregex + - notequalregex + type: string + value: + type: string + type: object + Task: + properties: + authorizationID: + description: | + An authorization ID. + Specifies the authorization used when the task communicates with the query engine. - ### Related guides + To find an authorization ID, use the + [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to + list authorizations. + type: string + createdAt: + format: date-time + readOnly: true + type: string + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. + type: string + description: + description: A description of the task. + type: string + every: + description: The interval ([duration literal](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. + format: duration + type: string + flux: + description: | + The Flux script that the task executes. - - [InfluxDB stacks](/influxdb/cloud/influxdb-templates/stacks/) - - [InfluxDB templates](/influxdb/cloud/influxdb-templates/) - name: Templates - - name: Usage - - description: | - Retrieve specific users. + #### Limitations + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + format: flux + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/tasks/1/labels + logs: /api/v2/tasks/1/logs + members: /api/v2/tasks/1/members + owners: /api/v2/tasks/1/owners + runs: /api/v2/tasks/1/runs + self: /api/v2/tasks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + logs: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + runs: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + description: The name of the task. + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: | + An [organization](/influxdb/cloud/reference/glossary/#organization) name. + Specifies the organization that owns the task. + type: string + orgID: + description: | + An [organization](/influxdb/cloud/reference/glossary/#organization) ID. + Specifies the organization that owns the task. + type: string + ownerID: + description: | + A [user](/influxdb/cloud/reference/glossary/#user) ID. + Specifies the owner of the task. - InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. - To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); - you can't use the InfluxDB API to manage users in InfluxDB Cloud. - Once a user is added to your organization, you can use the - `GET /api/v2/users` and `GET /api/v2/users/USER_ID` API endpoints to - view specific members. + To find a user ID, you can use the + [`GET /api/v2/users` endpoint](#operation/GetUsers) to + list users. + type: string + scriptID: + description: | + A script ID. + Specifies the [invokable script](#tag/Invokable-Scripts) that the task executes. - ### User sessions with authorizations + #### Limitations - Optionally, you can scope an authorization (and its API token) to a user. - If a user signs in with username and password, creating a _user session_, - 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). + - If you use the `scriptID` property, you can't use the `flux` property. - ### Related guides + #### Related guides - - [Manage users](/influxdb/cloud/organizations/users/) - name: Users - - name: Variables - - name: Views - - description: | - Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket). - name: Write + - [Create a task that references a script](/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-that-references-a-script) + type: string + scriptParameters: + description: | + Key-value pairs for `params` in the script. + Defines the invocation parameter values passed to the script specified by `scriptID`. + When running the task, InfluxDB executes the script with the parameters + you provide. + + #### Limitations + + - To use `scriptParameters`, you must provide a `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - orgID + type: object + TaskCreateRequest: + properties: + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time. + type: string + description: + description: The description of the task. + type: string + every: + description: | + The interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. + `every` also determines when the task first runs, depending on the specified time. + type: string + flux: + description: | + The Flux script that the task runs. + + #### Limitations + + - If you use the `flux` property, you can't use the `scriptID` and `scriptParameters` properties. + type: string + name: + description: The name of the task + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: The name of the organization that owns the task. + type: string + orgID: + description: The ID of the organization that owns the task. + type: string + scriptID: + description: | + The ID of the script that the task runs. + + #### Limitations + + - If you use the `scriptID` property, you can't use the `flux` property. + type: string + scriptParameters: + description: | + The parameter key-value pairs passed to the script (referenced by `scriptID`) during the task run. + + #### Limitations + + - `scriptParameters` requires `scriptID`. + - If you use the `scriptID` and `scriptParameters` properties, you can't use the `flux` property. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + TaskStatusType: + description: | + `inactive` cancels scheduled runs and prevents manual runs of the task. + enum: + - active + - inactive + type: string + TaskUpdateRequest: + properties: + cron: + description: Update the 'cron' option in the flux script. + type: string + description: + description: Update the description of the task. + type: string + every: + description: Update the 'every' option in the flux script. + type: string + flux: + description: Update the Flux script that the task runs. + type: string + name: + description: Update the 'name' option in the flux script. + type: string + offset: + description: Update the 'offset' option in the flux script. + type: string + scriptID: + description: Update the 'scriptID' of the task. + type: string + scriptParameters: + description: Update the 'scriptParameters' of the task. + type: object + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + Tasks: + properties: + links: + $ref: '#/components/schemas/Links' + readOnly: true + tasks: + items: + $ref: '#/components/schemas/Task' + type: array + type: object + Telegraf: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + labels: /api/v2/telegrafs/1/labels + members: /api/v2/telegrafs/1/members + owners: /api/v2/telegrafs/1/owners + self: /api/v2/telegrafs/1 + properties: + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + type: object + type: object + TelegrafPlugin: + properties: + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + TelegrafPluginRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + plugins: + items: + properties: + alias: + type: string + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + type: array + type: object + TelegrafPlugins: + properties: + os: + type: string + plugins: + items: + $ref: '#/components/schemas/TelegrafPlugin' + type: array + version: + type: string + type: object + TelegrafRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + type: object + Telegrafs: + properties: + configurations: + items: + $ref: '#/components/schemas/Telegraf' + type: array + type: object + TelegramNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . + type: string + token: + description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . + type: string + required: + - token + - channel + type: object + type: object + TelegramNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' + TelegramNotificationRuleBase: + properties: + disableWebPagePreview: + description: Disables preview of web links in the sent messages when "true". Defaults to "false". + type: boolean + messageTemplate: + description: The message template as a flux interpolated string. + type: string + parseMode: + description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". + enum: + - MarkdownV2 + - HTML + - Markdown + type: string + type: + description: The discriminator between other types of notification rules is "telegram". + enum: + - telegram + type: string + required: + - type + - messageTemplate + - channel + type: object + Template: + items: + description: | + A template entry. + Defines an InfluxDB resource in a template. + properties: + apiVersion: + example: influxdata.com/v2alpha1 + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + metadata: + description: | + Metadata properties used for the resource when the template is applied. + properties: + name: + type: string + type: object + spec: + description: | + Configuration properties used for the resource when the template is applied. + Key-value pairs map to the specification for the resource. + + The following code samples show `spec` configurations for template resources: + + - A bucket: + + ```json + { "spec": { + "name": "iot_center", + "retentionRules": [{ + "everySeconds": 2.592e+06, + "type": "expire" + }] + } + } + ``` + + - A variable: + + ```json + { "spec": { + "language": "flux", + "name": "Node_Service", + "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", + tag: \"service\")", + "type": "query" + } + } + ``` + type: object + type: object + type: array + TemplateApply: + properties: + actions: + description: | + A list of `action` objects. + Actions let you customize how InfluxDB applies templates in the request. + + You can use the following actions to prevent creating or updating resources: + + - A `skipKind` action skips template resources of a specified `kind`. + - A `skipResource` action skips template resources with a specified `metadata.name` + and `kind`. + items: + oneOf: + - properties: + action: + enum: + - skipKind + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object + type: array + dryRun: + description: | + Only applies a dry run of the templates passed in the request. + + - Validates the template and generates a resource diff and summary. + - Doesn't install templates or make changes to the InfluxDB instance. + type: boolean + envRefs: + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + description: | + An object with key-value pairs that map to **environment references** in templates. + + Environment references in templates are `envRef` objects with an `envRef.key` + property. + To substitute a custom environment reference value when applying templates, + pass `envRefs` with the `envRef.key` and the value. + + When you apply a template, InfluxDB replaces `envRef` objects in the template + with the values that you provide in the `envRefs` parameter. + For more examples, see how to [define environment references](/influxdb/cloud/influxdb-templates/use/#define-environment-references). + + The following template fields may use environment references: + + - `metadata.name` + - `spec.endpointName` + - `spec.associations.name` + + For more information about including environment references in template fields, see how to + [include user-definable resource names](/influxdb/cloud/influxdb-templates/create/#include-user-definable-resource-names). + type: object + orgID: + description: | + Organization ID. + InfluxDB applies templates to this organization. + The organization owns all resources created by the template. + + To find your organization, see how to + [view organizations](/influxdb/cloud/organizations/view-orgs/). + type: string + remotes: + description: | + A list of URLs for template files. + + To apply a template manifest file located at a URL, pass `remotes` + with an array that contains the URL. + items: + properties: + contentType: + type: string + url: + type: string + required: + - url + type: object + type: array + secrets: + additionalProperties: + type: string + description: | + An object with key-value pairs that map to **secrets** in queries. + + Queries may reference secrets stored in InfluxDB--for example, + the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` + secrets and then uses them to connect to a PostgreSQL database: + + ```js + import "sql" + import "influxdata/influxdb/secrets" + + username = secrets.get(key: "POSTGRES_USERNAME") + password = secrets.get(key: "POSTGRES_PASSWORD") + + sql.from( + driverName: "postgres", + dataSourceName: "postgresql://${username}:${password}@localhost:5432", + query: "SELECT * FROM example_table", + ) + ``` + + To define secret values in your `/api/v2/templates/apply` request, + pass the `secrets` parameter with key-value pairs--for example: + + ```json + { + ... + "secrets": { + "POSTGRES_USERNAME": "pguser", + "POSTGRES_PASSWORD": "foo" + } + ... + } + ``` + + InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. + Once stored, you can't view secret values in InfluxDB. + + #### Related guides + + - [How to pass secrets when installing a template](/influxdb/cloud/influxdb-templates/use/#pass-secrets-when-installing-a-template) + type: object + stackID: + description: | + ID of the stack to update. + + To apply templates to an existing stack in the organization, use the `stackID` parameter. + If you apply templates without providing a stack ID, + InfluxDB initializes a new stack with all new resources. + + To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. + + #### Related guides + + - [Stacks](/influxdb/cloud/influxdb-templates/stacks/) + - [View stacks](/influxdb/cloud/influxdb-templates/stacks/view/) + type: string + template: + description: | + A template object to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Pass `template` to apply only one template object. + If you use `template`, you can't use the `templates` parameter. + If you want to apply multiple template objects, use `templates` instead. + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + templates: + description: | + A list of template objects to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Use the `templates` parameter to apply multiple template objects. + If you use `templates`, you can't use the `template` parameter. + items: + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + type: array + type: object + TemplateChart: + properties: + height: + type: integer + properties: + $ref: '#/components/schemas/ViewProperties' + width: + type: integer + xPos: + type: integer + yPos: + type: integer + type: object + TemplateEnvReferences: + items: + properties: + defaultValue: + description: Default value that will be provided for the reference when no value is provided + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + envRefKey: + description: Key identified as environment reference and is the key identified in the template + type: string + resourceField: + description: Field the environment reference corresponds too + type: string + value: + description: Value provided to fulfill reference + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + required: + - resourceField + - envRefKey + type: object + type: array + TemplateExportByID: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported + type: string + required: + - id + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateExportByName: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + required: + - name + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateKind: + enum: + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable + type: string + TemplateSummary: + properties: + diff: + properties: + buckets: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + old: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + checks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/CheckDiscriminator' + old: + $ref: '#/components/schemas/CheckDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + old: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + old: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationEndpoints: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + old: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + old: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + old: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/TelegrafRequest' + old: + $ref: '#/components/schemas/TelegrafRequest' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + old: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + errors: + items: + properties: + fields: + items: + type: string + type: array + indexes: + items: + type: integer + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + reason: + type: string + type: object + type: array + sources: + items: + type: string + type: array + stackID: + type: string + summary: + properties: + buckets: + items: + properties: + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + retentionPeriod: + type: integer + templateMetaName: + type: string + type: object + type: array + checks: + items: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + missingEnvRefs: + items: + type: string + type: array + missingSecrets: + items: + type: string + type: array + notificationEndpoints: + items: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + description: + type: string + endpointID: + type: string + endpointTemplateMetaName: + type: string + endpointType: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + cron: + type: string + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + type: object + TemplateSummaryLabel: + properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + orgID: + type: string + properties: + properties: + color: + type: string + description: + type: string + type: object + templateMetaName: + type: string + type: object + TestStatement: + description: Declares a Flux test case + properties: + assignment: + $ref: '#/components/schemas/VariableAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Threshold: + discriminator: + mapping: + greater: '#/components/schemas/GreaterThreshold' + lesser: '#/components/schemas/LesserThreshold' + range: '#/components/schemas/RangeThreshold' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' + ThresholdBase: + properties: + allValues: + description: If true, only alert if all values meet threshold. + type: boolean + level: + $ref: '#/components/schemas/CheckStatusLevel' + ThresholdCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + thresholds: + items: + $ref: '#/components/schemas/Threshold' + type: array + type: + enum: + - threshold + type: string + required: + - type + type: object + Token: + properties: + token: + type: string + type: object + UnaryExpression: + description: Uses operators to act on a single operand in an expression + properties: + argument: + $ref: '#/components/schemas/Expression' + operator: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + UnsignedIntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + User: + properties: + id: + readOnly: true + type: string + name: + type: string + org_id: + type: string + role: + enum: + - owner + - member + type: string + status: + default: active + description: If inactive the user is inactive. + enum: + - active + - inactive + type: string + required: + - name + UserResponse: + properties: + id: + description: | + The user ID. + readOnly: true + type: string + links: + example: + self: /api/v2/users/1 + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: | + The user name. + type: string + status: + default: active + description: | + The status of a user. + An inactive user can't read or write resources. + enum: + - active + - inactive + type: string + required: + - name + Users: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + type: object + Variable: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + createdAt: + format: date-time + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + properties: + labels: + format: uri + type: string + org: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + name: + type: string + orgID: + type: string + selected: + items: + type: string + type: array + sort_order: + type: integer + updatedAt: + format: date-time + type: string + required: + - name + - orgID + - arguments + type: object + VariableAssignment: + description: Represents the declaration of a variable + properties: + id: + $ref: '#/components/schemas/Identifier' + init: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + VariableProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariableProperties' + - $ref: '#/components/schemas/ConstantVariableProperties' + - $ref: '#/components/schemas/MapVariableProperties' + type: object + Variables: + example: + variables: + - arguments: + type: constant + values: + - howdy + - hello + - hi + - yo + - oy + id: '1221432' + name: ':ok:' + selected: + - hello + - arguments: + type: map + values: + a: fdjaklfdjkldsfjlkjdsa + b: dfaksjfkljekfajekdljfas + c: fdjksajfdkfeawfeea + id: '1221432' + name: ':ok:' + selected: + - c + - arguments: + language: flux + query: 'from(bucket: "foo") |> showMeasurements()' + type: query + id: '1221432' + name: ':ok:' + selected: + - host + properties: + variables: + items: + $ref: '#/components/schemas/Variable' + type: array + type: object + View: + properties: + id: + readOnly: true + type: string + links: + properties: + self: + type: string + readOnly: true + type: object + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + required: + - name + - properties + ViewProperties: + oneOf: + - $ref: '#/components/schemas/LinePlusSingleStatProperties' + - $ref: '#/components/schemas/XYViewProperties' + - $ref: '#/components/schemas/SingleStatViewProperties' + - $ref: '#/components/schemas/HistogramViewProperties' + - $ref: '#/components/schemas/GaugeViewProperties' + - $ref: '#/components/schemas/TableViewProperties' + - $ref: '#/components/schemas/SimpleTableViewProperties' + - $ref: '#/components/schemas/MarkdownViewProperties' + - $ref: '#/components/schemas/CheckViewProperties' + - $ref: '#/components/schemas/ScatterViewProperties' + - $ref: '#/components/schemas/HeatmapViewProperties' + - $ref: '#/components/schemas/MosaicViewProperties' + - $ref: '#/components/schemas/BandViewProperties' + - $ref: '#/components/schemas/GeoViewProperties' + Views: + properties: + links: + properties: + self: + type: string + type: object + views: + items: + $ref: '#/components/schemas/View' + type: array + type: object + WritePrecision: + enum: + - ms + - s + - us + - ns + type: string + XYGeom: + enum: + - line + - step + - stacked + - bar + - monotoneX + - stepBefore + - stepAfter + type: string + XYViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colorMapping: + $ref: '#/components/schemas/ColorMapping' + description: An object that contains information about the color mapping + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - xy + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position + type: object + securitySchemes: + BasicAuthentication: + description: | + ### Basic authentication scheme + + Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: + + ### Syntax + + `Authorization: Basic BASE64_ENCODED_CREDENTIALS` + + To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and + the password with a colon (`USERNAME:PASSWORD`), and then encode the + resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). + Many HTTP clients encode the credentials for you before sending the + request. + + _**Warning**: Base64-encoding can easily be reversed to obtain the original + username and password. It is used to keep the data intact and does not provide + security. You should always use HTTPS when authenticating or sending a request with + sensitive information._ + + ### Examples + + In the examples, replace the following: + + - **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with) + - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb/cloud/reference/glossary/#token) + - **`INFLUX_URL`**: your InfluxDB Cloud URL + + #### Encode credentials with cURL + + The following example shows how to use cURL to send an API request that uses Basic authentication. + With the `--user` option, cURL encodes the credentials and passes them + in the `Authorization: Basic` header. + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --user "EMAIL_ADDRESS":"PASSWORD" + ``` + + #### Encode credentials with Flux + + The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded + basic authentication header using a specified username and password combination. + + #### Encode credentials with JavaScript + + The following example shows how to use the JavaScript `btoa()` function + to create a Base64-encoded string: + + ```js + btoa('EMAIL_ADDRESS:PASSWORD') + ``` + + The output is the following: + + ```js + 'VVNFUk5BTUU6UEFTU1dPUkQ=' + ``` + + Once you have the Base64-encoded credentials, you can pass them in the + `Authorization` header--for example: + + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" + ``` + + To learn more about HTTP authentication, see + [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ + scheme: basic + type: http + TokenAuthentication: + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + ### Syntax + + `Authorization: Token INFLUX_API_TOKEN` + + ### Example + + #### Use Token authentication with cURL + + The following example shows how to use cURL to send an API request that uses Token authentication: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + Replace the following: + + - *`INFLUX_URL`*: your InfluxDB Cloud URL + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token) + + ### Related endpoints + + - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) + + ### Related guides + + - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/cloud/security/tokens/) + in: header + name: Authorization + type: apiKey x-tagGroups: - name: Using the InfluxDB HTTP API tags: diff --git a/api-docs/clustered/.config.yml b/api-docs/clustered/.config.yml new file mode 100644 index 000000000..e1bf4a4af --- /dev/null +++ b/api-docs/clustered/.config.yml @@ -0,0 +1,13 @@ +plugins: + - '../openapi/plugins/docs-plugin.js' +extends: + - recommended + - docs/all +x-influxdata-product-name: InfluxDB v3 Clustered + +apis: + v2@2: + root: v2/ref.yml + x-influxdata-default: true + v1-compatibility@2: + root: v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/clustered/content/info.yml b/api-docs/clustered/content/info.yml deleted file mode 100644 index 962b8a5f2..000000000 --- a/api-docs/clustered/content/info.yml +++ /dev/null @@ -1,7 +0,0 @@ -title: InfluxDB Clustered API Service -description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. -version: InfluxDB v3.0 -license: - name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file diff --git a/api-docs/clustered/v1-compatibility/content/info.yml b/api-docs/clustered/v1-compatibility/content/info.yml new file mode 100644 index 000000000..97fcb5fb7 --- /dev/null +++ b/api-docs/clustered/v1-compatibility/content/info.yml @@ -0,0 +1,14 @@ +title: InfluxDB v1 HTTP API for InfluxDB Clustered +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Clustered database. +description: | + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/) +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/v2/swaggerV1Compat.yml b/api-docs/clustered/v1-compatibility/swaggerV1Compat.yml similarity index 96% rename from api-docs/v2/swaggerV1Compat.yml rename to api-docs/clustered/v1-compatibility/swaggerV1Compat.yml index 71fed44e6..2fa21d8dc 100644 --- a/api-docs/v2/swaggerV1Compat.yml +++ b/api-docs/clustered/v1-compatibility/swaggerV1Compat.yml @@ -1,19 +1,42 @@ openapi: 3.0.0 info: - title: InfluxDB OSS v1 compatibility API documentation - version: 2.6.0 v1 compatibility + title: InfluxDB v1 HTTP API for InfluxDB Clustered + version: '' description: | - The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. - - If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/latest/api/). + The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. This documentation is generated from the - [InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/swaggerV1Compat.yml). + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + + #### Related + + [InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/) license: name: MIT url: https://opensource.org/licenses/MIT + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Clustered database. servers: - url: / +security: + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + The InfluxDB 1.x API requires authentication for all requests. + InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. + + + For more information, see the following: + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + + x-traitTag: true + - name: Query + - name: Write paths: /write: post: @@ -409,23 +432,3 @@ components: For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). -security: - - TokenAuthentication: [] - - BasicAuthentication: [] - - QuerystringAuthentication: [] -tags: - - name: Authentication - description: | - The InfluxDB 1.x API requires authentication for all requests. - InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. - - - For more information, see the following: - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - - x-traitTag: true - - name: Query - - name: Write diff --git a/api-docs/clustered/v2/content/info.yml b/api-docs/clustered/v2/content/info.yml new file mode 100644 index 000000000..3fc47d703 --- /dev/null +++ b/api-docs/clustered/v2/content/info.yml @@ -0,0 +1,10 @@ +title: InfluxDB Clustered API Service +summary: The InfluxDB v2 HTTP API for InfluxDB Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Clustered database. +description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). +license: + name: MIT + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/clustered/content/servers.yml b/api-docs/clustered/v2/content/servers.yml similarity index 100% rename from api-docs/clustered/content/servers.yml rename to api-docs/clustered/v2/content/servers.yml diff --git a/api-docs/clustered/content/tag-groups.yml b/api-docs/clustered/v2/content/tag-groups.yml similarity index 100% rename from api-docs/clustered/content/tag-groups.yml rename to api-docs/clustered/v2/content/tag-groups.yml diff --git a/api-docs/clustered/ref.yml b/api-docs/clustered/v2/ref.yml similarity index 98% rename from api-docs/clustered/ref.yml rename to api-docs/clustered/v2/ref.yml index e6a4e7aa5..c99970778 100644 --- a/api-docs/clustered/ref.yml +++ b/api-docs/clustered/v2/ref.yml @@ -1,3 +1,713 @@ +openapi: 3.0.0 +info: + title: InfluxDB Clustered API Service + version: '' + description: | + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). + license: + name: MIT + url: https://opensource.org/licenses/MIT + summary: The InfluxDB v2 HTTP API for InfluxDB Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Clustered database. +servers: + - url: https://{baseurl} + description: InfluxDB Clustered API URL + variables: + baseurl: + enum: + - cluster-host.com + default: cluster-host.com + description: InfluxDB Clustered URL +security: + - BearerAuthentication: [] + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - description: | + ### Write data + + InfluxDB Clustered provides the following HTTP API endpoints for writing data: + + - **Recommended**: [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. + - [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. + + Both endpoints accept the same line protocol format and process data in the same way. + + ### Query data + + InfluxDB Clustered provides the following protocols for executing a query: + + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/clustered/get-started/query/). + - HTTP API [`/query` request](/influxdb/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to v3. + + ### InfluxDB v2 compatibility + + The HTTP API [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/clustered/write-data/). + + See how to [use the InfluxDB v2 HTTP API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v2/). + + ### InfluxDB v1 compatibility + + The HTTP API [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) and [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. + + See how to [use the InfluxDB v1 HTTP API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v1/). + name: API compatibility + x-traitTag: true + - description: | + Use one of the following schemes to authenticate to the InfluxDB API: + + - [Bearer authentication](#section/Authentication/BearerAuthentication) + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + name: Authentication + x-traitTag: true + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `database` resource. + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `database`, `db` | string | The database name | + name: Common parameters + x-traitTag: true + - name: Data I/O endpoints + description: | + Write and query data stored in InfluxDB. + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - name: Ping + - description: | + Query data stored in a database. + + - HTTP clients can query the v1 [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) + using **InfluxQL** and retrieve data in **CSV** or **JSON** format. + - The `/api/v2/query` endpoint can't query InfluxDB Clustered. + - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. + + #### Related guides + + - [Get started querying InfluxDB](/influxdb/clustered/get-started/query/) + - [Execute queries](/influxdb/clustered/query-data/execute-queries/) + name: Query + - description: | + See the [**Get Started**](/influxdb/clustered/get-started/) tutorial + to get up and running authenticating with tokens, writing to databases, and querying data. + + [**InfluxDB API client libraries and Flight clients**](/influxdb/clustered/reference/client-libraries/) + are available to integrate InfluxDB APIs with your application. + name: Quick start + x-traitTag: true + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `204` | Success. No content | InfluxDB doesn't return data for the request. For example, a successful write request returns `204` status code, acknowledging that data is written and queryable. | + | `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. If line protocol in the request body is malformed. The response body contains the first malformed line and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. | + | `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 tokens](/influxdb/clustered/admin/tokens/)
| + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `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`. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: System information endpoints + - name: Usage + - description: | + Write time series data to [databases](/influxdb/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints. + name: Write +paths: + /ping: + get: + description: | + Retrieves the status and InfluxDB version of the instance. + + Use this endpoint to monitor uptime for the InfluxDB instance. The response + returns a HTTP `204` status code to inform you the instance is available. + + This endpoint doesn't require authentication. + operationId: GetPing + responses: + '204': + description: | + Success. + Headers contain InfluxDB version information. + headers: + X-Influxdb-Build: + description: | + The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: | + The version of InfluxDB. + schema: + type: integer + 4xx: + description: | + #### InfluxDB Cloud + - Doesn't return this error. + security: + - {} + servers: [] + summary: Get the status of the instance + tags: + - Ping + head: + description: | + Returns the status and InfluxDB version of the instance. + + Use this endpoint to monitor uptime for the InfluxDB instance. The response + returns a HTTP `204` status code to inform you the instance is available. + + This endpoint doesn't require authentication. + operationId: HeadPing + responses: + '204': + description: | + Success. + Headers contain InfluxDB version information. + headers: + X-Influxdb-Build: + description: The type of InfluxDB build. + schema: + type: string + X-Influxdb-Version: + description: | + The version of InfluxDB. + schema: + type: integer + 4xx: + description: | + #### InfluxDB Cloud + - Doesn't return this error. + security: + - {} + servers: [] + summary: Get the status of the instance + tags: + - Ping + /api/v2/write: + post: + description: | + Writes data to a database. + + Use this endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB. + + InfluxDB does the following when you send a write request: + + 1. Validates the request + 2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise. + 3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise. + + To ensure that InfluxDB Cloud handles writes in the order you request them, + wait for a success response (HTTP `2xx` status code) before you send the next request. + + #### Related guides + + - [Get started writing data](/influxdb/clustered/get-started/write/) + - [Write data](/influxdb/clustered/write-data/) + - [Best practices for writing data](/influxdb/clustered/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) + operationId: PostWrite + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + in: header + name: Content-Encoding + schema: + default: identity + description: | + Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - description: | + The format of the data in the request body. + To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. + in: header + name: Content-Type + schema: + default: text/plain; charset=utf-8 + description: | + `text/plain` is the content type for line protocol. `UTF-8` is the default character set. + enum: + - text/plain + - text/plain; charset=utf-8 + type: string + - description: | + The size of the entity-body, in bytes, sent to InfluxDB. + If the length is greater than the `max body` configuration option, + the server responds with status code `413`. + in: header + name: Content-Length + schema: + description: The length in decimal number of octets. + type: integer + - description: | + The content type that the client can understand. + Writes only return a response body if they fail--for example, + due to a formatting problem or quota limit. + + - Returns only `application/json` for format and limit errors. + - Returns only `text/html` for some quota limit errors. + + #### Related guides + + - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) + in: header + name: Accept + schema: + default: application/json + description: Error content type. + enum: + - application/json + type: string + - description: | + Ignored. An organization name or ID. + + InfluxDB ignores this parameter; authorizes the request using the specified database token + and writes data to the specified cluster database. + in: query + name: org + required: true + schema: + description: The organization name or ID. + type: string + - description: | + Ignored. An organization ID. + + InfluxDB ignores this parameter; authorizes the request using the specified database token + and writes data to the specified cluster database. + in: query + name: orgID + schema: + type: string + - description: | + A database name or ID. + InfluxDB writes all points in the batch to the specified database. + in: query + name: bucket + required: true + schema: + description: The database name or ID. + type: string + - description: The precision for unix timestamps in the line protocol batch. + in: query + name: precision + schema: + $ref: '#/components/schemas/WritePrecision' + requestBody: + content: + text/plain: + examples: + plain-utf8: + value: | + airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000 + airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000 + schema: + format: byte + type: string + description: | + In the request body, provide data in [line protocol format](/influxdb/clustered/reference/syntax/line-protocol/). + + To send compressed data, do the following: + + 1. Use [gzip](https://www.gzip.org/) to compress the line protocol data. + 2. In your request, send the compressed data and the + `Content-Encoding: gzip` header. + + #### Related guides + + - [Best practices for optimizing writes](/influxdb/clustered/write-data/best-practices/optimize-writes/) + required: true + responses: + '204': + description: | + Success. Data is written and queryable. + '400': + content: + application/json: + examples: + measurementSchemaFieldTypeConflict: + summary: field type conflict thrown by an explicit database schema + value: + code: invalid + message: 'failed to parse line protocol: error writing line 2: Unable to insert iox::column_type::field::integer type into column temp with type iox::column_type::field::string' + schema: + $ref: '#/components/schemas/LineProtocolError' + description: | + Bad request. The response body contains detail about the error. + + InfluxDB returns this error if the line protocol data in the request is malformed or contains a database schema conflict. + The response body contains the first malformed line in the data, and indicates what was expected. + '401': + $ref: '#/components/responses/AuthorizationError' + '404': + $ref: '#/components/responses/ResourceNotFoundError' + '413': + content: + application/json: + examples: + dataExceedsSizeLimitOSS: + summary: InfluxDB OSS response + value: | + {"code":"request too large","message":"unable to read data: points batch is too large"} + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + text/html: + examples: + dataExceedsSizeLimit: + summary: InfluxDB Cloud response + value: | + + 413 Request Entity Too Large + +

413 Request Entity Too Large

+
+
nginx
+ + + schema: + type: string + description: | + The request payload is too large. + InfluxDB rejected the batch and did not write any data. + + InfluxDB returns this error if the payload exceeds the size limit. + '429': + description: | + Too many requests. + + #### InfluxDB Cloud + + - Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum [global limit](/influxdb/clustered/account-management/limits/#global-limits). + - For rate limits that reset automatically, returns a `Retry-After` header that describes when to try the write again. + - For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header. + + Rates (data-in (writes), queries (reads), and deletes) accrue within a fixed five-minute window. + Once a rate limit is exceeded, InfluxDB returns an error response until the current five-minute window resets. + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + '500': + $ref: '#/components/responses/InternalServerError' + '503': + description: | + Service unavailable. + + - Returns this error if + the server is temporarily unavailable to accept writes. + - Returns a `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: Non-negative decimal integer indicating seconds to wait before retrying the request. + schema: + format: int32 + type: integer + default: + $ref: '#/components/responses/GeneralServerError' + summary: Write data + tags: + - Data I/O endpoints + - Write + /query: + get: + description: Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats. + operationId: GetLegacyQuery + parameters: + - $ref: '#/components/parameters/TraceSpan' + - in: header + name: Accept + schema: + default: application/json + description: | + Media type that the client can understand. + + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/clustered/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp). + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + type: string + - description: The content encoding (usually a compression algorithm) that the client can understand. + in: header + name: Accept-Encoding + schema: + default: identity + description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - in: header + name: Content-Type + schema: + enum: + - application/json + type: string + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: | + The [database](/influxdb/clustered/admin/databases/) to query data from. + in: query + name: db + required: true + schema: + type: string + - description: | + The retention policy to query data from. + For more information, see [InfluxQL DBRP naming convention](/influxdb/clustered/admin/databases/create/#influxql-dbrp-naming-convention). + in: query + name: rp + schema: + type: string + - description: The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`). + in: query + name: q + required: true + schema: + type: string + - description: | + A unix timestamp precision. + Formats timestamps as [unix (epoch) timestamps](/influxdb/clustered/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision. + in: query + name: epoch + schema: + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + responses: + '200': + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxqlJsonResponse' + application/x-msgpack: + schema: + format: binary + type: string + text/csv: + schema: + $ref: '#/components/schemas/InfluxqlCsvResponse' + description: Query results + headers: + Content-Encoding: + description: Lists encodings (usually compression algorithms) that have been applied to the response payload. + schema: + default: identity + description: | + The content coding: + - `gzip`: compressed data + - `identity`: unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + Trace-Id: + description: The trace ID, if generated, of the request. + schema: + description: Trace ID of a request. + type: string + '429': + description: | + #### InfluxDB Cloud: + - returns this error if a **read** or **write** request exceeds your + plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum + [global limit](/influxdb/clustered/account-management/limits/#global-limits) + - returns `Retry-After` header that describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Error processing query + summary: Query using the InfluxDB v1 HTTP API + tags: + - Query + /write: + post: + operationId: PostLegacyWrite + parameters: + - $ref: '#/components/parameters/TraceSpan' + - description: The InfluxDB 1.x username to authenticate the request. + in: query + name: u + schema: + type: string + - description: The InfluxDB 1.x password to authenticate the request. + in: query + name: p + schema: + type: string + - description: database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. + in: query + name: db + required: true + schema: + type: string + - description: Retention policy name. + in: query + name: rp + schema: + type: string + - description: Write precision. + in: query + name: precision + schema: + type: string + - description: When present, its value indicates to the database that compression is applied to the line protocol body. + in: header + name: Content-Encoding + schema: + default: identity + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + enum: + - gzip + - identity + type: string + requestBody: + content: + text/plain: + schema: + type: string + description: Line protocol body + required: true + responses: + '204': + description: Write data is correctly formatted and accepted for writing to the database. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolError' + description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: No token was sent and they are required. + '413': + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + format: int32 + type: integer + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + description: | + Writes data to a database. + + Use this InfluxDB v1-compatible endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB using v1 API parameters and authorization. + + InfluxDB does the following when you send a write request: + + 1. Validates the request + 2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise. + 3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise. + + To ensure that InfluxDB handles writes in the order you request them, + wait for a success response (HTTP `2xx` status code) before you send the next request. + + #### Related guides + + - [Write data with the InfluxDB API](/influxdb/clustered/get-started/write/) + - [Optimize writes to InfluxDB](/influxdb/clustered/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) + summary: Write data using the InfluxDB v1 HTTP API + tags: + - Write components: parameters: TraceSpan: @@ -1225,7 +1935,7 @@ components: ```sh ####################################### # Use Basic authentication with a database token - # to query the InfluxDB v1 API + # to query the InfluxDB v1 HTTP API ####################################### # Use the --user option with `--user username:DATABASE_TOKEN` syntax ####################################### @@ -1269,7 +1979,7 @@ components: ```sh ####################################### # Use an InfluxDB 1.x compatible username and password - # to query the InfluxDB v1 API + # to query the InfluxDB v1 HTTP API ####################################### # Use authentication query parameters: # ?p=DATABASE_TOKEN @@ -1355,705 +2065,6 @@ components: in: header name: Authorization type: apiKey -info: - title: InfluxDB Clustered API Service - version: InfluxDB v3.0 - description: | - The InfluxDB HTTP API provides a programmatic interface for interacting with InfluxDB. - license: - name: MIT - url: https://opensource.org/licenses/MIT -openapi: 3.0.0 -paths: - /ping: - get: - description: | - Retrieves the status and InfluxDB version of the instance. - - Use this endpoint to monitor uptime for the InfluxDB instance. The response - returns a HTTP `204` status code to inform you the instance is available. - - This endpoint doesn't require authentication. - operationId: GetPing - responses: - '204': - description: | - Success. - Headers contain InfluxDB version information. - headers: - X-Influxdb-Build: - description: | - The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: | - The version of InfluxDB. - schema: - type: integer - 4xx: - description: | - #### InfluxDB Cloud - - Doesn't return this error. - security: - - {} - servers: [] - summary: Get the status of the instance - tags: - - Ping - head: - description: | - Returns the status and InfluxDB version of the instance. - - Use this endpoint to monitor uptime for the InfluxDB instance. The response - returns a HTTP `204` status code to inform you the instance is available. - - This endpoint doesn't require authentication. - operationId: HeadPing - responses: - '204': - description: | - Success. - Headers contain InfluxDB version information. - headers: - X-Influxdb-Build: - description: The type of InfluxDB build. - schema: - type: string - X-Influxdb-Version: - description: | - The version of InfluxDB. - schema: - type: integer - 4xx: - description: | - #### InfluxDB Cloud - - Doesn't return this error. - security: - - {} - servers: [] - summary: Get the status of the instance - tags: - - Ping - /api/v2/write: - post: - description: | - Writes data to a database. - - Use this endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB. - - InfluxDB does the following when you send a write request: - - 1. Validates the request - 2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise. - 3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise. - - To ensure that InfluxDB Cloud handles writes in the order you request them, - wait for a success response (HTTP `2xx` status code) before you send the next request. - - #### Related guides - - - [Get started writing data](/influxdb/clustered/get-started/write/) - - [Write data](/influxdb/clustered/write-data/) - - [Best practices for writing data](/influxdb/clustered/write-data/best-practices/) - - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - operationId: PostWrite - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: | - The compression applied to the line protocol in the request payload. - To send a gzip payload, pass `Content-Encoding: gzip` header. - in: header - name: Content-Encoding - schema: - default: identity - description: | - Content coding. - Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - - description: | - The format of the data in the request body. - To send a line protocol payload, pass `Content-Type: text/plain; charset=utf-8`. - in: header - name: Content-Type - schema: - default: text/plain; charset=utf-8 - description: | - `text/plain` is the content type for line protocol. `UTF-8` is the default character set. - enum: - - text/plain - - text/plain; charset=utf-8 - type: string - - description: | - The size of the entity-body, in bytes, sent to InfluxDB. - If the length is greater than the `max body` configuration option, - the server responds with status code `413`. - in: header - name: Content-Length - schema: - description: The length in decimal number of octets. - type: integer - - description: | - The content type that the client can understand. - Writes only return a response body if they fail--for example, - due to a formatting problem or quota limit. - - - Returns only `application/json` for format and limit errors. - - Returns only `text/html` for some quota limit errors. - - #### Related guides - - - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - in: header - name: Accept - schema: - default: application/json - description: Error content type. - enum: - - application/json - type: string - - description: | - Ignored. An organization name or ID. - - InfluxDB ignores this parameter; authorizes the request using the specified database token - and writes data to the specified cluster database. - in: query - name: org - required: true - schema: - description: The organization name or ID. - type: string - - description: | - Ignored. An organization ID. - - InfluxDB ignores this parameter; authorizes the request using the specified database token - and writes data to the specified cluster database. - in: query - name: orgID - schema: - type: string - - description: | - A database name or ID. - InfluxDB writes all points in the batch to the specified database. - in: query - name: bucket - required: true - schema: - description: The database name or ID. - type: string - - description: The precision for unix timestamps in the line protocol batch. - in: query - name: precision - schema: - $ref: '#/components/schemas/WritePrecision' - requestBody: - content: - text/plain: - examples: - plain-utf8: - value: | - airSensors,sensor_id=TLM0201 temperature=73.97038159354763,humidity=35.23103248356096,co=0.48445310567793615 1630424257000000000 - airSensors,sensor_id=TLM0202 temperature=75.30007505999716,humidity=35.651929918691714,co=0.5141876544505826 1630424257000000000 - schema: - format: byte - type: string - description: | - In the request body, provide data in [line protocol format](/influxdb/clustered/reference/syntax/line-protocol/). - - To send compressed data, do the following: - - 1. Use [gzip](https://www.gzip.org/) to compress the line protocol data. - 2. In your request, send the compressed data and the - `Content-Encoding: gzip` header. - - #### Related guides - - - [Best practices for optimizing writes](/influxdb/clustered/write-data/best-practices/optimize-writes/) - required: true - responses: - '204': - description: | - Success. Data is written and queryable. - '400': - content: - application/json: - examples: - measurementSchemaFieldTypeConflict: - summary: field type conflict thrown by an explicit database schema - value: - code: invalid - message: 'failed to parse line protocol: error writing line 2: Unable to insert iox::column_type::field::integer type into column temp with type iox::column_type::field::string' - schema: - $ref: '#/components/schemas/LineProtocolError' - description: | - Bad request. The response body contains detail about the error. - - InfluxDB returns this error if the line protocol data in the request is malformed or contains a database schema conflict. - The response body contains the first malformed line in the data, and indicates what was expected. - '401': - $ref: '#/components/responses/AuthorizationError' - '404': - $ref: '#/components/responses/ResourceNotFoundError' - '413': - content: - application/json: - examples: - dataExceedsSizeLimitOSS: - summary: InfluxDB OSS response - value: | - {"code":"request too large","message":"unable to read data: points batch is too large"} - schema: - $ref: '#/components/schemas/LineProtocolLengthError' - text/html: - examples: - dataExceedsSizeLimit: - summary: InfluxDB Cloud response - value: | - - 413 Request Entity Too Large - -

413 Request Entity Too Large

-
-
nginx
- - - schema: - type: string - description: | - The request payload is too large. - InfluxDB rejected the batch and did not write any data. - - InfluxDB returns this error if the payload exceeds the size limit. - '429': - description: | - Too many requests. - - #### InfluxDB Cloud - - - Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas) - or if a **delete** request exceeds the maximum [global limit](/influxdb/clustered/account-management/limits/#global-limits). - - For rate limits that reset automatically, returns a `Retry-After` header that describes when to try the write again. - - For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header. - - Rates (data-in (writes), queries (reads), and deletes) accrue within a fixed five-minute window. - Once a rate limit is exceeded, InfluxDB returns an error response until the current five-minute window resets. - headers: - Retry-After: - description: Non-negative decimal integer indicating seconds to wait before retrying the request. - schema: - format: int32 - type: integer - '500': - $ref: '#/components/responses/InternalServerError' - '503': - description: | - Service unavailable. - - - Returns this error if - the server is temporarily unavailable to accept writes. - - Returns a `Retry-After` header that describes when to try the write again. - headers: - Retry-After: - description: Non-negative decimal integer indicating seconds to wait before retrying the request. - schema: - format: int32 - type: integer - default: - $ref: '#/components/responses/GeneralServerError' - summary: Write data - tags: - - Data I/O endpoints - - Write - /query: - get: - description: Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats. - operationId: GetLegacyQuery - parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: header - name: Accept - schema: - default: application/json - description: | - Media type that the client can understand. - - **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/clustered/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp). - enum: - - application/json - - application/csv - - text/csv - - application/x-msgpack - type: string - - description: The content encoding (usually a compression algorithm) that the client can understand. - in: header - name: Accept-Encoding - schema: - default: identity - description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - - in: header - name: Content-Type - schema: - enum: - - application/json - type: string - - description: The InfluxDB 1.x username to authenticate the request. - in: query - name: u - schema: - type: string - - description: The InfluxDB 1.x password to authenticate the request. - in: query - name: p - schema: - type: string - - description: | - The [database](/influxdb/clustered/admin/databases/) to query data from. - in: query - name: db - required: true - schema: - type: string - - description: | - The retention policy to query data from. - For more information, see [InfluxQL DBRP naming convention](/influxdb/clustered/admin/databases/create/#influxql-dbrp-naming-convention). - in: query - name: rp - schema: - type: string - - description: The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`). - in: query - name: q - required: true - schema: - type: string - - description: | - A unix timestamp precision. - Formats timestamps as [unix (epoch) timestamps](/influxdb/clustered/reference/glossary/#unix-timestamp) the specified precision - instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - in: query - name: epoch - schema: - enum: - - ns - - u - - µ - - ms - - s - - m - - h - type: string - responses: - '200': - content: - application/csv: - schema: - $ref: '#/components/schemas/InfluxqlCsvResponse' - application/json: - schema: - $ref: '#/components/schemas/InfluxqlJsonResponse' - application/x-msgpack: - schema: - format: binary - type: string - text/csv: - schema: - $ref: '#/components/schemas/InfluxqlCsvResponse' - description: Query results - headers: - Content-Encoding: - description: Lists encodings (usually compression algorithms) that have been applied to the response payload. - schema: - default: identity - description: | - The content coding: - - `gzip`: compressed data - - `identity`: unmodified, uncompressed data. - enum: - - gzip - - identity - type: string - Trace-Id: - description: The trace ID, if generated, of the request. - schema: - description: Trace ID of a request. - type: string - '429': - description: | - #### InfluxDB Cloud: - - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas) - or if a **delete** request exceeds the maximum - [global limit](/influxdb/clustered/account-management/limits/#global-limits) - - returns `Retry-After` header that describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error processing query - summary: Query using the InfluxDB v1 API - tags: - - Query - /write: - post: - operationId: PostLegacyWrite - parameters: - - $ref: '#/components/parameters/TraceSpan' - - description: The InfluxDB 1.x username to authenticate the request. - in: query - name: u - schema: - type: string - - description: The InfluxDB 1.x password to authenticate the request. - in: query - name: p - schema: - type: string - - description: database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy. - in: query - name: db - required: true - schema: - type: string - - description: Retention policy name. - in: query - name: rp - schema: - type: string - - description: Write precision. - in: query - name: precision - schema: - type: string - - description: When present, its value indicates to the database that compression is applied to the line protocol body. - in: header - name: Content-Encoding - schema: - default: identity - description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. - enum: - - gzip - - identity - type: string - requestBody: - content: - text/plain: - schema: - type: string - description: Line protocol body - required: true - responses: - '204': - description: Write data is correctly formatted and accepted for writing to the database. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/LineProtocolError' - description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: No token was sent and they are required. - '413': - content: - application/json: - schema: - $ref: '#/components/schemas/LineProtocolLengthError' - description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. - '429': - description: Token is temporarily over quota. The Retry-After header describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - '503': - description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - format: int32 - type: integer - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - description: | - Writes data to a database. - - Use this InfluxDB v1-compatible endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB using v1 API parameters and authorization. - - InfluxDB does the following when you send a write request: - - 1. Validates the request - 2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise. - 3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise. - - To ensure that InfluxDB handles writes in the order you request them, - wait for a success response (HTTP `2xx` status code) before you send the next request. - - #### Related guides - - - [Write data with the InfluxDB API](/influxdb/clustered/get-started/write/) - - [Optimize writes to InfluxDB](/influxdb/clustered/write-data/best-practices/optimize-writes/) - - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - summary: Write data using the InfluxDB v1 API - tags: - - Write -security: - - BearerAuthentication: [] - - TokenAuthentication: [] - - BasicAuthentication: [] - - QuerystringAuthentication: [] -servers: - - url: / -tags: - - description: | - ### Write data - - InfluxDB Clustered provides the following HTTP API endpoints for writing data: - - - **Recommended**: [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3. - - [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. - - Both endpoints accept the same line protocol format and process data in the same way. - - ### Query data - - InfluxDB Clustered provides the following protocols for executing a query: - - - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/clustered/get-started/query/). - - HTTP API [`/query` request](/influxdb/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL query. - Use this protocol when bringing existing InfluxDB v1 query workloads to v3. - - ### InfluxDB v2 compatibility - - The HTTP API [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/clustered/write-data/). - - See how to [use the InfluxDB v2 API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v2/). - - ### InfluxDB v1 compatibility - - The HTTP API [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) and [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code. - - See how to [use the InfluxDB v1 API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v1/). - name: API compatibility - x-traitTag: true - - description: | - Use one of the following schemes to authenticate to the InfluxDB API: - - - [Bearer authentication](#section/Authentication/BearerAuthentication) - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - name: Authentication - x-traitTag: true - - description: | - To specify resources, some InfluxDB API endpoints require parameters or - properties in the request--for example, - writing to a `database` resource. - - ### Common parameters - - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `database`, `db` | string | The database name | - name: Common parameters - x-traitTag: true - - name: Data I/O endpoints - description: | - Write and query data stored in InfluxDB. - - description: | - InfluxDB HTTP API endpoints use standard HTTP request and response headers. - The following table shows common headers used by many InfluxDB API endpoints. - Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. - - | Header | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `Accept` | string | The content type that the client can understand. | - | `Authorization` | string | The authorization scheme and credential. | - | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | - | `Content-Type` | string | The format of the data in the request body. | - name: Headers - x-traitTag: true - - name: Ping - - description: | - Query data stored in a database. - - - HTTP clients can query the v1 [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) - using **InfluxQL** and retrieve data in **CSV** or **JSON** format. - - The `/api/v2/query` endpoint can't query InfluxDB Clustered. - - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format. - - #### Related guides - - - [Get started querying InfluxDB](/influxdb/clustered/get-started/query/) - - [Execute queries](/influxdb/clustered/query-data/execute-queries/) - name: Query - - description: | - See the [**Get Started**](/influxdb/clustered/get-started/) tutorial - to get up and running authenticating with tokens, writing to databases, and querying data. - - [**InfluxDB API client libraries and Flight clients**](/influxdb/clustered/reference/client-libraries/) - are available to integrate InfluxDB APIs with your application. - name: Quick start - x-traitTag: true - - description: | - InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. - The response body may include additional details. - For details about a specific operation's response, - see **Responses** and **Response Samples** for that operation. - - API operations may return the following HTTP status codes: - - |  Code  | Status | Description | - |:-----------:|:------------------------ |:--------------------- | - | `200` | Success | | - | `204` | Success. No content | InfluxDB doesn't return data for the request. For example, a successful write request returns `204` status code, acknowledging that data is written and queryable. | - | `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. If line protocol in the request body is malformed. The response body contains the first malformed line and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. | - | `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 tokens](/influxdb/clustered/admin/tokens/)
| - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `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`. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | - | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | - | `500` | Internal server error | | - | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | - name: Response codes - x-traitTag: true - - name: System information endpoints - - name: Usage - - description: | - Write time series data to [databases](/influxdb/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints. - name: Write x-tagGroups: - name: Using the InfluxDB HTTP API tags: diff --git a/api-docs/generate-api-docs.sh b/api-docs/generate-api-docs.sh index 1a728b744..6b3fc41a8 100755 --- a/api-docs/generate-api-docs.sh +++ b/api-docs/generate-api-docs.sh @@ -2,53 +2,6 @@ set -e -function buildHugoTemplate { - version=$1 - apiVersion=$2 - outFilename=$3 - - V_LEN_INIT=$(wc -c $version$outFilename.tmp | awk '{print $1}') - cat "redoc-static${outFilename}.html" >> $version$outFilename.tmp - V_LEN=$(wc -c $version$outFilename.tmp | awk '{print $1}') - - if ! [[ $V_LEN -gt $V_LEN_INIT ]] - then - echo "Error: bundle was not appended to $version$outFilename.tmp" - exit $? - fi - - rm -f "redoc-static${outFilename}.html" - mkdir -p ../content/influxdb/$version/api - mv $version$outFilename.tmp ../content/influxdb/$version/api/$outFilename.html -} - -function generateHtml { - filePath=$1 - outFilename=$2 - titleVersion=$3 - titleSubmodule=$4 - - echo "Bundling $filePath" - - npx --version - - # Use npx to install and run the specified version of redoc-cli. - # npm_config_yes=true npx overrides the prompt - # and (vs. npx --yes) is compatible with npm@6 and npm@7. - npm_config_yes=true npx redoc-cli@0.12.3 bundle $filePath \ - -t template.hbs \ - --title="InfluxDB $titleVersion$titleSubmodule API documentation" \ - --options.sortPropsAlphabetically \ - --options.menuToggle \ - --options.hideDownloadButton \ - --options.hideHostname \ - --options.noAutoAuth \ - --templateOptions.version="$version" \ - --templateOptions.titleVersion="$titleVersion" \ - --templateOptions.titleSubmodule="$titleSubmodule" \ - --output="redoc-static$outFilename.html" -} - function showHelp { echo "Usage: generate.sh " echo "Commands:" @@ -82,119 +35,179 @@ while getopts "hc" opt; do esac done -# Get list of versions from directory names -versions="$(ls -d -- */ | grep -v 'node_modules' | grep -v 'openapi')" +function generateHtml { + specPath="$1" + product="$2" + productName="$3" + api="$4" + configPath="$5" + isDefault=$6 -for version in $versions -do - # Trim the trailing slash off the directory name - version="${version%/}" + # Use the product name to define the menu for the Hugo template + menu="influxdb_$(echo $product | sed 's/\./_/g;s/-/_/g;')" + # Extract the API name--for example, "management" from "management@v2". + apiName=$(echo $api | sed 's/@.*//g;') + # Convert it to title case--for example, "Management". + apiTitle=$(echo $apiName \ + | awk '{print toupper(substr($1,1,1)) tolower(substr($1,2))}') + # Extract the API version--for example, "v0" from "management@v0". + version=$(echo $api | sed 's/.*@//g;') + # Use the title and summary defined in the product API's info.yml file. + title=$(yq '.title' $product/$apiName/content/info.yml) + description=$(yq '.summary' $product/$apiName/content/info.yml) + # Define the file name for the Redoc HTML output. + specbundle=redoc-static_index.html + # Define the temporary file for the Hugo template and Redoc HTML. + tmpfile="${product}-${api}_index.tmp" - # Define the menu key - if [[ $version == "cloud-serverless" ]] || [[ $version == "cloud-dedicated" ]] || [[ $version == "clustered" ]]; then - menu="influxdb_$(echo $version | sed 's/\./_/g;s/-/_/g;')" - else - menu="influxdb_$(echo $version | sed 's/\./_/g;')" - fi + echo "Bundling $specPath" - # Define the title text based on the version - if [[ $version == "cloud" ]]; then - titleVersion="Cloud" - elif [[ $version == "cloud-serverless" ]]; then - titleVersion="Cloud Serverless" - elif [[ $version == "cloud-dedicated" ]]; then - titleVersion="Cloud Dedicated" - elif [[ $version == "clustered" ]]; then - titleVersion="Clustered" - else - titleVersion="$version" - fi + # Use npx to install and run the specified version of redoc-cli. + # npm_config_yes=true npx overrides the prompt + # and (vs. npx --yes) is compatible with npm@6 and npm@7. + npx --version && \ + npm_config_yes=true npx redoc-cli@0.12.3 bundle $specPath \ + --config $configPath \ + -t template.hbs \ + --title=$title \ + --options.sortPropsAlphabetically \ + --options.menuToggle \ + --options.hideDownloadButton \ + --options.hideHostname \ + --options.noAutoAuth \ + --output=$specbundle \ + --templateOptions.description=$description \ + --templateOptions.product="$product" \ + --templateOptions.productName="$productName" - # Define frontmatter version - if [[ $version == "cloud-serverless" ]] || [[ $version == "cloud-dedicated" ]] || [[ $version == "clustered" ]]; then - frontmatterVersion="v3" - else - frontmatterVersion="v2" - fi - - # Generate the frontmatter - v2frontmatter="--- -title: InfluxDB $titleVersion API documentation -description: > - The InfluxDB API provides a programmatic interface for interactions with InfluxDB $titleVersion. + if [[ $version == "v1" ]]; then + frontmatter="--- +title: $title +description: $description layout: api menu: $menu: - parent: InfluxDB v2 API - name: v2 API docs -weight: 102 ---- -" - v1compatfrontmatter="--- -title: InfluxDB $titleVersion v1 compatibility API documentation -description: > - The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB $titleVersion using InfluxDB v1 compatibility endpoints. -layout: api -menu: - $menu: - parent: v1 compatibility - name: View v1 compatibility API docs + parent: $version compatibility + name: View $version compatibility API weight: 304 --- " - v3frontmatter="--- -title: InfluxDB $titleVersion API documentation -description: > - The InfluxDB API provides a programmatic interface for interactions with InfluxDB $titleVersion. + elif [[ $version == "0" ]]; then + echo $productName $apiName + frontmatter="--- +title: $title +description: $description layout: api weight: 102 +menu: + $menu: + parent: InfluxDB HTTP API + name: Management API +--- +" + elif [[ $isDefault == true ]]; then + frontmatter="--- +title: $title +description: $description +layout: api +menu: + $menu: + parent: InfluxDB HTTP API + name: $apiTitle API +weight: 102 +aliases: + - /influxdb/$product/api/ +--- +" + else + frontmatter="--- +title: $title +description: $description +layout: api +menu: + $menu: + parent: InfluxDB HTTP API + name: $apiTitle API +weight: 102 --- " - - # If the v2 spec file differs from master, regenerate the HTML. - filePath="${version}/ref.yml" - update=0 - if [[ $generate_changed == 0 ]]; then - fileChanged=$(git diff --name-status master -- ${filePath}) - if [[ -z "$fileChanged" ]]; then - update=1 - fi fi - if [[ $update -eq 0 ]]; then - outFilename="_index" - titleSubmodule="" - generateHtml $filePath $outFilename $titleVersion $titleSubmodule + # Create the Hugo template file with the frontmatter and Redoc HTML + echo "$frontmatter" >> $tmpfile + V_LEN_INIT=$(wc -c $tmpfile | awk '{print $1}') + cat $specbundle >> $tmpfile + V_LEN=$(wc -c $tmpfile | awk '{print $1}') - # Create temp file with frontmatter and Redoc html - if [[ $frontmatterVersion == "v3" ]]; then - echo "$v3frontmatter" >> $version$outFilename.tmp - else - echo "$v2frontmatter" >> $version$outFilename.tmp - fi - buildHugoTemplate $version v2 $outFilename + if ! [[ $V_LEN -gt $V_LEN_INIT ]] + then + echo "Error: bundle was not appended to $tmpfile" + exit $? fi - # If the v1 compatibility spec file differs from master, regenerate the HTML. - filePath="${version}/swaggerV1Compat.yml" - update=0 + rm -f $specbundle + # Create the directory and move the file. + if [ ! -z "$apiName" ]; then + mkdir -p ../content/influxdb/$product/api/$apiName + mv $tmpfile ../content/influxdb/$product/api/$apiName/_index.html + else + mkdir -p ../content/influxdb/$product/api + mv $tmpfile ../content/influxdb/$product/api/_index.html + fi +} - if [ -e "$filePath" ]; then +function build { +# Get the list of products from directory names +products="$(ls -d -- */ | grep -v 'node_modules' | grep -v 'openapi')" + +for product in $products; do + #Trim the trailing slash off the directory name + product="${product%/}" + # Get the product API configuration file. + configPath="$product/.config.yml" + if [ ! -f $configPath ]; then + configPath=".config.yml" + fi + echo "Checking product config $configPath" + # Get the product name from the configuration. + productName=$(yq e '.x-influxdata-product-name' $configPath) + if [[ -z "$productName" ]]; then + productName=InfluxDB + fi + # Get an array of product API names (keys) from the configuration file + apis=$(yq e '.apis | keys | .[]' $configPath) + # Read each element of the apis array + while IFS= read -r api; do + # Get the spec file path from the configuration. + specRootPath=$(yq e ".apis | .$api | .root" $configPath) + # Check that the YAML spec file exists. + specPath="$product/$specRootPath" + echo "Checking for spec $specPath" + if [ -d "$specPath" ] || [ ! -f "$specPath" ]; then + echo "OpenAPI spec $specPath doesn't exist." + fi + # Get default status from the configuration. + isDefault=false + defaultStatus=$(yq e ".apis | .$api | .x-influxdata-default" $configPath) + if [[ $defaultStatus == "true" ]]; then + isDefault=true + fi + + # If the spec file differs from master, regenerate the HTML. + update=0 if [[ $generate_changed == 0 ]]; then - fileChanged=$(git diff --name-status master -- ${filePath}) - if [[ -z "$fileChanged" ]]; then - update=1 + diff=$(git diff --name-status master -- ${specPath}) + if [[ -z "$diff" ]]; then + update=1 fi fi if [[ $update -eq 0 ]]; then - outFilename="v1-compatibility" - titleSubmodule="v1 compatibility" - generateHtml $filePath $outFilename $titleVersion $titleSubmodule - - # Create temp file with frontmatter and Redoc html - echo "$v1compatfrontmatter" >> $version$outFilename.tmp - buildHugoTemplate $version v1 $outFilename + echo "Regenerating $product $api" + generateHtml "$specPath" "$product" "$productName" "$api" "$configPath" $isDefault fi - fi + done <<< "$apis" done +} + +build diff --git a/api-docs/getswagger.sh b/api-docs/getswagger.sh index b4d00869f..e3906b5a4 100755 --- a/api-docs/getswagger.sh +++ b/api-docs/getswagger.sh @@ -1,9 +1,9 @@ #!/bin/bash -e -# This script provides a simple way grab the latest fully resolved openapi (OAS, OpenAPI Specification) contract files -# from the influxdata/openapi repo. +# Use this script to retrieve the following InfluxData API specifications: +# - the latest, fully resolved openapi (OAS, OpenAPI Specification) contract files from the influxdata/openapi repo # -# Specify a platform to retrieve (cloud-serverless, cloud-dedicated, clustered, cloud, oss, v1compat, all). +# Specify a product to retrieve (cloud-serverless, cloud-dedicated, clustered, cloud, v2, v1-compatibility, all). # Optionally specify: # - an OSS version as the second argument or using the -o flag. # The version specifies where to write the updated openapi. @@ -15,16 +15,16 @@ # For local development, pass your openapi directory using the file:/// protocol. # To use the existing ref.yml and prevent fetching any openapi files, use the -B flag. # Syntax: -# sh ./getswagger.sh -# sh ./getswagger.sh -b -# sh ./getswagger.sh -c -o -b -# sh ./getswagger.sh -c -o -B +# sh ./getswagger.sh +# sh ./getswagger.sh -b +# sh ./getswagger.sh -c -o -b +# sh ./getswagger.sh -c -o -B # # Examples: # sh ./getswagger.sh cloud-serverless # sh ./getswagger.sh clustered -B # sh ./getswagger.sh cloud -# sh ./getswagger.sh -c oss -o v2.0 -b file:///Users/johnsmith/github/openapi +# sh ./getswagger.sh -c v2 -o v2.0 -b file:///Users/johnsmith/github/openapi versionDirs=($(ls -d */)) latestOSS=${versionDirs[${#versionDirs[@]}-1]} @@ -36,12 +36,12 @@ baseUrl="https://raw.githubusercontent.com/influxdata/openapi/master" baseUrlOSS="https://raw.githubusercontent.com/influxdata/openapi/docs-release/influxdb-oss" ossVersion=${latestOSS%/} verbose="" -platform="" +product="" function showHelp { - echo "Usage: ./getswagger.sh " + echo "Usage: ./getswagger.sh " echo " With optional arguments:" - echo " ./getswagger.sh -b -V" + echo " ./getswagger.sh -b -V" echo " ./getswagger.sh cloud" echo " ./getswagger.sh cloud-dedicated" echo " ./getswagger.sh cloud-serverless" @@ -62,8 +62,8 @@ function showHelp { subcommand=$1 case "$subcommand" in - cloud-dedicated|cloud-serverless|clustered|cloud|oss|v1compat|all) - platform=$1 + cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|all) + product=$1 shift while getopts ":o:b:BhV" opt; do @@ -103,7 +103,7 @@ case "$subcommand" in esac function showArgs { - echo "platform: $platform"; + echo "product: $product"; echo "baseUrl: $baseUrl"; echo "ossVersion: $ossVersion"; } @@ -112,98 +112,120 @@ function postProcess() { # Use npx to install and run the specified version of openapi-cli. # npm_config_yes=true npx overrides the prompt # and (vs. npx --yes) is compatible with npm@6 and npm@7. - specPath=$1 - platform="$2" - apiVersion="$3" + specPath="$1" + configPath="$2" + api="$3" + openapiCLI=" @redocly/cli" currentPath=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - npx --version + # TODO: Move some of this into the plugin: # Use Redoc's openapi-cli to regenerate the spec with custom decorations. # If you want to lint the source contract (before bundling), # pass `--lint` to the `bundle` command. - # If you set environment variables (for example, INFLUXDB_PLATFORM=) + # If you set environment variables (for example, INFLUXDB_PRODUCT=) # preceding the command name, you can then access the variables # in the NodeJS process.env global object. - INFLUXDB_API_VERSION=$apiVersion \ - INFLUXDB_PLATFORM=$platform \ +# INFLUXDB_API_VERSION=$apiVersion \ + npx --version + INFLUXDB_PRODUCT=$(dirname "$configPath") \ + INFLUXDB_API_NAME=$(echo "$api" | sed 's/@.*//g;') \ API_DOCS_ROOT_PATH=$currentPath \ npm_config_yes=true \ npx $openapiCLI bundle $specPath \ -o $specPath \ - --config=./.redocly.yaml + --config=$configPath } -function updateCloud { - outFile="cloud/ref.yml" + function updateCloudV2 { + outFile="cloud/v2/ref.yml" if [[ -z "$baseUrl" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile fi - postProcess $outFile cloud + postProcess $outFile 'cloud/.config.yml' v2@2 } -function updateCloudDedicated { - outFile="cloud-dedicated/ref.yml" +function updateCloudDedicatedManagement { + outFile="cloud-dedicated/management/openapi.yml" + if [[ -z "$baseUrl" ]]; + then + echo "Using existing $outFile" + else + curl $UPDATE_OPTIONS https://raw.githubusercontent.com/influxdata/granite/3117fb47d5e56afaadcebc226ff4b25785d95b5a/openapi.yaml -o $outFile + fi + postProcess $outFile 'cloud-dedicated/.config.yml' management@0 +} + +function updateCloudDedicatedV2 { + outFile="cloud-dedicated/v2/ref.yml" if [[ -z "$baseUrl" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile fi - postProcess $outFile cloud-dedicated + postProcess $outFile 'cloud-dedicated/.config.yml' v2@2 } -function updateClustered { - outFile="clustered/ref.yml" +function updateClusteredV2 { + outFile="clustered/v2/ref.yml" if [[ -z "$baseUrl" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile fi - postProcess $outFile clustered + postProcess $outFile 'clustered/.config.yml' v2@2 } -function updateCloudServerless { - outFile="cloud-serverless/ref.yml" +function updateCloudServerlessV2 { + outFile="cloud-serverless/v2/ref.yml" if [[ -z "$baseUrl" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile fi - postProcess $outFile cloud-serverless + postProcess $outFile 'cloud-serverless/.config.yml' v2@2 } -function updateOSS { - mkdir -p ${ossVersion} - outFile="$ossVersion/ref.yml" +function updateOSSV2 { + outFile="v2/ref.yml" if [[ -z "$baseUrlOSS" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile fi - postProcess $outFile $ossVersion + postProcess $outFile 'v2/.config.yml' '@2' } function updateV1Compat { - outFile="cloud/swaggerV1Compat.yml" + outFile="cloud/v1-compatibility/swaggerV1Compat.yml" if [[ -z "$baseUrl" ]]; then echo "Using existing $outFile" else curl $UPDATE_OPTIONS ${baseUrl}/contracts/swaggerV1Compat.yml -o $outFile fi - postProcess $outFile cloud v1compat + postProcess $outFile 'cloud/.config.yml' 'v1-compatibility' - outFile="$ossVersion/swaggerV1Compat.yml" - mkdir -p ${ossVersion} && cp cloud/swaggerV1Compat.yml $outFile - postProcess $outFile $ossVersion v1compat + outFile="v2/v1-compatibility/swaggerV1Compat.yml" + cp cloud/v1-compatibility/swaggerV1Compat.yml $outFile + postProcess $outFile 'v2/.config.yml' 'v1-compatibility' + + outFile="cloud-dedicated/v1-compatibility/swaggerV1Compat.yml" + postProcess $outFile 'cloud-dedicated/.config.yml' 'v1-compatibility' + + outFile="cloud-serverless/v1-compatibility/swaggerV1Compat.yml" + postProcess $outFile 'cloud-serverless/.config.yml' 'v1-compatibility' + + outFile="clustered/v1-compatibility/swaggerV1Compat.yml" + postProcess $outFile 'clustered/.config.yml' 'v1-compatibility' } UPDATE_OPTIONS="--fail" @@ -215,33 +237,37 @@ then echo "" fi -if [ "$platform" = "cloud" ]; +if [ "$product" = "cloud-v2" ]; then - updateCloud -elif [ "$platform" = "cloud-dedicated" ]; + updateCloudV2 +elif [ "$product" = "cloud-dedicated-v2" ]; then - updateCloudDedicated -elif [ "$platform" = "cloud-serverless" ]; + updateCloudDedicatedV2 +elif [ "$product" = "cloud-dedicated-management" ]; then - updateCloudServerless -elif [ "$platform" = "clustered" ]; + updateCloudDedicatedManagement +elif [ "$product" = "cloud-serverless-v2" ]; then - updateClustered -elif [ "$platform" = "oss" ]; + updateCloudServerlessV2 +elif [ "$product" = "clustered-v2" ]; then - updateOSS -elif [ "$platform" = "v1compat" ]; + updateClusteredV2 +elif [ "$product" = "v2" ]; +then + updateOSSV2 +elif [ "$product" = "v1-compat" ]; then updateV1Compat -elif [ "$platform" = "all" ]; +elif [ "$product" = "all" ]; then - updateCloud - updateCloudDedicated - updateCloudServerless - updateClustered - updateOSS + updateCloudV2 + updateCloudDedicatedV2 + updateCloudDedicatedManagement + updateCloudServerlessV2 + updateClusteredV2 + updateOSSV2 updateV1Compat else - echo "Provide a platform argument: cloud, cloud-serverless, cloud-dedicated, clustered, oss, v1compat, or all." + echo "Provide a product argument: cloud-v2, cloud-serverless-v2, cloud-dedicated-v2, clustered-v2, v2, v1-compat, or all." showHelp fi diff --git a/api-docs/openapi/plugins/decorators/replace-shortcodes.js b/api-docs/openapi/plugins/decorators/replace-shortcodes.js index 52c46b5d0..ab4846372 100644 --- a/api-docs/openapi/plugins/decorators/replace-shortcodes.js +++ b/api-docs/openapi/plugins/decorators/replace-shortcodes.js @@ -6,12 +6,12 @@ function replaceDocsUrl(field) { * [^]* matches line breaks. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#using_regular_expression_on_multiple_lines */ const shortcode = /\{\{%([^]|\s)*?INFLUXDB_DOCS_URL([^]|\s)*?%\}\}/g - let replacement = `/influxdb/${process.env.INFLUXDB_PLATFORM}`; + let replacement = `/influxdb/${process.env.INFLUXDB_PRODUCT}`; field = field.replaceAll(shortcode, replacement) .replaceAll('https://docs.influxdata.com/influxdb/', '/influxdb/'); - if(process.env.INFLUXDB_PLATFORM === 'cloud-iox') { + if(process.env.INFLUXDB_PRODUCT === 'cloud-iox') { field = field.replaceAll('/influxdb/cloud/', `${replacement}/`); } return field; diff --git a/api-docs/openapi/plugins/decorators/servers/set-servers.js b/api-docs/openapi/plugins/decorators/servers/set-servers.js index 774495926..6effbfde0 100644 --- a/api-docs/openapi/plugins/decorators/servers/set-servers.js +++ b/api-docs/openapi/plugins/decorators/servers/set-servers.js @@ -8,6 +8,9 @@ module.exports = SetServers; * Object key "Server" is an OAS 3.0 node type. */ function SetServers(data) { + if (!data) { + data = [ { url: '/' } ]; + } return { DefinitionRoot: { leave(root) { diff --git a/api-docs/openapi/plugins/decorators/set-info.js b/api-docs/openapi/plugins/decorators/set-info.js index 41974c010..db899f33b 100644 --- a/api-docs/openapi/plugins/decorators/set-info.js +++ b/api-docs/openapi/plugins/decorators/set-info.js @@ -11,6 +11,11 @@ function SetInfo(data) { } if(data.hasOwnProperty('version')) { info.version = data.version; + } else { + info['version'] = ''; + } + if(data.hasOwnProperty('summary')) { + info.summary = data.summary; } if(data.hasOwnProperty('description')) { info.description = data.description; diff --git a/api-docs/openapi/plugins/docs-content.js b/api-docs/openapi/plugins/docs-content.js index 6855a179f..975b2ad6b 100644 --- a/api-docs/openapi/plugins/docs-content.js +++ b/api-docs/openapi/plugins/docs-content.js @@ -3,15 +3,22 @@ const { toJSON } = require('./helpers/content-helper'); function getVersioned(filename) { const apiDocsRoot=path.resolve(process.env.API_DOCS_ROOT_PATH || process.cwd()); - const contentPath = path.join(apiDocsRoot, process.env.INFLUXDB_PLATFORM, 'content'); - - return toJSON(path.join(contentPath, (process.env.INFLUXDB_API_VERSION || ''), filename)); + let contentPath = path.join(apiDocsRoot, process.env.INFLUXDB_PRODUCT, process.env.INFLUXDB_API_NAME, 'content'); + content = toJSON(path.join(contentPath, filename)); + if (content) { + return content; + } else { + // If the content is not found in the product/api folder, try the product folder + return toJSON(path.join(apiDocsRoot, process.env.INFLUXDB_PRODUCT, 'content', filename)); + } } const info = () => getVersioned('info.yml'); +const servers = () => getVersioned('servers.yml'); const tagGroups = () => getVersioned('tag-groups.yml'); module.exports = { info, + servers, tagGroups, } diff --git a/api-docs/openapi/plugins/docs-plugin.js b/api-docs/openapi/plugins/docs-plugin.js index bcc1c5f1d..ebeacd7ac 100644 --- a/api-docs/openapi/plugins/docs-plugin.js +++ b/api-docs/openapi/plugins/docs-plugin.js @@ -1,4 +1,4 @@ -const {info, tagGroups} = require('./docs-content'); +const {info, servers, tagGroups} = require('./docs-content'); const ReportTags = require('./rules/report-tags'); const ValidateServersUrl = require('./rules/validate-servers-url'); const RemovePrivatePaths = require('./decorators/paths/remove-private-paths'); @@ -23,7 +23,7 @@ const rules = { /** @type {import('@redocly/openapi-cli').CustomRulesConfig} */ const decorators = { oas3: { - 'set-servers': () => SetServers([ { url: '/' } ]), + 'set-servers': () => SetServers(servers()), 'delete-servers': DeleteServers, 'remove-private-paths': RemovePrivatePaths, 'strip-version-prefix': StripVersionPrefix, diff --git a/api-docs/openapi/plugins/helpers/content-helper.js b/api-docs/openapi/plugins/helpers/content-helper.js index 384379910..2785a5a58 100644 --- a/api-docs/openapi/plugins/helpers/content-helper.js +++ b/api-docs/openapi/plugins/helpers/content-helper.js @@ -51,9 +51,7 @@ function toJSON(yamlPath) { try { return yaml.load(fs.readFileSync(yamlPath, 'utf8')); } catch (e) { - /** No file, no harm, no foul. **/ - // console.log(e); - } + } } module.exports = { diff --git a/api-docs/template.hbs b/api-docs/template.hbs index 343653800..fe42b6a74 100755 --- a/api-docs/template.hbs +++ b/api-docs/template.hbs @@ -12,7 +12,7 @@ {{title}} - + @@ -39,7 +39,7 @@ {{{redocHTML}}} diff --git a/api-docs/v2/.config.yml b/api-docs/v2/.config.yml new file mode 100644 index 000000000..ffcc1e885 --- /dev/null +++ b/api-docs/v2/.config.yml @@ -0,0 +1,13 @@ +plugins: + - '../openapi/plugins/docs-plugin.js' +extends: + - recommended + - docs/all +x-influxdata-product-name: InfluxDB v2 OSS + +apis: + '@2': + root: ref.yml + x-influxdata-default: true + v1-compatibility@2: + root: v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/v2/content/info.yml b/api-docs/v2/content/info.yml index d69641793..f381806c2 100644 --- a/api-docs/v2/content/info.yml +++ b/api-docs/v2/content/info.yml @@ -1,10 +1,11 @@ title: InfluxDB OSS API Service -version: 2.7.0 +summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. This documentation is generated from the [InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/ref/oss.yml). +version: 2.x license: name: MIT url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/v2/content/v1compat/info.yml b/api-docs/v2/content/v1compat/info.yml deleted file mode 100644 index c1bc8d3e2..000000000 --- a/api-docs/v2/content/v1compat/info.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: InfluxDB OSS v1 compatibility API documentation -version: 2.7.0 v1 compatibility -description: | - The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. - - If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/latest/api/). - - This documentation is generated from the - [InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/swaggerV1Compat.yml). -license: - name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file diff --git a/api-docs/v2/ref.yml b/api-docs/v2/ref.yml index 01673a1aa..687c6ed68 100644 --- a/api-docs/v2/ref.yml +++ b/api-docs/v2/ref.yml @@ -1,6721 +1,314 @@ -components: - examples: - AuthorizationPostRequest: - description: Creates an authorization. - summary: An authorization for a resource type - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - type: buckets - AuthorizationWithResourcePostRequest: - description: Creates an authorization for access to a specific resource. - summary: An authorization for a resource - value: - description: iot_users read buckets - orgID: INFLUX_ORG_ID - permissions: - - action: read - resource: - id: INFLUX_BUCKET_ID - type: buckets - AuthorizationWithUserPostRequest: - description: Creates an authorization scoped to a specific user. - summary: An authorization scoped to a user - value: - description: iot_user write to bucket - orgID: INFLUX_ORG_ID - permissions: - - action: write - resource: - id: INFLUX_BUCKET_ID - type: buckets - userID: INFLUX_USER_ID - TaskWithFluxRequest: - description: Sets the `flux` property with Flux task options and a query. - summary: A task with Flux - value: - description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. - flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" - status: active - parameters: - After: - description: | - A resource ID to seek from. - Returns records created after the specified record; - results don't include the specified record. - - Use `after` instead of the `offset` parameter. - For more information about pagination parameters, see [Pagination](/influxdb/latest/api/#tag/Pagination). - in: query - name: after - required: false - schema: - type: string - Descending: - in: query - name: descending - required: false - schema: - default: false - type: boolean - Limit: - description: | - Limits the number of records returned. Default is `20`. - in: query - name: limit - required: false - schema: - default: 20 - maximum: 100 - minimum: 1 - type: integer - Offset: - description: | - The offset for pagination. - The number of records to skip. - - For more information about pagination parameters, see [Pagination](/influxdb/latest/api/#tag/Pagination). - in: query - name: offset - required: false - schema: - minimum: 0 - type: integer - SortBy: - in: query - name: sortBy - required: false - schema: - type: string - TraceSpan: - description: OpenTracing span context - example: - baggage: - key: value - span_id: '1' - trace_id: '1' - in: header - name: Zap-Trace-Span - required: false - schema: - type: string - responses: - AuthorizationError: - content: - application/json: - examples: - tokenNotAuthorized: - summary: Token is not authorized to access a resource - value: - code: unauthorized - message: unauthorized access - schema: - properties: - code: - description: | - The HTTP status code description. Default is `unauthorized`. - enum: - - unauthorized - readOnly: true - type: string - message: - description: A human-readable message that may contain detail about the error. - readOnly: true - type: string - description: | - Unauthorized. The error may indicate one of the following: - - * The `Authorization: Token` header is missing or malformed. - * The API token value is missing from the header. - * The token doesn't have sufficient permissions to write to this organization and bucket. - BadRequestError: - content: - application/json: - examples: - orgProvidedNotFound: - summary: The org or orgID passed doesn't own the token passed in the header - value: - code: invalid - message: 'failed to decode request body: organization not found' - schema: - $ref: '#/components/schemas/Error' - description: | - Bad request. - The response body contains detail about the error. - - #### InfluxDB OSS - - - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. - GeneralServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - InternalServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: | - Internal server error. - The server encountered an unexpected situation. - ResourceNotFoundError: - content: - application/json: - examples: - bucket-not-found: - summary: Bucket name not found - value: - code: not found - message: bucket "air_sensor" not found - org-not-found: - summary: Organization name not found - value: - code: not found - message: organization name "my-org" not found - orgID-not-found: - summary: Organization ID not found - value: - code: not found - message: organization not found - schema: - $ref: '#/components/schemas/Error' - description: | - Not found. - A requested resource was not found. - The response body contains the requested resource type and the name value - (if you passed it)--for example: - - - `"organization name \"my-org\" not found"` - - `"organization not found"`: indicates you passed an ID that did not match - an organization. - ServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Non 2XX error response from server. - schemas: - ASTResponse: - description: Contains the AST for the supplied Flux query - properties: - ast: - $ref: '#/components/schemas/Package' - type: object - AddResourceMemberRequestBody: - properties: - id: - description: | - The ID of the user to add to the resource. - type: string - name: - description: | - The name of the user to add to the resource. - type: string - required: - - id - type: object - AnalyzeQueryResponse: - properties: - errors: - items: - properties: - character: - type: integer - column: - type: integer - line: - type: integer - message: - type: string - type: object - type: array - type: object - ArrayExpression: - description: Used to create and directly specify the elements of an array object - properties: - elements: - description: Elements of the array - items: - $ref: '#/components/schemas/Expression' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - Authorization: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - createdAt: - format: date-time - readOnly: true - type: string - id: - description: The authorization ID. - readOnly: true - type: string - links: - example: - self: /api/v2/authorizations/1 - user: /api/v2/users/12 - properties: - self: - $ref: '#/components/schemas/Link' - readOnly: true - user: - $ref: '#/components/schemas/Link' - readOnly: true - readOnly: true - type: object - org: - description: | - The organization name. - Specifies the [organization](/influxdb/v2.7/reference/glossary/#organization) - that the token is scoped to. - readOnly: true - type: string - orgID: - description: | - The organization ID. - Specifies the [organization](/influxdb/v2.7/reference/glossary/#organization) that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions. - An authorization must have at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: | - The API token. - The token value is unique to the authorization. - [API tokens](/influxdb/v2.7/reference/glossary/#token) are - used to authenticate and authorize InfluxDB API requests and `influx` - CLI commands--after receiving the request, InfluxDB checks that the - token is valid and that the `permissions` allow the requested action(s). - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - user: - description: | - The user name. - Specifies the [user](/influxdb/v2.7/reference/glossary/#user) that owns the authorization. - If the authorization is _scoped_ to a user, the user; - otherwise, the creator of the authorization. - readOnly: true - type: string - userID: - description: The user ID. Specifies the [user](/influxdb/v2.7/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. - readOnly: true - type: string - type: object - required: - - orgID - - permissions - AuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: | - An organization ID. - Specifies the organization that owns the authorization. - type: string - permissions: - description: | - A list of permissions for an authorization. - In the list, provide at least one `permission` object. - - In a `permission`, the `resource.type` property grants access to all - resources of the specified type. - To grant access to only a specific resource, specify the - `resource.id` property. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - userID: - description: | - A user ID. - Specifies the user that the authorization is scoped to. - - When a user authenticates with username and password, - InfluxDB generates a _user session_ with all the permissions - specified by all the user's authorizations. - type: string - type: object - required: - - orgID - - permissions - AuthorizationUpdateRequest: - properties: - description: - description: A description of the token. - type: string - status: - default: active - description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. - enum: - - active - - inactive - type: string - Authorizations: - properties: - authorizations: - items: - $ref: '#/components/schemas/Authorization' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - Axes: - description: The viewport for a View's visualizations - properties: - x: - $ref: '#/components/schemas/Axis' - 'y': - $ref: '#/components/schemas/Axis' - required: - - x - - 'y' - type: object - Axis: - description: Axis used in a visualization. - properties: - base: - description: Radix for formatting axis values. - enum: - - '' - - '2' - - '10' - type: string - bounds: - description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. - items: - type: string - maxItems: 2 - minItems: 0 - type: array - label: - description: Description of the axis. - type: string - prefix: - description: Label prefix for formatting axis values. - type: string - scale: - $ref: '#/components/schemas/AxisScale' - suffix: - description: Label suffix for formatting axis values. - type: string - type: object - AxisScale: - description: 'Scale is the axis formatting scale. Supported: "log", "linear"' - enum: - - log - - linear - type: string - BadStatement: - description: A placeholder for statements for which no correct statement nodes can be created - properties: - text: - description: Raw source text - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - BandViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - lowerColumn: - type: string - mainColumn: - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - band - type: string - upperColumn: - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - type: object - BinaryExpression: - description: uses binary operators to act on two operands in an expression - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Block: - description: A set of statements - properties: - body: - description: Block body - items: - $ref: '#/components/schemas/Statement' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - BooleanLiteral: - description: Represents boolean values - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: boolean - type: object - Bucket: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/buckets/1/labels - members: /api/v2/buckets/1/members - org: /api/v2/orgs/2 - owners: /api/v2/buckets/1/owners - self: /api/v2/buckets/1 - write: /api/v2/write?org=2&bucket=1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this bucket. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members that can read this bucket. - org: - $ref: '#/components/schemas/Link' - description: The URL to retrieve parent organization for this bucket. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners that can read and write to this bucket. - self: - $ref: '#/components/schemas/Link' - description: The URL for this bucket. - write: - $ref: '#/components/schemas/Link' - description: The URL to write line protocol to this bucket. - readOnly: true - type: object - name: - type: string - orgID: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - type: - default: user - enum: - - user - - system - readOnly: true - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - retentionRules - BucketMetadataManifest: - properties: - bucketID: - type: string - bucketName: - type: string - defaultRetentionPolicy: - type: string - description: - type: string - organizationID: - type: string - organizationName: - type: string - retentionPolicies: - $ref: '#/components/schemas/RetentionPolicyManifests' - required: - - organizationID - - organizationName - - bucketID - - bucketName - - defaultRetentionPolicy - - retentionPolicies - type: object - BucketMetadataManifests: - items: - $ref: '#/components/schemas/BucketMetadataManifest' - type: array - BucketShardMapping: - properties: - newId: - format: int64 - type: integer - oldId: - format: int64 - type: integer - required: - - oldId - - newId - type: object - BucketShardMappings: - items: - $ref: '#/components/schemas/BucketShardMapping' - type: array - Buckets: - properties: - buckets: - items: - $ref: '#/components/schemas/Bucket' - type: array - links: - $ref: '#/components/schemas/Links' - readOnly: true - type: object - BuilderAggregateFunctionType: - enum: - - filter - - group - type: string - BuilderConfig: - properties: - aggregateWindow: - properties: - fillValues: - type: boolean - period: - type: string - type: object - buckets: - items: - type: string - type: array - functions: - items: - $ref: '#/components/schemas/BuilderFunctionsType' - type: array - tags: - items: - $ref: '#/components/schemas/BuilderTagsType' - type: array - type: object - BuilderFunctionsType: - properties: - name: - type: string - type: object - BuilderTagsType: - properties: - aggregateFunctionType: - $ref: '#/components/schemas/BuilderAggregateFunctionType' - key: - type: string - values: - items: - type: string - type: array - type: object - BuiltinStatement: - description: Declares a builtin identifier and its type - properties: - id: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - CallExpression: - description: Represents a function call - properties: - arguments: - description: Function arguments - items: - $ref: '#/components/schemas/Expression' - type: array - callee: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Cell: - properties: - h: - format: int32 - type: integer - id: - type: string - links: - properties: - self: - type: string - view: - type: string - type: object - viewID: - description: The reference to a view from the views API. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellUpdate: - properties: - h: - format: int32 - type: integer - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CellWithViewProperties: - allOf: - - $ref: '#/components/schemas/Cell' - - properties: - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - type: object - type: object - Cells: - items: - $ref: '#/components/schemas/Cell' - type: array - CellsWithViewProperties: - items: - $ref: '#/components/schemas/CellWithViewProperties' - type: array - Check: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - CheckBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the check. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/checks/1/labels - members: /api/v2/checks/1/members - owners: /api/v2/checks/1/owners - query: /api/v2/checks/1/query - self: /api/v2/checks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this check. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this check. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this check. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this check. - self: - $ref: '#/components/schemas/Link' - description: The URL for this check. - readOnly: true - type: object - name: - type: string - orgID: - description: The ID of the organization that owns this check. - type: string - ownerID: - description: The ID of creator used to create this check. - readOnly: true - type: string - query: - $ref: '#/components/schemas/DashboardQuery' - status: - $ref: '#/components/schemas/TaskStatusType' - taskID: - description: The ID of the task associated with this check. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - - orgID - - query - CheckDiscriminator: - discriminator: - mapping: - custom: '#/components/schemas/CustomCheck' - deadman: '#/components/schemas/DeadmanCheck' - threshold: '#/components/schemas/ThresholdCheck' - propertyName: type - oneOf: - - $ref: '#/components/schemas/DeadmanCheck' - - $ref: '#/components/schemas/ThresholdCheck' - - $ref: '#/components/schemas/CustomCheck' - CheckPatch: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - CheckStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - type: string - CheckViewProperties: - properties: - adaptiveZoomHide: - type: boolean - check: - $ref: '#/components/schemas/Check' - checkID: - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - check - type: string - required: - - type - - shape - - checkID - - queries - - colors - type: object - Checks: - properties: - checks: - items: - $ref: '#/components/schemas/Check' - type: array - links: - $ref: '#/components/schemas/Links' - ColorMapping: - additionalProperties: - type: string - description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. - example: - configcat_deployments-autopromotionblocker: '#663cd0' - measurement_birdmigration_europe: '#663cd0' - series_id_1: '#edf529' - series_id_2: '#edf529' - type: object - ConditionalExpression: - description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` - properties: - alternate: - $ref: '#/components/schemas/Expression' - consequent: - $ref: '#/components/schemas/Expression' - test: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Config: - properties: - config: - type: object - type: object - ConstantVariableProperties: - properties: - type: - enum: - - constant - type: string - values: - items: - type: string - type: array - CreateCell: - properties: - h: - format: int32 - type: integer - name: - type: string - usingView: - description: Makes a copy of the provided view. - type: string - w: - format: int32 - type: integer - x: - format: int32 - type: integer - 'y': - format: int32 - type: integer - type: object - CreateDashboardRequest: - properties: - description: - description: The user-facing description of the dashboard. - type: string - name: - description: The user-facing name of the dashboard. - type: string - orgID: - description: The ID of the organization that owns the dashboard. - type: string - required: - - orgID - - name - CustomCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - type: - enum: - - custom - type: string - required: - - type - type: object - DBRP: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - If set to `true`, this DBRP mapping is the default retention policy - for the database (specified by the `database` property's value). - type: boolean - id: - description: | - The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. - readOnly: true - type: string - links: - $ref: '#/components/schemas/Links' - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - virtual: - description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. - type: boolean - required: - - id - - orgID - - bucketID - - database - - retention_policy - - default - type: object - DBRPCreate: - properties: - bucketID: - description: | - A bucket ID. - Identifies the bucket used as the target for the translation. - type: string - database: - description: | - A database name. - Identifies the InfluxDB v1 database. - type: string - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - type: boolean - org: - description: | - An organization name. - Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. - type: string - orgID: - description: | - An organization ID. - Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. - type: string - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - required: - - bucketID - - database - - retention_policy - type: object - DBRPGet: - properties: - content: - $ref: '#/components/schemas/DBRP' - required: true - type: object - DBRPUpdate: - properties: - default: - description: | - Set to `true` to use this DBRP mapping as the default retention policy - for the database (specified by the `database` property's value). - To remove the default mapping, set to `false`. - type: boolean - retention_policy: - description: | - A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. - Identifies the InfluxDB v1 retention policy mapping. - type: string - DBRPs: - properties: - content: - items: - $ref: '#/components/schemas/DBRP' - type: array - Dashboard: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/Cells' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - DashboardColor: - description: Defines an encoding of data value into color space. - properties: - hex: - description: The hex number of the color - maxLength: 7 - minLength: 7 - type: string - id: - description: The unique ID of the view color. - type: string - name: - description: The user-facing name of the hex color. - type: string - type: - description: Type is how the color is used. - enum: - - min - - max - - threshold - - scale - - text - - background - type: string - value: - description: The data value mapped to this color. - format: float - type: number - required: - - id - - type - - hex - - name - - value - type: object - DashboardQuery: - properties: - builderConfig: - $ref: '#/components/schemas/BuilderConfig' - editMode: - $ref: '#/components/schemas/QueryEditMode' - name: - type: string - text: - description: The text of the Flux query. - type: string - type: object - DashboardWithViewProperties: - allOf: - - $ref: '#/components/schemas/CreateDashboardRequest' - - properties: - cells: - $ref: '#/components/schemas/CellsWithViewProperties' - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - cells: /api/v2/dashboards/1/cells - labels: /api/v2/dashboards/1/labels - members: /api/v2/dashboards/1/members - org: /api/v2/labels/1 - owners: /api/v2/dashboards/1/owners - self: /api/v2/dashboards/1 - properties: - cells: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - org: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - type: object - meta: - properties: - createdAt: - format: date-time - type: string - updatedAt: - format: date-time - type: string - type: object - type: object - type: object - Dashboards: - properties: - dashboards: - items: - $ref: '#/components/schemas/Dashboard' - type: array - links: - $ref: '#/components/schemas/Links' - type: object - DateTimeLiteral: - description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp). - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - format: date-time - type: string - type: object - DeadmanCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - level: - $ref: '#/components/schemas/CheckStatusLevel' - offset: - description: Duration to delay after the schedule, before executing check. - type: string - reportZero: - description: If only zero values reported since time, trigger an alert - type: boolean - staleTime: - description: String duration for time that a series is considered stale and should not trigger deadman. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - timeSince: - description: String duration before deadman triggers. - type: string - type: - enum: - - deadman - type: string - required: - - type - type: object - DecimalPlaces: - description: Indicates whether decimal places should be enforced, and how many digits it should show. - properties: - digits: - description: The number of digits after decimal to display - format: int32 - type: integer - isEnforced: - description: Indicates whether decimal point setting should be enforced - type: boolean - type: object - DeletePredicateRequest: - description: The delete predicate request. - properties: - predicate: - description: | - An expression in [delete predicate syntax](/influxdb/latest/reference/syntax/delete-predicate/). - example: tag1="value1" and (tag2="value2" and tag3!="value3") - type: string - start: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)). - The earliest time to delete from. - format: date-time - type: string - stop: - description: | - A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)). - The latest time to delete from. - format: date-time - type: string - required: - - start - - stop - type: object - Dialect: - description: | - Options for tabular data output. - Default output is [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/#csv-response-format) with headers. - - For more information about tabular data **dialect**, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). - properties: - annotations: - description: | - Annotation rows to include in the results. - An _annotation_ is metadata associated with an object (column) in the data model. - - #### Related guides - - - See [Annotated CSV annotations](/influxdb/latest/reference/syntax/annotated-csv/#annotations) for examples and more information. - - For more information about **annotations** in tabular data, - see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). - items: - enum: - - group - - datatype - - default - type: string - type: array - uniqueItems: true - commentPrefix: - default: '#' - description: The character prefixed to comment strings. Default is a number sign (`#`). - maxLength: 1 - minLength: 0 - type: string - dateTimeFormat: - default: RFC3339 - description: | - The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp). - To include nanoseconds in timestamps, use `RFC3339Nano`. - - #### Example formatted date/time values - - | Format | Value | - |:------------|:----------------------------| - | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | - | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | - enum: - - RFC3339 - - RFC3339Nano - type: string - delimiter: - default: ',' - description: The separator used between cells. Default is a comma (`,`). - maxLength: 1 - minLength: 1 - type: string - header: - default: true - description: If true, the results contain a header row. - type: boolean - type: object - DictExpression: - description: Used to create and directly specify the elements of a dictionary - properties: - elements: - description: Elements of the dictionary - items: - $ref: '#/components/schemas/DictItem' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - DictItem: - description: A key-value pair in a dictionary. - properties: - key: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - val: - $ref: '#/components/schemas/Expression' - type: object - Duration: - description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. - properties: - magnitude: - type: integer - type: - $ref: '#/components/schemas/NodeType' - unit: - type: string - type: object - DurationLiteral: - description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration - properties: - type: - $ref: '#/components/schemas/NodeType' - values: - description: Duration values - items: - $ref: '#/components/schemas/Duration' - type: array - type: object - Error: - properties: - code: - $ref: '#/components/schemas/ErrorCode' - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - ErrorCode: - description: code is the machine-readable error code. - enum: - - internal error - - not implemented - - not found - - conflict - - invalid - - unprocessable entity - - empty value - - unavailable - - forbidden - - too many requests - - unauthorized - - method not allowed - - request too large - - unsupported media type - readOnly: true - type: string - Expression: - oneOf: - - $ref: '#/components/schemas/ArrayExpression' - - $ref: '#/components/schemas/DictExpression' - - $ref: '#/components/schemas/FunctionExpression' - - $ref: '#/components/schemas/BinaryExpression' - - $ref: '#/components/schemas/CallExpression' - - $ref: '#/components/schemas/ConditionalExpression' - - $ref: '#/components/schemas/LogicalExpression' - - $ref: '#/components/schemas/MemberExpression' - - $ref: '#/components/schemas/IndexExpression' - - $ref: '#/components/schemas/ObjectExpression' - - $ref: '#/components/schemas/ParenExpression' - - $ref: '#/components/schemas/PipeExpression' - - $ref: '#/components/schemas/UnaryExpression' - - $ref: '#/components/schemas/BooleanLiteral' - - $ref: '#/components/schemas/DateTimeLiteral' - - $ref: '#/components/schemas/DurationLiteral' - - $ref: '#/components/schemas/FloatLiteral' - - $ref: '#/components/schemas/IntegerLiteral' - - $ref: '#/components/schemas/PipeLiteral' - - $ref: '#/components/schemas/RegexpLiteral' - - $ref: '#/components/schemas/StringLiteral' - - $ref: '#/components/schemas/UnsignedIntegerLiteral' - - $ref: '#/components/schemas/Identifier' - ExpressionStatement: - description: May consist of an expression that doesn't return a value and is executed solely for its side-effects - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Field: - properties: - alias: - description: Alias overrides the field name in the returned response. Applies only if type is `func` - type: string - args: - description: Args are the arguments to the function - items: - $ref: '#/components/schemas/Field' - type: array - type: - description: '`type` describes the field type. `func` is a function. `field` is a field reference.' - enum: - - func - - field - - integer - - number - - regex - - wildcard - type: string - value: - description: value is the value of the field. Meaning of the value is implied by the `type` key - type: string - type: object - File: - description: Represents a source from a single file - properties: - body: - description: List of Flux statements - items: - $ref: '#/components/schemas/Statement' - type: array - imports: - description: A list of package imports - items: - $ref: '#/components/schemas/ImportDeclaration' - type: array - name: - description: The name of the file. - type: string - package: - $ref: '#/components/schemas/PackageClause' - type: - $ref: '#/components/schemas/NodeType' - type: object - Flags: - additionalProperties: true - type: object - FloatLiteral: - description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: number - type: object - FluxResponse: - description: Rendered flux that backs the check or notification. - properties: - flux: - type: string - FluxSuggestion: - properties: - name: - type: string - params: - additionalProperties: - type: string - type: object - type: object - FluxSuggestions: - properties: - funcs: - items: - $ref: '#/components/schemas/FluxSuggestion' - type: array - type: object - FunctionExpression: - description: Function expression - properties: - body: - $ref: '#/components/schemas/Node' - params: - description: Function parameters - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - GaugeViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - gauge - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - GeoCircleViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Circle color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - interpolateColors: - description: Interpolate circle color based on displayed value - type: boolean - radius: - description: Maximum radius size in pixels - type: integer - radiusDimension: - $ref: '#/components/schemas/Axis' - radiusField: - description: Radius field - type: string - required: - - radiusField - - radiusDimension - - colorField - - colorDimension - - colors - type: object - GeoHeatMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - blur: - description: Blur for heatmap points - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - intensityDimension: - $ref: '#/components/schemas/Axis' - intensityField: - description: Intensity field - type: string - radius: - description: Radius size in pixels - type: integer - required: - - intensityField - - intensityDimension - - radius - - blur - - colors - type: object - GeoPointMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - properties: - colorDimension: - $ref: '#/components/schemas/Axis' - colorField: - description: Marker color field - type: string - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - isClustered: - description: Cluster close markers together - type: boolean - tooltipColumns: - description: An array for which columns to display in tooltip - items: - type: string - type: array - required: - - colorField - - colorDimension - - colors - type: object - GeoTrackMapViewLayer: - allOf: - - $ref: '#/components/schemas/GeoViewLayerProperties' - - required: - - trackWidth - - speed - - randomColors - - trackPointVisualization - type: object - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - randomColors: - description: Assign different colors to different tracks - type: boolean - speed: - description: Speed of the track animation - type: integer - trackWidth: - description: Width of the track - type: integer - GeoViewLayer: - oneOf: - - $ref: '#/components/schemas/GeoCircleViewLayer' - - $ref: '#/components/schemas/GeoHeatMapViewLayer' - - $ref: '#/components/schemas/GeoPointMapViewLayer' - - $ref: '#/components/schemas/GeoTrackMapViewLayer' - type: object - GeoViewLayerProperties: - properties: - type: - enum: - - heatmap - - circleMap - - pointMap - - trackMap - type: string - required: - - type - type: object - GeoViewProperties: - properties: - allowPanAndZoom: - default: true - description: If true, map zoom and pan controls are enabled on the dashboard view - type: boolean - center: - description: Coordinates of the center of the map - properties: - lat: - description: Latitude of the center of the map - format: double - type: number - lon: - description: Longitude of the center of the map - format: double - type: number - required: - - lat - - lon - type: object - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - detectCoordinateFields: - default: true - description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns - type: boolean - latLonColumns: - $ref: '#/components/schemas/LatLonColumns' - layers: - description: List of individual layers shown in the map - items: - $ref: '#/components/schemas/GeoViewLayer' - type: array - mapStyle: - description: Define map type - regular, satellite etc. - type: string - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - s2Column: - description: String to define the column - type: string - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - geo - type: string - useS2CellID: - description: If true, S2 column is used to calculate lat/lon - type: boolean - zoom: - description: Zoom level used for initial display of the map - format: double - maximum: 28 - minimum: 1 - type: number - required: - - type - - shape - - queries - - note - - showNoteWhenEmpty - - center - - zoom - - allowPanAndZoom - - detectCoordinateFields - - layers - type: object - GreaterThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - greater - type: string - value: - format: float - type: number - required: - - type - - value - type: object - HTTPNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - authMethod: - enum: - - none - - basic - - bearer - type: string - contentTemplate: - type: string - headers: - additionalProperties: - type: string - description: Customized headers. - type: object - method: - enum: - - POST - - GET - - PUT - type: string - password: - type: string - token: - type: string - url: - type: string - username: - type: string - required: - - url - - authMethod - - method - type: object - type: object - HTTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/HTTPNotificationRuleBase' - HTTPNotificationRuleBase: - properties: - type: - enum: - - http - type: string - url: - type: string - required: - - type - type: object - HealthCheck: - properties: - checks: - items: - $ref: '#/components/schemas/HealthCheck' - type: array - commit: - type: string - message: - type: string - name: - type: string - status: - enum: - - pass - - fail - type: string - version: - type: string - required: - - name - - status - type: object - HeatmapViewProperties: - properties: - adaptiveZoomHide: - type: boolean - binSize: - type: number - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - heatmap - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - - binSize - type: object - HistogramViewProperties: - properties: - binCount: - type: integer - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - fillColumns: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - histogram - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - format: float - type: number - type: array - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - fillColumns - - xDomain - - xAxisLabel - - position - - binCount - type: object - Identifier: - description: A valid Flux identifier - properties: - name: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - ImportDeclaration: - description: Declares a package import - properties: - as: - $ref: '#/components/schemas/Identifier' - path: - $ref: '#/components/schemas/StringLiteral' - type: - $ref: '#/components/schemas/NodeType' - type: object - IndexExpression: - description: Represents indexing into an array - properties: - array: - $ref: '#/components/schemas/Expression' - index: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - InfluxqlCsvResponse: - description: CSV Response to InfluxQL Query - example: | - name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value - type: string - InfluxqlJsonResponse: - description: JSON Response to InfluxQL Query - properties: - results: - items: - properties: - error: - type: string - series: - items: - properties: - columns: - items: - type: string - type: array - name: - type: string - partial: - type: boolean - tags: - additionalProperties: - type: string - type: object - values: - items: - items: {} - type: array - type: array - type: object - type: array - statement_id: - type: integer - type: object - type: array - type: object - IntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - IsOnboarding: - properties: - allowed: - description: | - If `true`, the InfluxDB instance hasn't had initial setup; - `false` otherwise. - type: boolean - type: object - Label: - properties: - id: - readOnly: true - type: string - name: - type: string - orgID: - readOnly: true - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - type: object - LabelCreateRequest: - properties: - name: - type: string - orgID: - type: string - properties: - additionalProperties: - type: string - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - example: - color: ffb3b3 - description: this is a description - type: object - required: - - orgID - - name - type: object - LabelMapping: - description: A _label mapping_ contains a `label` ID to attach to a resource. - properties: - labelID: - description: | - A label ID. - Specifies the label to attach. - type: string - required: - - labelID - type: object - LabelResponse: - properties: - label: - $ref: '#/components/schemas/Label' - links: - $ref: '#/components/schemas/Links' - type: object - LabelUpdate: - properties: - name: - type: string - properties: - additionalProperties: - description: | - Key-value pairs associated with this label. - - To remove a property, send an update with an empty value (`""`) for the key. - type: string - example: - color: ffb3b3 - description: this is a description - type: object - type: object - Labels: - items: - $ref: '#/components/schemas/Label' - type: array - LabelsResponse: - properties: - labels: - $ref: '#/components/schemas/Labels' - links: - $ref: '#/components/schemas/Links' - type: object - LanguageRequest: - description: Flux query to be analyzed. - properties: - query: - description: | - The Flux query script to be analyzed. - type: string - required: - - query - type: object - LatLonColumn: - description: Object type for key and column definitions - properties: - column: - description: Column to look up Lat/Lon - type: string - key: - description: Key to determine whether the column is tag/field - type: string - required: - - key - - column - type: object - LatLonColumns: - description: Object type to define lat/lon columns - properties: - lat: - $ref: '#/components/schemas/LatLonColumn' - lon: - $ref: '#/components/schemas/LatLonColumn' - required: - - lat - - lon - type: object - LegacyAuthorizationPostRequest: - allOf: - - $ref: '#/components/schemas/AuthorizationUpdateRequest' - - properties: - orgID: - description: The organization ID. Identifies the organization that the authorization is scoped to. - type: string - permissions: - description: | - The list of permissions that provide `read` and `write` access to organization resources. - An authorization must contain at least one permission. - items: - $ref: '#/components/schemas/Permission' - minItems: 1 - type: array - token: - description: The name that you provide for the authorization. - type: string - userID: - description: The user ID. Identifies the user that the authorization is scoped to. - type: string - type: object - required: - - orgID - - permissions - LesserThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - type: - enum: - - lesser - type: string - value: - format: float - type: number - required: - - type - - value - type: object - LinePlusSingleStatProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - timeFormat: - type: string - type: - enum: - - line-plus-single-stat - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - prefix - - suffix - - decimalPlaces - - position - type: object - LineProtocolError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - internal error - - not found - - conflict - - invalid - - empty value - - unavailable - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - line: - description: First line in the request body that contains malformed data. - format: int32 - readOnly: true - type: integer - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code - LineProtocolLengthError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - invalid - readOnly: true - type: string - message: - description: Human-readable message. - readOnly: true - type: string - required: - - code - - message - Link: - description: URI of resource. - format: uri - readOnly: true - type: string - Links: - description: | - URI pointers for additional paged results. - properties: - next: - $ref: '#/components/schemas/Link' - prev: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - required: - - self - type: object - LogEvent: - properties: - message: - description: A description of the event that occurred. - example: Halt and catch fire - readOnly: true - type: string - runID: - description: The ID of the task run that generated the event. - readOnly: true - type: string - time: - description: The time ([RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - type: object - LogicalExpression: - description: Represents the rule conditions that collectively evaluate to either true or false - properties: - left: - $ref: '#/components/schemas/Expression' - operator: - type: string - right: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Logs: - properties: - events: - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - type: object - MapVariableProperties: - properties: - type: - enum: - - map - type: string - values: - additionalProperties: - type: string - type: object - MarkdownViewProperties: - properties: - note: - type: string - shape: - enum: - - chronograf-v2 - type: string - type: - enum: - - markdown - type: string - required: - - type - - shape - - note - type: object - MemberAssignment: - description: Object property assignment - properties: - init: - $ref: '#/components/schemas/Expression' - member: - $ref: '#/components/schemas/MemberExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - MemberExpression: - description: Represents accessing a property of an object - properties: - object: - $ref: '#/components/schemas/Expression' - property: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - type: object - MetadataBackup: - properties: - buckets: - $ref: '#/components/schemas/BucketMetadataManifests' - kv: - format: binary - type: string - sql: - format: binary - type: string - required: - - kv - - sql - - buckets - type: object - MosaicViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - timeFormat: - type: string - type: - enum: - - mosaic - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yLabelColumnSeparator: - type: string - yLabelColumns: - items: - type: string - type: array - yPrefix: - type: string - ySeriesColumns: - items: - type: string - type: array - ySuffix: - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - ySeriesColumns - - fillColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - Node: - oneOf: - - $ref: '#/components/schemas/Expression' - - $ref: '#/components/schemas/Block' - NodeType: - description: Type of AST node - type: string - NotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - NotificationEndpointBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification endpoint. - type: string - id: - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - example: - labels: /api/v2/notificationEndpoints/1/labels - members: /api/v2/notificationEndpoints/1/members - owners: /api/v2/notificationEndpoints/1/owners - self: /api/v2/notificationEndpoints/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this endpoint. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this endpoint. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this endpoint. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - type: string - orgID: - type: string - status: - default: active - description: The status of the endpoint. - enum: - - active - - inactive - type: string - type: - $ref: '#/components/schemas/NotificationEndpointType' - updatedAt: - format: date-time - readOnly: true - type: string - userID: - type: string - required: - - type - - name - type: object - NotificationEndpointDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationEndpoint' - pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' - slack: '#/components/schemas/SlackNotificationEndpoint' - telegram: '#/components/schemas/TelegramNotificationEndpoint' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationEndpoint' - - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' - - $ref: '#/components/schemas/HTTPNotificationEndpoint' - - $ref: '#/components/schemas/TelegramNotificationEndpoint' - NotificationEndpointType: - enum: - - slack - - pagerduty - - http - - telegram - type: string - NotificationEndpointUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationEndpoints: - properties: - links: - $ref: '#/components/schemas/Links' - notificationEndpoints: - items: - $ref: '#/components/schemas/NotificationEndpoint' - type: array - NotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - NotificationRuleBase: - properties: - createdAt: - format: date-time - readOnly: true - type: string - description: - description: An optional description of the notification rule. - type: string - endpointID: - type: string - every: - description: The notification repetition interval. - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - limit: - description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. - type: integer - limitEvery: - description: Don't notify me more than times every seconds. If set, limit cannot be empty. - type: integer - links: - example: - labels: /api/v2/notificationRules/1/labels - members: /api/v2/notificationRules/1/members - owners: /api/v2/notificationRules/1/owners - query: /api/v2/notificationRules/1/query - self: /api/v2/notificationRules/1 - properties: - labels: - $ref: '#/components/schemas/Link' - description: The URL to retrieve labels for this notification rule. - members: - $ref: '#/components/schemas/Link' - description: The URL to retrieve members for this notification rule. - owners: - $ref: '#/components/schemas/Link' - description: The URL to retrieve owners for this notification rule. - query: - $ref: '#/components/schemas/Link' - description: The URL to retrieve the Flux script for this notification rule. - self: - $ref: '#/components/schemas/Link' - description: The URL for this endpoint. - readOnly: true - type: object - name: - description: Human-readable name describing the notification rule. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - orgID: - description: The ID of the organization that owns this notification rule. - type: string - ownerID: - description: The ID of creator used to create this notification rule. - readOnly: true - type: string - runbookLink: - type: string - sleepUntil: - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - statusRules: - description: List of status rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/StatusRule' - minItems: 1 - type: array - tagRules: - description: List of tag rules the notification rule attempts to match. - items: - $ref: '#/components/schemas/TagRule' - type: array - taskID: - description: The ID of the task associated with this notification rule. - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - orgID - - status - - name - - statusRules - - endpointID - type: object - NotificationRuleDiscriminator: - discriminator: - mapping: - http: '#/components/schemas/HTTPNotificationRule' - pagerduty: '#/components/schemas/PagerDutyNotificationRule' - slack: '#/components/schemas/SlackNotificationRule' - smtp: '#/components/schemas/SMTPNotificationRule' - telegram: '#/components/schemas/TelegramNotificationRule' - propertyName: type - oneOf: - - $ref: '#/components/schemas/SlackNotificationRule' - - $ref: '#/components/schemas/SMTPNotificationRule' - - $ref: '#/components/schemas/PagerDutyNotificationRule' - - $ref: '#/components/schemas/HTTPNotificationRule' - - $ref: '#/components/schemas/TelegramNotificationRule' - NotificationRuleUpdate: - properties: - description: - type: string - name: - type: string - status: - enum: - - active - - inactive - type: string - type: object - NotificationRules: - properties: - links: - $ref: '#/components/schemas/Links' - notificationRules: - items: - $ref: '#/components/schemas/NotificationRule' - type: array - ObjectExpression: - description: Allows the declaration of an anonymous object within a declaration - properties: - properties: - description: Object properties - items: - $ref: '#/components/schemas/Property' - type: array - type: - $ref: '#/components/schemas/NodeType' - type: object - OnboardingRequest: - properties: - bucket: - type: string - org: - type: string - password: - type: string - retentionPeriodHrs: - deprecated: true - description: | - Retention period *in nanoseconds* for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use `retentionPeriodSeconds` - type: integer - retentionPeriodSeconds: - format: int64 - type: integer - token: - description: | - Authentication token to set on the initial user. If not specified, the server will generate a token. - type: string - username: - type: string - required: - - username - - org - - bucket - type: object - OnboardingResponse: - properties: - auth: - $ref: '#/components/schemas/Authorization' - bucket: - $ref: '#/components/schemas/Bucket' - org: - $ref: '#/components/schemas/Organization' - user: - $ref: '#/components/schemas/UserResponse' - type: object - OptionStatement: - description: A single variable declaration - properties: - assignment: - oneOf: - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Organization: - properties: - createdAt: - format: date-time - readOnly: true - type: string - defaultStorageType: - description: Discloses whether the organization uses TSM or IOx. - enum: - - tsm - - iox - type: string - description: - type: string - id: - readOnly: true - type: string - links: - example: - buckets: /api/v2/buckets?org=myorg - dashboards: /api/v2/dashboards?org=myorg - labels: /api/v2/orgs/1/labels - members: /api/v2/orgs/1/members - owners: /api/v2/orgs/1/owners - secrets: /api/v2/orgs/1/secrets - self: /api/v2/orgs/1 - tasks: /api/v2/tasks?org=myorg - properties: - buckets: - $ref: '#/components/schemas/Link' - dashboards: - $ref: '#/components/schemas/Link' - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - secrets: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - tasks: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - type: string - status: - default: active - description: If inactive, the organization is inactive. - enum: - - active - - inactive - type: string - updatedAt: - format: date-time - readOnly: true - type: string - required: - - name - Organizations: - properties: - links: - $ref: '#/components/schemas/Links' - orgs: - items: - $ref: '#/components/schemas/Organization' - type: array - type: object - Package: - description: Represents a complete package source tree. - properties: - files: - description: Package files - items: - $ref: '#/components/schemas/File' - type: array - package: - description: Package name - type: string - path: - description: Package import path - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - PackageClause: - description: Defines a package identifier - properties: - name: - $ref: '#/components/schemas/Identifier' - type: - $ref: '#/components/schemas/NodeType' - type: object - PagerDutyNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - clientURL: - type: string - routingKey: - type: string - required: - - routingKey - type: object - type: object - PagerDutyNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' - PagerDutyNotificationRuleBase: - properties: - messageTemplate: - type: string - type: - enum: - - pagerduty - type: string - required: - - type - - messageTemplate - type: object - ParenExpression: - description: Represents an expression wrapped in parenthesis - properties: - expression: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PasswordResetBody: - properties: - password: - type: string - required: - - password - PatchBucketRequest: - description: | - An object that contains updated bucket properties to apply. - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The name of the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/PatchRetentionRules' - type: object - PatchOrganizationRequest: - description: | - An object that contains updated organization properties to apply. - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - type: object - PatchRetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The number of seconds to keep data. - Default duration is `2592000` (30 days). - `0` represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The [shard group duration](/influxdb/latest/reference/glossary/#shard). - The number of seconds that each shard group covers. - - #### InfluxDB Cloud - - - Doesn't use `shardGroupDurationsSeconds`. - - #### InfluxDB OSS - - - Default value depends on the [bucket retention period](/influxdb/latest/reference/internals/shards/#shard-group-duration). - - #### Related guides - - - InfluxDB [shards and shard groups](/influxdb/latest/reference/internals/shards/) - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - PatchRetentionRules: - description: Updates to rules to expire or retain data. No rules means no updates. - items: - $ref: '#/components/schemas/PatchRetentionRule' - type: array - Permission: - properties: - action: - enum: - - read - - write - type: string - resource: - $ref: '#/components/schemas/Resource' - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - required: - - action - - resource - PipeExpression: - description: Call expression with pipe argument - properties: - argument: - $ref: '#/components/schemas/Expression' - call: - $ref: '#/components/schemas/CallExpression' - type: - $ref: '#/components/schemas/NodeType' - type: object - PipeLiteral: - description: Represents a specialized literal value, indicating the left hand value of a pipe expression - properties: - type: - $ref: '#/components/schemas/NodeType' - type: object - PostBucketRequest: - properties: - description: - description: | - A description of the bucket. - type: string - name: - description: | - The bucket name. - type: string - orgID: - description: | - The organization ID. - Specifies the organization that owns the bucket. - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - rp: - default: '0' - description: | - The retention policy for the bucket. - For InfluxDB 1.x, specifies the duration of time that each data point - in the retention policy persists. - - If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; - otherwise, see the `retentionRules` property. - - [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) - is an InfluxDB 1.x concept. - The InfluxDB 2.x and Cloud equivalent is - [retention period](/influxdb/latest/reference/glossary/#retention-period). - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. - type: string - schemaType: - $ref: '#/components/schemas/SchemaType' - default: implicit - description: | - The schema Type. Default is `implicit`. - - #### InfluxDB Cloud v2 - - - Use `explicit` to enforce column names, tags, fields, and data types for - your data. - - #### InfluxDB OSS - - - Doesn't support `explicit` bucket schemas. - required: - - orgID - - name - PostCheck: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - PostNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - PostNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleDiscriminator' - PostOrganizationRequest: - properties: - description: - description: | - The description of the organization. - type: string - name: - description: | - The name of the organization. - type: string - required: - - name - type: object - Property: - description: The value associated with a key - properties: - key: - $ref: '#/components/schemas/PropertyKey' - type: - $ref: '#/components/schemas/NodeType' - value: - $ref: '#/components/schemas/Expression' - type: object - PropertyKey: - oneOf: - - $ref: '#/components/schemas/Identifier' - - $ref: '#/components/schemas/StringLiteral' - Query: - description: Query InfluxDB with the Flux language - properties: - dialect: - $ref: '#/components/schemas/Dialect' - extern: - $ref: '#/components/schemas/File' - now: - description: | - Specifies the time that should be reported as `now` in the query. - Default is the server `now` time. - format: date-time - type: string - query: - description: The query script to execute. - type: string - type: - description: The type of query. Must be "flux". - enum: - - flux - type: string - required: - - query - type: object - QueryEditMode: - enum: - - builder - - advanced - type: string - QueryVariableProperties: - properties: - type: - enum: - - query - type: string - values: - properties: - language: - type: string - query: - type: string - type: object - RangeThreshold: - allOf: - - $ref: '#/components/schemas/ThresholdBase' - - properties: - max: - format: float - type: number - min: - format: float - type: number - type: - enum: - - range - type: string - within: - type: boolean - required: - - type - - min - - max - - within - type: object - Ready: - properties: - started: - example: '2019-03-13T10:09:33.891196-04:00' - format: date-time - type: string - status: - enum: - - ready - type: string - up: - example: 14m45.911966424s - type: string - type: object - RegexpLiteral: - description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - RemoteConnection: - properties: - allowInsecureTLS: - default: false - type: boolean - description: - type: string - id: - type: string - name: - type: string - orgID: - type: string - remoteOrgID: - type: string - remoteURL: - format: uri - type: string - required: - - id - - name - - orgID - - remoteURL - - allowInsecureTLS - type: object - RemoteConnectionCreationRequest: - properties: - allowInsecureTLS: - default: false - type: boolean - description: - type: string - name: - type: string - orgID: - type: string - remoteAPIToken: - type: string - remoteOrgID: - type: string - remoteURL: - format: uri - type: string - required: - - name - - orgID - - remoteURL - - remoteAPIToken - - allowInsecureTLS - type: object - RemoteConnectionUpdateRequest: - properties: - allowInsecureTLS: - default: false - type: boolean - description: - type: string - name: - type: string - remoteAPIToken: - type: string - remoteOrgID: - type: string - remoteURL: - format: uri - type: string - type: object - RemoteConnections: - properties: - remotes: - items: - $ref: '#/components/schemas/RemoteConnection' - type: array - type: object - RenamableField: - description: Describes a field that can be renamed and made visible or invisible. - properties: - displayName: - description: The name that a field is renamed to by the user. - type: string - internalName: - description: The calculated name of a field. - readOnly: true - type: string - visible: - description: Indicates whether this field should be visible on the table. - type: boolean - type: object - Replication: - properties: - currentQueueSizeBytes: - format: int64 - type: integer - description: - type: string - dropNonRetryableData: - type: boolean - id: - type: string - latestErrorMessage: - type: string - latestResponseCode: - type: integer - localBucketID: - type: string - maxQueueSizeBytes: - format: int64 - type: integer - name: - type: string - orgID: - type: string - remainingBytesToBeSynced: - format: int64 - type: integer - remoteBucketID: - type: string - remoteBucketName: - type: string - remoteID: - type: string - required: - - id - - name - - remoteID - - orgID - - localBucketID - - maxQueueSizeBytes - type: object - ReplicationCreationRequest: - properties: - description: - type: string - dropNonRetryableData: - default: false - type: boolean - localBucketID: - type: string - maxAgeSeconds: - default: 604800 - format: int64 - minimum: 0 - type: integer - maxQueueSizeBytes: - default: 67108860 - format: int64 - minimum: 33554430 - type: integer - name: - type: string - orgID: - type: string - remoteBucketID: - type: string - remoteBucketName: - type: string - remoteID: - type: string - required: - - name - - orgID - - remoteID - - localBucketID - - maxQueueSizeBytes - - maxAgeSeconds - type: object - ReplicationUpdateRequest: - properties: - description: - type: string - dropNonRetryableData: - type: boolean - maxAgeSeconds: - format: int64 - minimum: 0 - type: integer - maxQueueSizeBytes: - format: int64 - minimum: 33554430 - type: integer - name: - type: string - remoteBucketID: - type: string - remoteBucketName: - type: string - remoteID: - type: string - type: object - Replications: - properties: - replications: - items: - $ref: '#/components/schemas/Replication' - type: array - type: object - Resource: - properties: - id: - description: | - A resource ID. - Identifies a specific resource. - type: string - name: - description: | - The name of the resource. - _Note: not all resource types have a `name` property_. - type: string - org: - description: | - An organization name. - The organization that owns the resource. - type: string - orgID: - description: | - An organization ID. - Identifies the organization that owns the resource. - type: string - type: - description: | - A resource type. - Identifies the API resource's type (or _kind_). - enum: - - authorizations - - buckets - - dashboards - - orgs - - tasks - - telegrafs - - users - - variables - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - - dbrp - - annotations - - sources - - scrapers - - notebooks - - remotes - - replications - - instance - - flows - - functions - - subscriptions - type: string - required: - - type - type: object - ResourceMember: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: member - enum: - - member - type: string - type: object - ResourceMembers: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceMember' - type: array - type: object - ResourceOwner: - allOf: - - $ref: '#/components/schemas/UserResponse' - - properties: - role: - default: owner - enum: - - owner - type: string - type: object - ResourceOwners: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/ResourceOwner' - type: array - type: object - RestoredBucketMappings: - properties: - id: - description: New ID of the restored bucket - type: string - name: - type: string - shardMappings: - $ref: '#/components/schemas/BucketShardMappings' - required: - - id - - name - - shardMappings - type: object - RetentionPolicyManifest: - properties: - duration: - format: int64 - type: integer - name: - type: string - replicaN: - type: integer - shardGroupDuration: - format: int64 - type: integer - shardGroups: - $ref: '#/components/schemas/ShardGroupManifests' - subscriptions: - $ref: '#/components/schemas/SubscriptionManifests' - required: - - name - - replicaN - - duration - - shardGroupDuration - - shardGroups - - subscriptions - type: object - RetentionPolicyManifests: - items: - $ref: '#/components/schemas/RetentionPolicyManifest' - type: array - RetentionRule: - properties: - everySeconds: - default: 2592000 - description: | - The duration in seconds for how long data will be kept in the database. - The default duration is 2592000 (30 days). - 0 represents infinite retention. - example: 86400 - format: int64 - minimum: 0 - type: integer - shardGroupDurationSeconds: - description: | - The shard group duration. - The duration or interval (in seconds) that each shard group covers. - - #### InfluxDB Cloud - - - Does not use `shardGroupDurationsSeconds`. - - #### InfluxDB OSS - - - Default value depends on the - [bucket retention period](/influxdb/latest/reference/internals/shards/#shard-group-duration). - format: int64 - type: integer - type: - default: expire - enum: - - expire - type: string - required: - - everySeconds - type: object - RetentionRules: - description: | - Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/latest/reference/glossary/#retention-period). - - #### InfluxDB Cloud - - - `retentionRules` is required. - - #### InfluxDB OSS - - - `retentionRules` isn't required. - items: - $ref: '#/components/schemas/RetentionRule' - type: array - ReturnStatement: - description: Defines an expression to return - properties: - argument: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - Routes: - properties: - authorizations: - format: uri - type: string - buckets: - format: uri - type: string - dashboards: - format: uri - type: string - external: - properties: - statusFeed: - format: uri - type: string - type: object - flags: - format: uri - type: string - me: - format: uri - type: string - orgs: - format: uri - type: string - query: - properties: - analyze: - format: uri - type: string - ast: - format: uri - type: string - self: - format: uri - type: string - suggestions: - format: uri - type: string - type: object - setup: - format: uri - type: string - signin: - format: uri - type: string - signout: - format: uri - type: string - sources: - format: uri - type: string - system: - properties: - debug: - format: uri - type: string - health: - format: uri - type: string - metrics: - format: uri - type: string - type: object - tasks: - format: uri - type: string - telegrafs: - format: uri - type: string - users: - format: uri - type: string - variables: - format: uri - type: string - write: - format: uri - type: string - RuleStatusLevel: - description: The state to record if check matches a criteria. - enum: - - UNKNOWN - - OK - - INFO - - CRIT - - WARN - - ANY - type: string - Run: - properties: - finishedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - flux: - description: Flux used for the task - readOnly: true - type: string - id: - readOnly: true - type: string - links: - example: - retry: /api/v2/tasks/1/runs/1/retry - self: /api/v2/tasks/1/runs/1 - task: /api/v2/tasks/1 - properties: - retry: - format: uri - type: string - self: - format: uri - type: string - task: - format: uri - type: string - readOnly: true - type: object - log: - description: An array of logs associated with the run. - items: - $ref: '#/components/schemas/LogEvent' - readOnly: true - type: array - requestedAt: - description: The time ([RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - scheduledFor: - description: The time [RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. - format: date-time - type: string - startedAt: - description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. - example: 2006-01-02T15:04:05.999999999Z07:00 - format: date-time - readOnly: true - type: string - status: - enum: - - scheduled - - started - - failed - - success - - canceled - readOnly: true - type: string - taskID: - readOnly: true - type: string - RunManually: - properties: - scheduledFor: - description: | - The time [RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp) - used for the run's `now` option. - Default is the server _now_ time. - format: date-time - nullable: true - type: string - Runs: - properties: - links: - $ref: '#/components/schemas/Links' - runs: - items: - $ref: '#/components/schemas/Run' - type: array - type: object - SMTPNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SMTPNotificationRuleBase' - SMTPNotificationRuleBase: - properties: - bodyTemplate: - type: string - subjectTemplate: - type: string - to: - type: string - type: - enum: - - smtp - type: string - required: - - type - - subjectTemplate - - to - type: object - ScatterViewProperties: - properties: - adaptiveZoomHide: - type: boolean - colors: - description: Colors define color encoding of data into a visualization - items: - type: string - type: array - fillColumns: - items: - type: string - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - symbolColumns: - items: - type: string - type: array - timeFormat: - type: string - type: - enum: - - scatter - type: string - xAxisLabel: - type: string - xColumn: - type: string - xDomain: - items: - type: number - maxItems: 2 - type: array - xPrefix: - type: string - xSuffix: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yAxisLabel: - type: string - yColumn: - type: string - yDomain: - items: - type: number - maxItems: 2 - type: array - yPrefix: - type: string - ySuffix: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - xColumn - - yColumn - - fillColumns - - symbolColumns - - xDomain - - yDomain - - xAxisLabel - - yAxisLabel - - xPrefix - - yPrefix - - xSuffix - - ySuffix - type: object - SchemaType: - enum: - - implicit - - explicit - type: string - ScraperTargetRequest: - properties: - allowInsecure: - default: false - description: Skip TLS verification on endpoint. - type: boolean - bucketID: - description: The ID of the bucket to write to. - type: string - name: - description: The name of the scraper target. - type: string - orgID: - description: The organization ID. - type: string - type: - description: The type of the metrics to be parsed. - enum: - - prometheus - type: string - url: - description: The URL of the metrics endpoint. - example: http://localhost:9090/metrics - type: string - type: object - ScraperTargetResponse: - allOf: - - $ref: '#/components/schemas/ScraperTargetRequest' - - properties: - bucket: - description: The bucket name. - type: string - id: - readOnly: true - type: string - links: - example: - bucket: /api/v2/buckets/1 - members: /api/v2/scrapers/1/members - organization: /api/v2/orgs/1 - owners: /api/v2/scrapers/1/owners - self: /api/v2/scrapers/1 - properties: - bucket: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - organization: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - org: - description: The name of the organization. - type: string - type: object - type: object - ScraperTargetResponses: - properties: - configurations: - items: - $ref: '#/components/schemas/ScraperTargetResponse' - type: array - type: object - SecretKeys: - properties: - secrets: - items: - type: string - type: array - type: object - SecretKeysResponse: - allOf: - - $ref: '#/components/schemas/SecretKeys' - - properties: - links: - properties: - org: - type: string - self: - type: string - readOnly: true - type: object - type: object - Secrets: - additionalProperties: - type: string - example: - apikey: abc123xyz - ShardGroupManifest: - properties: - deletedAt: - format: date-time - type: string - endTime: - format: date-time - type: string - id: - format: int64 - type: integer - shards: - $ref: '#/components/schemas/ShardManifests' - startTime: - format: date-time - type: string - truncatedAt: - format: date-time - type: string - required: - - id - - startTime - - endTime - - shards - type: object - ShardGroupManifests: - items: - $ref: '#/components/schemas/ShardGroupManifest' - type: array - ShardManifest: - properties: - id: - format: int64 - type: integer - shardOwners: - $ref: '#/components/schemas/ShardOwners' - required: - - id - - shardOwners - type: object - ShardManifests: - items: - $ref: '#/components/schemas/ShardManifest' - type: array - ShardOwner: - properties: - nodeID: - description: The ID of the node that owns the shard. - format: int64 - type: integer - required: - - nodeID - type: object - ShardOwners: - items: - $ref: '#/components/schemas/ShardOwner' - type: array - SimpleTableViewProperties: - properties: - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showAll: - type: boolean - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - type: - enum: - - simple-table - type: string - required: - - type - - showAll - - queries - - shape - - note - - showNoteWhenEmpty - type: object - SingleStatViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - note: - type: string - prefix: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - suffix: - type: string - tickPrefix: - type: string - tickSuffix: - type: string - type: - enum: - - single-stat - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - prefix - - tickPrefix - - suffix - - tickSuffix - - decimalPlaces - type: object - SlackNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - token: - description: Specifies the API token string. Specify either `URL` or `Token`. - type: string - url: - description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. - type: string - type: object - type: object - SlackNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/SlackNotificationRuleBase' - SlackNotificationRuleBase: - properties: - channel: - type: string - messageTemplate: - type: string - type: - enum: - - slack - type: string - required: - - type - - messageTemplate - type: object - Source: - properties: - default: - type: boolean - defaultRP: - type: string - id: - type: string - insecureSkipVerify: - type: boolean - languages: - items: - enum: - - flux - - influxql - type: string - readOnly: true - type: array - links: - properties: - buckets: - type: string - health: - type: string - query: - type: string - self: - type: string - type: object - metaUrl: - format: uri - type: string - name: - type: string - orgID: - type: string - password: - type: string - sharedSecret: - type: string - telegraf: - type: string - token: - type: string - type: - enum: - - v1 - - v2 - - self - type: string - url: - format: uri - type: string - username: - type: string - type: object - Sources: - properties: - links: - properties: - self: - format: uri - type: string - type: object - sources: - items: - $ref: '#/components/schemas/Source' - type: array - type: object - Stack: - properties: - createdAt: - format: date-time - readOnly: true - type: string - events: - items: - properties: - description: - type: string - eventType: - type: string - name: - type: string - resources: - items: - properties: - apiVersion: - type: string - associations: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - metaName: - type: string - type: object - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - links: - properties: - self: - type: string - type: object - resourceID: - type: string - templateMetaName: - type: string - type: object - type: array - sources: - items: - type: string - type: array - updatedAt: - format: date-time - readOnly: true - type: string - urls: - items: - type: string - type: array - type: object - type: array - id: - type: string - orgID: - type: string - type: object - Statement: - oneOf: - - $ref: '#/components/schemas/BadStatement' - - $ref: '#/components/schemas/VariableAssignment' - - $ref: '#/components/schemas/MemberAssignment' - - $ref: '#/components/schemas/ExpressionStatement' - - $ref: '#/components/schemas/ReturnStatement' - - $ref: '#/components/schemas/OptionStatement' - - $ref: '#/components/schemas/BuiltinStatement' - - $ref: '#/components/schemas/TestStatement' - StaticLegend: - description: StaticLegend represents the options specific to the static legend - properties: - colorizeRows: - type: boolean - heightRatio: - format: float - type: number - opacity: - format: float - type: number - orientationThreshold: - type: integer - show: - type: boolean - valueAxis: - type: string - widthRatio: - format: float - type: number - type: object - StatusRule: - properties: - count: - type: integer - currentLevel: - $ref: '#/components/schemas/RuleStatusLevel' - period: - type: string - previousLevel: - $ref: '#/components/schemas/RuleStatusLevel' - type: object - StringLiteral: - description: Expressions begin and end with double quote marks - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - SubscriptionManifest: - properties: - destinations: - items: - type: string - type: array - mode: - type: string - name: - type: string - required: - - name - - mode - - destinations - type: object - SubscriptionManifests: - items: - $ref: '#/components/schemas/SubscriptionManifest' - type: array - TableViewProperties: - properties: - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' - fieldOptions: - description: fieldOptions represent the fields retrieved by the query with customization options - items: - $ref: '#/components/schemas/RenamableField' - type: array - note: - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - tableOptions: - properties: - fixFirstColumn: - description: fixFirstColumn indicates whether the first column of the table should be locked - type: boolean - sortBy: - $ref: '#/components/schemas/RenamableField' - verticalTimeAxis: - description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically - type: boolean - wrapping: - description: Wrapping describes the text wrapping style to be used in table views - enum: - - truncate - - wrap - - single-line - type: string - type: object - timeFormat: - description: timeFormat describes the display format for time values according to moment.js date formatting - type: string - type: - enum: - - table - type: string - required: - - type - - queries - - colors - - shape - - note - - showNoteWhenEmpty - - tableOptions - - fieldOptions - - timeFormat - - decimalPlaces - type: object - TagRule: - properties: - key: - type: string - operator: - enum: - - equal - - notequal - - equalregex - - notequalregex - type: string - value: - type: string - type: object - Task: - properties: - authorizationID: - description: | - An authorization ID. - Specifies the authorization used when the task communicates with the query engine. - - To find an authorization ID, use the - [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to - list authorizations. - type: string - createdAt: - format: date-time - readOnly: true - type: string - cron: - description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. - type: string - description: - description: A description of the task. - type: string - every: - description: The interval ([duration literal](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. - format: duration - type: string - flux: - description: The Flux script that the task executes. - format: flux - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - lastRunError: - readOnly: true - type: string - lastRunStatus: - enum: - - failed - - success - - canceled - readOnly: true - type: string - latestCompleted: - description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. - format: date-time - readOnly: true - type: string - links: - example: - labels: /api/v2/tasks/1/labels - logs: /api/v2/tasks/1/logs - members: /api/v2/tasks/1/members - owners: /api/v2/tasks/1/owners - runs: /api/v2/tasks/1/runs - self: /api/v2/tasks/1 - properties: - labels: - $ref: '#/components/schemas/Link' - logs: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - runs: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - name: - description: The name of the task. - type: string - offset: - description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. - format: duration - type: string - org: - description: | - An [organization](/influxdb/latest/reference/glossary/#organization) name. - Specifies the organization that owns the task. - type: string - orgID: - description: | - An [organization](/influxdb/latest/reference/glossary/#organization) ID. - Specifies the organization that owns the task. - type: string - ownerID: - description: | - A [user](/influxdb/latest/reference/glossary/#user) ID. - Specifies the owner of the task. - - To find a user ID, you can use the - [`GET /api/v2/users` endpoint](#operation/GetUsers) to - list users. - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - updatedAt: - format: date-time - readOnly: true - type: string - required: - - id - - name - - orgID - - flux - type: object - TaskCreateRequest: - properties: - description: - description: An optional description of the task. - type: string - flux: - description: The Flux script to run for this task. - type: string - org: - description: The name of the organization that owns this Task. - type: string - orgID: - description: The ID of the organization that owns this Task. - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - required: - - flux - type: object - TaskStatusType: - description: | - `inactive` cancels scheduled runs and prevents manual runs of the task. - enum: - - active - - inactive - type: string - TaskUpdateRequest: - properties: - cron: - description: Update the 'cron' option in the flux script. - type: string - description: - description: Update the description of the task. - type: string - every: - description: Update the 'every' option in the flux script. - type: string - flux: - description: The Flux script that the task runs. - type: string - name: - description: Update the 'name' option in the flux script. - type: string - offset: - description: Update the 'offset' option in the flux script. - type: string - status: - $ref: '#/components/schemas/TaskStatusType' - type: object - Tasks: - properties: - links: - $ref: '#/components/schemas/Links' - readOnly: true - tasks: - items: - $ref: '#/components/schemas/Task' - type: array - type: object - Telegraf: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - readOnly: true - links: - example: - labels: /api/v2/telegrafs/1/labels - members: /api/v2/telegrafs/1/members - owners: /api/v2/telegrafs/1/owners - self: /api/v2/telegrafs/1 - properties: - labels: - $ref: '#/components/schemas/Link' - members: - $ref: '#/components/schemas/Link' - owners: - $ref: '#/components/schemas/Link' - self: - $ref: '#/components/schemas/Link' - readOnly: true - type: object - type: object - type: object - TelegrafPlugin: - properties: - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - TelegrafPluginRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - plugins: - items: - properties: - alias: - type: string - config: - type: string - description: - type: string - name: - type: string - type: - type: string - type: object - type: array - type: object - TelegrafPlugins: - properties: - os: - type: string - plugins: - items: - $ref: '#/components/schemas/TelegrafPlugin' - type: array - version: - type: string - type: object - TelegrafRequest: - properties: - config: - type: string - description: - type: string - metadata: - properties: - buckets: - items: - type: string - type: array - type: object - name: - type: string - orgID: - type: string - type: object - Telegrafs: - properties: - configurations: - items: - $ref: '#/components/schemas/Telegraf' - type: array - type: object - TelegramNotificationEndpoint: - allOf: - - $ref: '#/components/schemas/NotificationEndpointBase' - - properties: - channel: - description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . - type: string - token: - description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . - type: string - required: - - token - - channel - type: object - type: object - TelegramNotificationRule: - allOf: - - $ref: '#/components/schemas/NotificationRuleBase' - - $ref: '#/components/schemas/TelegramNotificationRuleBase' - TelegramNotificationRuleBase: - properties: - disableWebPagePreview: - description: Disables preview of web links in the sent messages when "true". Defaults to "false". - type: boolean - messageTemplate: - description: The message template as a flux interpolated string. - type: string - parseMode: - description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". - enum: - - MarkdownV2 - - HTML - - Markdown - type: string - type: - description: The discriminator between other types of notification rules is "telegram". - enum: - - telegram - type: string - required: - - type - - messageTemplate - - channel - type: object - Template: - items: - description: | - A template entry. - Defines an InfluxDB resource in a template. - properties: - apiVersion: - example: influxdata.com/v2alpha1 - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - metadata: - description: | - Metadata properties used for the resource when the template is applied. - properties: - name: - type: string - type: object - spec: - description: | - Configuration properties used for the resource when the template is applied. - Key-value pairs map to the specification for the resource. - - The following code samples show `spec` configurations for template resources: - - - A bucket: - - ```json - { "spec": { - "name": "iot_center", - "retentionRules": [{ - "everySeconds": 2.592e+06, - "type": "expire" - }] - } - } - ``` - - - A variable: - - ```json - { "spec": { - "language": "flux", - "name": "Node_Service", - "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", - tag: \"service\")", - "type": "query" - } - } - ``` - type: object - type: object - type: array - TemplateApply: - properties: - actions: - description: | - A list of `action` objects. - Actions let you customize how InfluxDB applies templates in the request. - - You can use the following actions to prevent creating or updating resources: - - - A `skipKind` action skips template resources of a specified `kind`. - - A `skipResource` action skips template resources with a specified `metadata.name` - and `kind`. - items: - oneOf: - - properties: - action: - enum: - - skipKind - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - required: - - kind - type: object - type: object - - properties: - action: - enum: - - skipResource - type: string - properties: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - resourceTemplateName: - type: string - required: - - kind - - resourceTemplateName - type: object - type: object - type: array - dryRun: - description: | - Only applies a dry run of the templates passed in the request. - - - Validates the template and generates a resource diff and summary. - - Doesn't install templates or make changes to the InfluxDB instance. - type: boolean - envRefs: - additionalProperties: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - description: | - An object with key-value pairs that map to **environment references** in templates. - - Environment references in templates are `envRef` objects with an `envRef.key` - property. - To substitute a custom environment reference value when applying templates, - pass `envRefs` with the `envRef.key` and the value. - - When you apply a template, InfluxDB replaces `envRef` objects in the template - with the values that you provide in the `envRefs` parameter. - For more examples, see how to [define environment references](/influxdb/latest/influxdb-templates/use/#define-environment-references). - - The following template fields may use environment references: - - - `metadata.name` - - `spec.endpointName` - - `spec.associations.name` - - For more information about including environment references in template fields, see how to - [include user-definable resource names](/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names). - type: object - orgID: - description: | - Organization ID. - InfluxDB applies templates to this organization. - The organization owns all resources created by the template. - - To find your organization, see how to - [view organizations](/influxdb/latest/organizations/view-orgs/). - type: string - remotes: - description: | - A list of URLs for template files. - - To apply a template manifest file located at a URL, pass `remotes` - with an array that contains the URL. - items: - properties: - contentType: - type: string - url: - type: string - required: - - url - type: object - type: array - secrets: - additionalProperties: - type: string - description: | - An object with key-value pairs that map to **secrets** in queries. - - Queries may reference secrets stored in InfluxDB--for example, - the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` - secrets and then uses them to connect to a PostgreSQL database: - - ```js - import "sql" - import "influxdata/influxdb/secrets" - - username = secrets.get(key: "POSTGRES_USERNAME") - password = secrets.get(key: "POSTGRES_PASSWORD") - - sql.from( - driverName: "postgres", - dataSourceName: "postgresql://${username}:${password}@localhost:5432", - query: "SELECT * FROM example_table", - ) - ``` - - To define secret values in your `/api/v2/templates/apply` request, - pass the `secrets` parameter with key-value pairs--for example: - - ```json - { - ... - "secrets": { - "POSTGRES_USERNAME": "pguser", - "POSTGRES_PASSWORD": "foo" - } - ... - } - ``` - - InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. - Once stored, you can't view secret values in InfluxDB. - - #### Related guides - - - [How to pass secrets when installing a template](/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template) - type: object - stackID: - description: | - ID of the stack to update. - - To apply templates to an existing stack in the organization, use the `stackID` parameter. - If you apply templates without providing a stack ID, - InfluxDB initializes a new stack with all new resources. - - To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. - - #### Related guides - - - [Stacks](/influxdb/latest/influxdb-templates/stacks/) - - [View stacks](/influxdb/latest/influxdb-templates/stacks/view/) - type: string - template: - description: | - A template object to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Pass `template` to apply only one template object. - If you use `template`, you can't use the `templates` parameter. - If you want to apply multiple template objects, use `templates` instead. - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - templates: - description: | - A list of template objects to apply. - A template object has a `contents` property - with an array of InfluxDB resource configurations. - - Use the `templates` parameter to apply multiple template objects. - If you use `templates`, you can't use the `template` parameter. - items: - properties: - contentType: - type: string - contents: - $ref: '#/components/schemas/Template' - sources: - items: - type: string - type: array - type: object - type: array - type: object - TemplateChart: - properties: - height: - type: integer - properties: - $ref: '#/components/schemas/ViewProperties' - width: - type: integer - xPos: - type: integer - yPos: - type: integer - type: object - TemplateEnvReferences: - items: - properties: - defaultValue: - description: Default value that will be provided for the reference when no value is provided - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - envRefKey: - description: Key identified as environment reference and is the key identified in the template - type: string - resourceField: - description: Field the environment reference corresponds too - type: string - value: - description: Value provided to fulfill reference - nullable: true - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - required: - - resourceField - - envRefKey - type: object - type: array - TemplateExportByID: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported - type: string - required: - - id - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateExportByName: - properties: - orgIDs: - items: - properties: - orgID: - type: string - resourceFilters: - properties: - byLabel: - items: - type: string - type: array - byResourceKind: - items: - $ref: '#/components/schemas/TemplateKind' - type: array - type: object - type: object - type: array - resources: - items: - properties: - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - required: - - name - - kind - type: object - type: array - stackID: - type: string - type: object - TemplateKind: - enum: - - Bucket - - Check - - CheckDeadman - - CheckThreshold - - Dashboard - - Label - - NotificationEndpoint - - NotificationEndpointHTTP - - NotificationEndpointPagerDuty - - NotificationEndpointSlack - - NotificationRule - - Task - - Telegraf - - Variable - type: string - TemplateSummary: - properties: - diff: - properties: - buckets: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - old: - properties: - description: - type: string - name: - type: string - retentionRules: - $ref: '#/components/schemas/RetentionRules' - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - checks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/CheckDiscriminator' - old: - $ref: '#/components/schemas/CheckDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - old: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - old: - properties: - color: - type: string - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationEndpoints: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - old: - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - old: - properties: - description: - type: string - endpointID: - type: string - endpointName: - type: string - endpointType: - type: string - every: - type: string - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - old: - properties: - cron: - type: string - description: - type: string - every: - type: string - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - $ref: '#/components/schemas/TelegrafRequest' - old: - $ref: '#/components/schemas/TelegrafRequest' - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - new: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - old: - properties: - args: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - name: - type: string - type: object - stateStatus: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - errors: - items: - properties: - fields: - items: - type: string - type: array - indexes: - items: - type: integer - type: array - kind: - $ref: '#/components/schemas/TemplateKind' - reason: - type: string - type: object - type: array - sources: - items: - type: string - type: array - stackID: - type: string - summary: - properties: - buckets: - items: - properties: - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - retentionPeriod: - type: integer - templateMetaName: - type: string - type: object - type: array - checks: - items: - allOf: - - $ref: '#/components/schemas/CheckDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - dashboards: - items: - properties: - charts: - items: - $ref: '#/components/schemas/TemplateChart' - type: array - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - labelMappings: - items: - properties: - labelID: - type: string - labelName: - type: string - labelTemplateMetaName: - type: string - resourceID: - type: string - resourceName: - type: string - resourceTemplateMetaName: - type: string - resourceType: - type: string - status: - type: string - type: object - type: array - labels: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - missingEnvRefs: - items: - type: string - type: array - missingSecrets: - items: - type: string - type: array - notificationEndpoints: - items: - allOf: - - $ref: '#/components/schemas/NotificationEndpointDiscriminator' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - notificationRules: - items: - properties: - description: - type: string - endpointID: - type: string - endpointTemplateMetaName: - type: string - endpointType: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - messageTemplate: - type: string - name: - type: string - offset: - type: string - status: - type: string - statusRules: - items: - properties: - currentLevel: - type: string - previousLevel: - type: string - type: object - type: array - tagRules: - items: - properties: - key: - type: string - operator: - type: string - value: - type: string - type: object - type: array - templateMetaName: - type: string - type: object - type: array - tasks: - items: - properties: - cron: - type: string - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - every: - type: string - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - offset: - type: string - query: - type: string - status: - type: string - templateMetaName: - type: string - type: object - type: array - telegrafConfigs: - items: - allOf: - - $ref: '#/components/schemas/TelegrafRequest' - - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - templateMetaName: - type: string - type: object - type: array - variables: - items: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - description: - type: string - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - labelAssociations: - items: - $ref: '#/components/schemas/TemplateSummaryLabel' - type: array - name: - type: string - orgID: - type: string - templateMetaName: - type: string - type: object - type: array - type: object - type: object - TemplateSummaryLabel: - properties: - envReferences: - $ref: '#/components/schemas/TemplateEnvReferences' - id: - type: string - kind: - $ref: '#/components/schemas/TemplateKind' - name: - type: string - orgID: - type: string - properties: - properties: - color: - type: string - description: - type: string - type: object - templateMetaName: - type: string - type: object - TestStatement: - description: Declares a Flux test case - properties: - assignment: - $ref: '#/components/schemas/VariableAssignment' - type: - $ref: '#/components/schemas/NodeType' - type: object - Threshold: - discriminator: - mapping: - greater: '#/components/schemas/GreaterThreshold' - lesser: '#/components/schemas/LesserThreshold' - range: '#/components/schemas/RangeThreshold' - propertyName: type - oneOf: - - $ref: '#/components/schemas/GreaterThreshold' - - $ref: '#/components/schemas/LesserThreshold' - - $ref: '#/components/schemas/RangeThreshold' - ThresholdBase: - properties: - allValues: - description: If true, only alert if all values meet threshold. - type: boolean - level: - $ref: '#/components/schemas/CheckStatusLevel' - ThresholdCheck: - allOf: - - $ref: '#/components/schemas/CheckBase' - - properties: - every: - description: Check repetition interval. - type: string - offset: - description: Duration to delay after the schedule, before executing check. - type: string - statusMessageTemplate: - description: The template used to generate and write a status message. - type: string - tags: - description: List of tags to write to each status. - items: - properties: - key: - type: string - value: - type: string - type: object - type: array - thresholds: - items: - $ref: '#/components/schemas/Threshold' - type: array - type: - enum: - - threshold - type: string - required: - - type - type: object - Token: - properties: - token: - type: string - type: object - UnaryExpression: - description: Uses operators to act on a single operand in an expression - properties: - argument: - $ref: '#/components/schemas/Expression' - operator: - type: string - type: - $ref: '#/components/schemas/NodeType' - type: object - UnsignedIntegerLiteral: - description: Represents integer numbers - properties: - type: - $ref: '#/components/schemas/NodeType' - value: - type: string - type: object - User: - properties: - id: - description: The user ID. - readOnly: true - type: string - name: - description: The user name. - type: string - status: - default: active - description: | - If `inactive`, the user is inactive. - Default is `active`. - enum: - - active - - inactive - type: string - required: - - name - UserResponse: - properties: - id: - description: | - The user ID. - readOnly: true - type: string - links: - example: - self: /api/v2/users/1 - properties: - self: - format: uri - type: string - readOnly: true - type: object - name: - description: | - The user name. - type: string - status: - default: active - description: | - The status of a user. - An inactive user can't read or write resources. - enum: - - active - - inactive - type: string - required: - - name - Users: - properties: - links: - properties: - self: - format: uri - type: string - type: object - users: - items: - $ref: '#/components/schemas/UserResponse' - type: array - type: object - Variable: - properties: - arguments: - $ref: '#/components/schemas/VariableProperties' - createdAt: - format: date-time - type: string - description: - type: string - id: - readOnly: true - type: string - labels: - $ref: '#/components/schemas/Labels' - links: - properties: - labels: - format: uri - type: string - org: - format: uri - type: string - self: - format: uri - type: string - readOnly: true - type: object - name: - type: string - orgID: - type: string - selected: - items: - type: string - type: array - updatedAt: - format: date-time - type: string - required: - - name - - orgID - - arguments - type: object - VariableAssignment: - description: Represents the declaration of a variable - properties: - id: - $ref: '#/components/schemas/Identifier' - init: - $ref: '#/components/schemas/Expression' - type: - $ref: '#/components/schemas/NodeType' - type: object - VariableProperties: - oneOf: - - $ref: '#/components/schemas/QueryVariableProperties' - - $ref: '#/components/schemas/ConstantVariableProperties' - - $ref: '#/components/schemas/MapVariableProperties' - type: object - Variables: - example: - variables: - - arguments: - type: constant - values: - - howdy - - hello - - hi - - yo - - oy - id: '1221432' - name: ':ok:' - selected: - - hello - - arguments: - type: map - values: - a: fdjaklfdjkldsfjlkjdsa - b: dfaksjfkljekfajekdljfas - c: fdjksajfdkfeawfeea - id: '1221432' - name: ':ok:' - selected: - - c - - arguments: - language: flux - query: 'from(bucket: "foo") |> showMeasurements()' - type: query - id: '1221432' - name: ':ok:' - selected: - - host - properties: - variables: - items: - $ref: '#/components/schemas/Variable' - type: array - type: object - View: - properties: - id: - readOnly: true - type: string - links: - properties: - self: - type: string - readOnly: true - type: object - name: - type: string - properties: - $ref: '#/components/schemas/ViewProperties' - required: - - name - - properties - ViewProperties: - oneOf: - - $ref: '#/components/schemas/LinePlusSingleStatProperties' - - $ref: '#/components/schemas/XYViewProperties' - - $ref: '#/components/schemas/SingleStatViewProperties' - - $ref: '#/components/schemas/HistogramViewProperties' - - $ref: '#/components/schemas/GaugeViewProperties' - - $ref: '#/components/schemas/TableViewProperties' - - $ref: '#/components/schemas/SimpleTableViewProperties' - - $ref: '#/components/schemas/MarkdownViewProperties' - - $ref: '#/components/schemas/CheckViewProperties' - - $ref: '#/components/schemas/ScatterViewProperties' - - $ref: '#/components/schemas/HeatmapViewProperties' - - $ref: '#/components/schemas/MosaicViewProperties' - - $ref: '#/components/schemas/BandViewProperties' - - $ref: '#/components/schemas/GeoViewProperties' - Views: - properties: - links: - properties: - self: - type: string - type: object - views: - items: - $ref: '#/components/schemas/View' - type: array - type: object - WritePrecision: - enum: - - ms - - s - - us - - ns - type: string - XYGeom: - enum: - - line - - step - - stacked - - bar - - monotoneX - - stepBefore - - stepAfter - type: string - XYViewProperties: - properties: - adaptiveZoomHide: - type: boolean - axes: - $ref: '#/components/schemas/Axes' - colorMapping: - $ref: '#/components/schemas/ColorMapping' - description: An object that contains information about the color mapping - colors: - description: Colors define color encoding of data into a visualization - items: - $ref: '#/components/schemas/DashboardColor' - type: array - generateXAxisTicks: - items: - type: string - type: array - generateYAxisTicks: - items: - type: string - type: array - geom: - $ref: '#/components/schemas/XYGeom' - hoverDimension: - enum: - - auto - - x - - 'y' - - xy - type: string - legendColorizeRows: - type: boolean - legendHide: - type: boolean - legendOpacity: - format: float - type: number - legendOrientationThreshold: - type: integer - note: - type: string - position: - enum: - - overlaid - - stacked - type: string - queries: - items: - $ref: '#/components/schemas/DashboardQuery' - type: array - shadeBelow: - type: boolean - shape: - enum: - - chronograf-v2 - type: string - showNoteWhenEmpty: - description: If true, will display note when empty - type: boolean - staticLegend: - $ref: '#/components/schemas/StaticLegend' - timeFormat: - type: string - type: - enum: - - xy - type: string - xColumn: - type: string - xTickStart: - format: float - type: number - xTickStep: - format: float - type: number - xTotalTicks: - type: integer - yColumn: - type: string - yTickStart: - format: float - type: number - yTickStep: - format: float - type: number - yTotalTicks: - type: integer - required: - - type - - geom - - queries - - shape - - axes - - colors - - note - - showNoteWhenEmpty - - position - type: object - securitySchemes: - BasicAuthentication: - description: | - ### Basic authentication scheme - - Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: - - ### Syntax - - `Authorization: Basic BASE64_ENCODED_CREDENTIALS` - - To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and - the password with a colon (`USERNAME:PASSWORD`), and then encode the - resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). - Many HTTP clients encode the credentials for you before sending the - request. - - _**Warning**: Base64-encoding can easily be reversed to obtain the original - username and password. It is used to keep the data intact and does not provide - security. You should always use HTTPS when authenticating or sending a request with - sensitive information._ - - ### Examples - - In the examples, replace the following: - - - **`USERNAME`**: InfluxDB username - - **`PASSWORD`**: InfluxDB [API token](/influxdb/latest/reference/glossary/#token) - - **`INFLUX_URL`**: your InfluxDB URL - - #### Encode credentials with cURL - - The following example shows how to use cURL to send an API request that uses Basic authentication. - With the `--user` option, cURL encodes the credentials and passes them - in the `Authorization: Basic` header. - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --user "USERNAME":"PASSWORD" - ``` - - #### Encode credentials with Flux - - The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded - basic authentication header using a specified username and password combination. - - #### Encode credentials with JavaScript - - The following example shows how to use the JavaScript `btoa()` function - to create a Base64-encoded string: - - ```js - btoa('USERNAME:PASSWORD') - ``` - - The output is the following: - - ```js - 'VVNFUk5BTUU6UEFTU1dPUkQ=' - ``` - - Once you have the Base64-encoded credentials, you can pass them in the - `Authorization` header--for example: - - ```sh - curl --get "INFLUX_URL/api/v2/signin" - --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" - ``` - - To learn more about HTTP authentication, see - [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ - scheme: basic - type: http - TokenAuthentication: - description: | - Use the [Token authentication](#section/Authentication/TokenAuthentication) - scheme to authenticate to the InfluxDB API. - - In your API requests, send an `Authorization` header. - For the header value, provide the word `Token` followed by a space and an InfluxDB API token. - The word `Token` is case-sensitive. - - ### Syntax - - `Authorization: Token INFLUX_API_TOKEN` - - ### Example - - #### Use Token authentication with cURL - - The following example shows how to use cURL to send an API request that uses Token authentication: - - ```sh - curl --request GET "INFLUX_URL/api/v2/buckets" \ - --header "Authorization: Token INFLUX_API_TOKEN" - ``` - - Replace the following: - - - *`INFLUX_URL`*: your InfluxDB URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/latest/reference/glossary/#token) - - ### Related endpoints - - - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) - - ### Related guides - - - [Authorize API requests](/influxdb/latest/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/latest/security/tokens/) - in: header - name: Authorization - type: apiKey +openapi: 3.0.0 info: title: InfluxDB OSS API Service - version: 2.7.0 + version: 2.x description: | - The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. + The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints. This documentation is generated from the [InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/ref/oss.yml). license: name: MIT url: https://opensource.org/licenses/MIT -openapi: 3.0.0 + summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. +servers: + - url: / +security: + - TokenAuthentication: [] +tags: + - 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) + + name: Authentication + x-traitTag: true + - description: | + Create and manage authorizations (API tokens). + + An _authorization_ contains a list of `read` and `write` + permissions for organization resources and provides an API token for authentication. + An authorization belongs to an organization and only contains permissions for that organization. + + We recommend creating a generic user to create and manage tokens for writing data. + + ### User sessions with authorizations + + Optionally, when creating an authorization, you can scope it to a specific user. + If a user signs in with username and password, creating a _user session_, + the session carries the permissions granted by all the user's authorizations. + For more information, see [how to assign a token to a specific user](/influxdb/latest/security/tokens/create-token/). + To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + + ### Related endpoints + + - [Signin](#tag/Signin) + - [Signout](#tag/Signout) + + ### Related guides + + - [Authorize API requests](/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/latest/security/tokens/) + - [Assign a token to a specific user](/influxdb/latest/security/tokens/create-token/) + name: Authorizations (API tokens) + - name: Backup + - description: | + Store your data in InfluxDB [buckets](/influxdb/latest/reference/glossary/#bucket). + A bucket is a named location where time series data is stored. All buckets + have a [retention period](/influxdb/latest/reference/glossary/#retention-period), + a duration of time that each data point persists. InfluxDB drops all + points with timestamps older than the bucket’s retention period. + A bucket belongs to an organization. + + ### Related guides + + - [Manage buckets](/influxdb/latest/organizations/buckets/) + name: Buckets + - name: Cells + - name: Checks + - description: | + To specify resources, some InfluxDB API endpoints require parameters or + properties in the request--for example, + writing to a `bucket` resource in an `org` (_organization_ resource). + + ### Common parameters + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/latest/organizations/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/latest/organizations/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](/influxdb/latest/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/latest/organizations/view-orgs/). | + name: Common parameters + x-traitTag: true + - name: Config + - name: Dashboards + - name: Data I/O endpoints + - description: | + The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) + and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). + InfluxDB 2.x replaces databases and retention policies with buckets. + To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, + databases and retention policies are mapped to buckets using the + database and retention policy (DBRP) mapping service. + The DBRP mapping service uses the database and retention policy + specified in 1.x compatibility API requests to route operations to a bucket. + + ### Related guides + + - [Database and retention policy mapping](/influxdb/latest/reference/api/influxdb-1x/dbrp/) + name: DBRPs + - description: | + Generate profiling and trace reports. + + Use routes under `/debug/pprof` to analyze the Go runtime of InfluxDB. + These endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof) + and **trace** reports. + **Profiles** are collections of stack traces that show call sequences + leading to instances of a particular event, such as allocation. + + For more information about **pprof profile** and **trace** reports, + see the following resources: + + - [Google pprof tool](https://github.com/google/pprof) + - [Golang diagnostics](https://go.dev/doc/diagnostics) + name: Debug + - description: | + Delete data from an InfluxDB bucket. + name: Delete + - description: | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | + | `Content-Type` | string | The format of the data in the request body. | + name: Headers + x-traitTag: true + - name: Health + - name: Labels + - name: Legacy Authorizations + - name: Legacy Query + - name: Legacy Write + - name: Metrics + - name: NotificationEndpoints + - name: NotificationRules + - description: | + Create and manage your [organizations](/influxdb/latest/reference/glossary/#organization). + An organization is a workspace for a group of users. Organizations can be + used to separate different environments, projects, teams or users within + InfluxDB. + + Use the `/api/v2/orgs` endpoints to create, view, and manage organizations. + name: Organizations + - description: | + Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `limit` | integer | The maximum number of records to return (after other parameters are applied). | + | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | + | `after` | string (resource ID) | Only returns resources created after the specified resource. | + + ### Limitations + + - For specific endpoint parameters and examples, see the endpoint definition. + - If you specify an `offset` parameter value greater than the total number of records, + then InfluxDB returns an empty list in the response + (given `offset` skips the specified number of records). + + The following example passes `offset=50` to skip the first 50 results, + but the user only has 10 buckets: + + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` + + The response contains the following: + + ```json + { + "links": { + "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", + "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" + }, + "buckets": [] + } + ``` + name: Pagination + x-traitTag: true + - name: Ping + - description: | + Retrieve data, analyze queries, and get query suggestions. + name: Query + - description: | + See the [**API Quick Start**](/influxdb/latest/api-guide/api_intro/) + to get up and running authenticating with tokens, writing to buckets, and querying data. + + [**InfluxDB API client libraries**](/influxdb/latest/api-guide/client-libraries/) + are available for popular languages and ready to import into your application. + name: Quick start + x-traitTag: true + - name: Ready + - name: RemoteConnections + - name: Replications + - name: Resources + - description: | + InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. + The response body may include additional details. + For details about a specific operation's response, + see **Responses** and **Response Samples** for that operation. + + API operations may return the following HTTP status codes: + + |  Code  | Status | Description | + |:-----------:|:------------------------ |:--------------------- | + | `200` | Success | | + | `204` | Success. No content | InfluxDB doesn't return data for the request. | + | `400` | Bad request | May indicate one of the following:
  • 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.
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| + | `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/latest/security/tokens/)
| + | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | + | `413` | Request entity too large | Request payload exceeds the size limit. | + | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | + | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | + | `500` | Internal server error | | + | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | + name: Response codes + x-traitTag: true + - name: Restore + - name: Routes + - name: Rules + - name: Scraper Targets + - name: Secrets + - name: Security and access endpoints + - name: Setup + - name: Signin + - name: Signout + - name: Sources + - 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" + name: Supported operations + x-traitTag: true + - name: System information endpoints + - description: | + Process and analyze your data with [tasks](/influxdb/latest/reference/glossary/#task) + in the InfluxDB task engine. + Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + + 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). + + + + ### Properties + + A `task` object contains information about an InfluxDB task resource. + + The following table defines the properties that appear in a `task` object: + + + + ### Related guides + + - [Get started with tasks](/influxdb/latest/process-data/get-started/) + - [Common data processing tasks](/influxdb/latest/process-data/common-tasks/) + name: Tasks + - name: Telegraf Plugins + - name: Telegrafs + - description: | + Export and apply InfluxDB **templates**. + Manage **stacks** of templated InfluxDB resources. + + InfluxDB templates are prepackaged configurations for + everything from dashboards and Telegraf to notifications and alerts. + Use InfluxDB templates to quickly configure a fresh instance of InfluxDB, + back up your dashboard configuration, or share your configuration with the + InfluxData community. + + Use the `/api/v2/templates` endpoints to export templates and apply templates. + + **InfluxDB stacks** are stateful InfluxDB templates that let you + add, update, and remove installed template resources over time, avoid duplicating + resources when applying the same or similar templates more than once, and + apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + + Use the `/api/v2/stacks` endpoints to manage installed template resources. + + ### Related guides + + - [InfluxDB stacks](/influxdb/latest/influxdb-templates/stacks/) + - [InfluxDB templates](/influxdb/latest/influxdb-templates/) + name: Templates + - description: | + Manage users for your organization. + Users are those with access to InfluxDB. + To grant a user permission to access data, add them as a member of an + organization and provide them with an API token. + + ### User sessions with authorizations + + Optionally, you can scope an authorization (and its API token) to a user. + If a user signs in with username and password, creating a _user session_, + 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). + + ### Related guides + + - [Manage users](/influxdb/latest/influxdb/latest/users/) + - [Create a token scoped to a user](/influxdb/latest/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) + name: Users + - name: Variables + - name: Views + - description: | + Write time series data to [buckets](/influxdb/latest/reference/glossary/#bucket). + name: Write paths: /api/v2: get: @@ -19685,304 +13278,6712 @@ paths: summary: Write time series data into InfluxDB in a V1-compatible format tags: - Legacy Write -security: - - TokenAuthentication: [] -servers: - - url: / -tags: - - description: | - Use one of the following schemes to authenticate to the InfluxDB API: +components: + examples: + AuthorizationPostRequest: + description: Creates an authorization. + summary: An authorization for a resource type + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + type: buckets + AuthorizationWithResourcePostRequest: + description: Creates an authorization for access to a specific resource. + summary: An authorization for a resource + value: + description: iot_users read buckets + orgID: INFLUX_ORG_ID + permissions: + - action: read + resource: + id: INFLUX_BUCKET_ID + type: buckets + AuthorizationWithUserPostRequest: + description: Creates an authorization scoped to a specific user. + summary: An authorization scoped to a user + value: + description: iot_user write to bucket + orgID: INFLUX_ORG_ID + permissions: + - action: write + resource: + id: INFLUX_BUCKET_ID + type: buckets + userID: INFLUX_USER_ID + TaskWithFluxRequest: + description: Sets the `flux` property with Flux task options and a query. + summary: A task with Flux + value: + description: This task contains Flux that configures the task schedule and downsamples CPU data every hour. + flux: "option task = {name: \"CPU Total 1 Hour New\", every: 1h}from(bucket: \"telegraf\") |> range(start: -1h) |> filter(fn: (r) => (r._measurement == \"cpu\")) |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) |> filter(fn: (r) => (r.cpu == \"cpu-total\")) |> aggregateWindow(every: 1h, fn: max) |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")" + status: active + parameters: + After: + description: | + A resource ID to seek from. + Returns records created after the specified record; + results don't include the specified record. - - [Token authentication](#section/Authentication/TokenAuthentication) - - [Basic authentication](#section/Authentication/BasicAuthentication) - - [Querystring authentication](#section/Authentication/QuerystringAuthentication) - - name: Authentication - x-traitTag: true - - description: | - Create and manage authorizations (API tokens). + Use `after` instead of the `offset` parameter. + For more information about pagination parameters, see [Pagination](/influxdb/latest/api/#tag/Pagination). + in: query + name: after + required: false + schema: + type: string + Descending: + in: query + name: descending + required: false + schema: + default: false + type: boolean + Limit: + description: | + Limits the number of records returned. Default is `20`. + in: query + name: limit + required: false + schema: + default: 20 + maximum: 100 + minimum: 1 + type: integer + Offset: + description: | + The offset for pagination. + The number of records to skip. - An _authorization_ contains a list of `read` and `write` - permissions for organization resources and provides an API token for authentication. - An authorization belongs to an organization and only contains permissions for that organization. + For more information about pagination parameters, see [Pagination](/influxdb/latest/api/#tag/Pagination). + in: query + name: offset + required: false + schema: + minimum: 0 + type: integer + SortBy: + in: query + name: sortBy + required: false + schema: + type: string + TraceSpan: + description: OpenTracing span context + example: + baggage: + key: value + span_id: '1' + trace_id: '1' + in: header + name: Zap-Trace-Span + required: false + schema: + type: string + responses: + AuthorizationError: + content: + application/json: + examples: + tokenNotAuthorized: + summary: Token is not authorized to access a resource + value: + code: unauthorized + message: unauthorized access + schema: + properties: + code: + description: | + The HTTP status code description. Default is `unauthorized`. + enum: + - unauthorized + readOnly: true + type: string + message: + description: A human-readable message that may contain detail about the error. + readOnly: true + type: string + description: | + Unauthorized. The error may indicate one of the following: - We recommend creating a generic user to create and manage tokens for writing data. + * The `Authorization: Token` header is missing or malformed. + * The API token value is missing from the header. + * The token doesn't have sufficient permissions to write to this organization and bucket. + BadRequestError: + content: + application/json: + examples: + orgProvidedNotFound: + summary: The org or orgID passed doesn't own the token passed in the header + value: + code: invalid + message: 'failed to decode request body: organization not found' + schema: + $ref: '#/components/schemas/Error' + description: | + Bad request. + The response body contains detail about the error. - ### User sessions with authorizations + #### InfluxDB OSS - Optionally, when creating an authorization, you can scope it to a specific user. - If a user signs in with username and password, creating a _user session_, - the session carries the permissions granted by all the user's authorizations. - For more information, see [how to assign a token to a specific user](/influxdb/latest/security/tokens/create-token/). - To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). + - Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter. + GeneralServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + InternalServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: | + Internal server error. + The server encountered an unexpected situation. + ResourceNotFoundError: + content: + application/json: + examples: + bucket-not-found: + summary: Bucket name not found + value: + code: not found + message: bucket "air_sensor" not found + org-not-found: + summary: Organization name not found + value: + code: not found + message: organization name "my-org" not found + orgID-not-found: + summary: Organization ID not found + value: + code: not found + message: organization not found + schema: + $ref: '#/components/schemas/Error' + description: | + Not found. + A requested resource was not found. + The response body contains the requested resource type and the name value + (if you passed it)--for example: - ### Related endpoints + - `"organization name \"my-org\" not found"` + - `"organization not found"`: indicates you passed an ID that did not match + an organization. + ServerError: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Non 2XX error response from server. + schemas: + ASTResponse: + description: Contains the AST for the supplied Flux query + properties: + ast: + $ref: '#/components/schemas/Package' + type: object + AddResourceMemberRequestBody: + properties: + id: + description: | + The ID of the user to add to the resource. + type: string + name: + description: | + The name of the user to add to the resource. + type: string + required: + - id + type: object + AnalyzeQueryResponse: + properties: + errors: + items: + properties: + character: + type: integer + column: + type: integer + line: + type: integer + message: + type: string + type: object + type: array + type: object + ArrayExpression: + description: Used to create and directly specify the elements of an array object + properties: + elements: + description: Elements of the array + items: + $ref: '#/components/schemas/Expression' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + Authorization: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + createdAt: + format: date-time + readOnly: true + type: string + id: + description: The authorization ID. + readOnly: true + type: string + links: + example: + self: /api/v2/authorizations/1 + user: /api/v2/users/12 + properties: + self: + $ref: '#/components/schemas/Link' + readOnly: true + user: + $ref: '#/components/schemas/Link' + readOnly: true + readOnly: true + type: object + org: + description: | + The organization name. + Specifies the [organization](/influxdb/v2.7/reference/glossary/#organization) + that the token is scoped to. + readOnly: true + type: string + orgID: + description: | + The organization ID. + Specifies the [organization](/influxdb/v2.7/reference/glossary/#organization) that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions. + An authorization must have at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: | + The API token. + The token value is unique to the authorization. + [API tokens](/influxdb/v2.7/reference/glossary/#token) are + used to authenticate and authorize InfluxDB API requests and `influx` + CLI commands--after receiving the request, InfluxDB checks that the + token is valid and that the `permissions` allow the requested action(s). + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + user: + description: | + The user name. + Specifies the [user](/influxdb/v2.7/reference/glossary/#user) that owns the authorization. + If the authorization is _scoped_ to a user, the user; + otherwise, the creator of the authorization. + readOnly: true + type: string + userID: + description: The user ID. Specifies the [user](/influxdb/v2.7/reference/glossary/#user) that owns the authorization. If _scoped_, the user that the authorization is scoped to; otherwise, the creator of the authorization. + readOnly: true + type: string + type: object + required: + - orgID + - permissions + AuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: | + An organization ID. + Specifies the organization that owns the authorization. + type: string + permissions: + description: | + A list of permissions for an authorization. + In the list, provide at least one `permission` object. - - [Signin](#tag/Signin) - - [Signout](#tag/Signout) + In a `permission`, the `resource.type` property grants access to all + resources of the specified type. + To grant access to only a specific resource, specify the + `resource.id` property. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + userID: + description: | + A user ID. + Specifies the user that the authorization is scoped to. - ### Related guides + When a user authenticates with username and password, + InfluxDB generates a _user session_ with all the permissions + specified by all the user's authorizations. + type: string + type: object + required: + - orgID + - permissions + AuthorizationUpdateRequest: + properties: + description: + description: A description of the token. + type: string + status: + default: active + description: Status of the token. If `inactive`, InfluxDB rejects requests that use the token. + enum: + - active + - inactive + type: string + Authorizations: + properties: + authorizations: + items: + $ref: '#/components/schemas/Authorization' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + Axes: + description: The viewport for a View's visualizations + properties: + x: + $ref: '#/components/schemas/Axis' + 'y': + $ref: '#/components/schemas/Axis' + required: + - x + - 'y' + type: object + Axis: + description: Axis used in a visualization. + properties: + base: + description: Radix for formatting axis values. + enum: + - '' + - '2' + - '10' + type: string + bounds: + description: The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. + items: + type: string + maxItems: 2 + minItems: 0 + type: array + label: + description: Description of the axis. + type: string + prefix: + description: Label prefix for formatting axis values. + type: string + scale: + $ref: '#/components/schemas/AxisScale' + suffix: + description: Label suffix for formatting axis values. + type: string + type: object + AxisScale: + description: 'Scale is the axis formatting scale. Supported: "log", "linear"' + enum: + - log + - linear + type: string + BadStatement: + description: A placeholder for statements for which no correct statement nodes can be created + properties: + text: + description: Raw source text + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + BandViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + lowerColumn: + type: string + mainColumn: + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - band + type: string + upperColumn: + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + type: object + BinaryExpression: + description: uses binary operators to act on two operands in an expression + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Block: + description: A set of statements + properties: + body: + description: Block body + items: + $ref: '#/components/schemas/Statement' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + BooleanLiteral: + description: Represents boolean values + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: boolean + type: object + Bucket: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/buckets/1/labels + members: /api/v2/buckets/1/members + org: /api/v2/orgs/2 + owners: /api/v2/buckets/1/owners + self: /api/v2/buckets/1 + write: /api/v2/write?org=2&bucket=1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this bucket. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members that can read this bucket. + org: + $ref: '#/components/schemas/Link' + description: The URL to retrieve parent organization for this bucket. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners that can read and write to this bucket. + self: + $ref: '#/components/schemas/Link' + description: The URL for this bucket. + write: + $ref: '#/components/schemas/Link' + description: The URL to write line protocol to this bucket. + readOnly: true + type: object + name: + type: string + orgID: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + type: + default: user + enum: + - user + - system + readOnly: true + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - retentionRules + BucketMetadataManifest: + properties: + bucketID: + type: string + bucketName: + type: string + defaultRetentionPolicy: + type: string + description: + type: string + organizationID: + type: string + organizationName: + type: string + retentionPolicies: + $ref: '#/components/schemas/RetentionPolicyManifests' + required: + - organizationID + - organizationName + - bucketID + - bucketName + - defaultRetentionPolicy + - retentionPolicies + type: object + BucketMetadataManifests: + items: + $ref: '#/components/schemas/BucketMetadataManifest' + type: array + BucketShardMapping: + properties: + newId: + format: int64 + type: integer + oldId: + format: int64 + type: integer + required: + - oldId + - newId + type: object + BucketShardMappings: + items: + $ref: '#/components/schemas/BucketShardMapping' + type: array + Buckets: + properties: + buckets: + items: + $ref: '#/components/schemas/Bucket' + type: array + links: + $ref: '#/components/schemas/Links' + readOnly: true + type: object + BuilderAggregateFunctionType: + enum: + - filter + - group + type: string + BuilderConfig: + properties: + aggregateWindow: + properties: + fillValues: + type: boolean + period: + type: string + type: object + buckets: + items: + type: string + type: array + functions: + items: + $ref: '#/components/schemas/BuilderFunctionsType' + type: array + tags: + items: + $ref: '#/components/schemas/BuilderTagsType' + type: array + type: object + BuilderFunctionsType: + properties: + name: + type: string + type: object + BuilderTagsType: + properties: + aggregateFunctionType: + $ref: '#/components/schemas/BuilderAggregateFunctionType' + key: + type: string + values: + items: + type: string + type: array + type: object + BuiltinStatement: + description: Declares a builtin identifier and its type + properties: + id: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + CallExpression: + description: Represents a function call + properties: + arguments: + description: Function arguments + items: + $ref: '#/components/schemas/Expression' + type: array + callee: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Cell: + properties: + h: + format: int32 + type: integer + id: + type: string + links: + properties: + self: + type: string + view: + type: string + type: object + viewID: + description: The reference to a view from the views API. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellUpdate: + properties: + h: + format: int32 + type: integer + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CellWithViewProperties: + allOf: + - $ref: '#/components/schemas/Cell' + - properties: + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + type: object + type: object + Cells: + items: + $ref: '#/components/schemas/Cell' + type: array + CellsWithViewProperties: + items: + $ref: '#/components/schemas/CellWithViewProperties' + type: array + Check: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + CheckBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the check. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/checks/1/labels + members: /api/v2/checks/1/members + owners: /api/v2/checks/1/owners + query: /api/v2/checks/1/query + self: /api/v2/checks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this check. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this check. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this check. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this check. + self: + $ref: '#/components/schemas/Link' + description: The URL for this check. + readOnly: true + type: object + name: + type: string + orgID: + description: The ID of the organization that owns this check. + type: string + ownerID: + description: The ID of creator used to create this check. + readOnly: true + type: string + query: + $ref: '#/components/schemas/DashboardQuery' + status: + $ref: '#/components/schemas/TaskStatusType' + taskID: + description: The ID of the task associated with this check. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + - orgID + - query + CheckDiscriminator: + discriminator: + mapping: + custom: '#/components/schemas/CustomCheck' + deadman: '#/components/schemas/DeadmanCheck' + threshold: '#/components/schemas/ThresholdCheck' + propertyName: type + oneOf: + - $ref: '#/components/schemas/DeadmanCheck' + - $ref: '#/components/schemas/ThresholdCheck' + - $ref: '#/components/schemas/CustomCheck' + CheckPatch: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + CheckStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + type: string + CheckViewProperties: + properties: + adaptiveZoomHide: + type: boolean + check: + $ref: '#/components/schemas/Check' + checkID: + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - check + type: string + required: + - type + - shape + - checkID + - queries + - colors + type: object + Checks: + properties: + checks: + items: + $ref: '#/components/schemas/Check' + type: array + links: + $ref: '#/components/schemas/Links' + ColorMapping: + additionalProperties: + type: string + description: A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads. + example: + configcat_deployments-autopromotionblocker: '#663cd0' + measurement_birdmigration_europe: '#663cd0' + series_id_1: '#edf529' + series_id_2: '#edf529' + type: object + ConditionalExpression: + description: Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test` + properties: + alternate: + $ref: '#/components/schemas/Expression' + consequent: + $ref: '#/components/schemas/Expression' + test: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Config: + properties: + config: + type: object + type: object + ConstantVariableProperties: + properties: + type: + enum: + - constant + type: string + values: + items: + type: string + type: array + CreateCell: + properties: + h: + format: int32 + type: integer + name: + type: string + usingView: + description: Makes a copy of the provided view. + type: string + w: + format: int32 + type: integer + x: + format: int32 + type: integer + 'y': + format: int32 + type: integer + type: object + CreateDashboardRequest: + properties: + description: + description: The user-facing description of the dashboard. + type: string + name: + description: The user-facing name of the dashboard. + type: string + orgID: + description: The ID of the organization that owns the dashboard. + type: string + required: + - orgID + - name + CustomCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + type: + enum: + - custom + type: string + required: + - type + type: object + DBRP: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + If set to `true`, this DBRP mapping is the default retention policy + for the database (specified by the `database` property's value). + type: boolean + id: + description: | + The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. + readOnly: true + type: string + links: + $ref: '#/components/schemas/Links' + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + virtual: + description: Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. + type: boolean + required: + - id + - orgID + - bucketID + - database + - retention_policy + - default + type: object + DBRPCreate: + properties: + bucketID: + description: | + A bucket ID. + Identifies the bucket used as the target for the translation. + type: string + database: + description: | + A database name. + Identifies the InfluxDB v1 database. + type: string + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + type: boolean + org: + description: | + An organization name. + Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. + type: string + orgID: + description: | + An organization ID. + Identifies the [organization](/influxdb/latest/reference/glossary/#organization) that owns the mapping. + type: string + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + required: + - bucketID + - database + - retention_policy + type: object + DBRPGet: + properties: + content: + $ref: '#/components/schemas/DBRP' + required: true + type: object + DBRPUpdate: + properties: + default: + description: | + Set to `true` to use this DBRP mapping as the default retention policy + for the database (specified by the `database` property's value). + To remove the default mapping, set to `false`. + type: boolean + retention_policy: + description: | + A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name. + Identifies the InfluxDB v1 retention policy mapping. + type: string + DBRPs: + properties: + content: + items: + $ref: '#/components/schemas/DBRP' + type: array + Dashboard: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/Cells' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + DashboardColor: + description: Defines an encoding of data value into color space. + properties: + hex: + description: The hex number of the color + maxLength: 7 + minLength: 7 + type: string + id: + description: The unique ID of the view color. + type: string + name: + description: The user-facing name of the hex color. + type: string + type: + description: Type is how the color is used. + enum: + - min + - max + - threshold + - scale + - text + - background + type: string + value: + description: The data value mapped to this color. + format: float + type: number + required: + - id + - type + - hex + - name + - value + type: object + DashboardQuery: + properties: + builderConfig: + $ref: '#/components/schemas/BuilderConfig' + editMode: + $ref: '#/components/schemas/QueryEditMode' + name: + type: string + text: + description: The text of the Flux query. + type: string + type: object + DashboardWithViewProperties: + allOf: + - $ref: '#/components/schemas/CreateDashboardRequest' + - properties: + cells: + $ref: '#/components/schemas/CellsWithViewProperties' + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + cells: /api/v2/dashboards/1/cells + labels: /api/v2/dashboards/1/labels + members: /api/v2/dashboards/1/members + org: /api/v2/labels/1 + owners: /api/v2/dashboards/1/owners + self: /api/v2/dashboards/1 + properties: + cells: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + org: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + type: object + meta: + properties: + createdAt: + format: date-time + type: string + updatedAt: + format: date-time + type: string + type: object + type: object + type: object + Dashboards: + properties: + dashboards: + items: + $ref: '#/components/schemas/Dashboard' + type: array + links: + $ref: '#/components/schemas/Links' + type: object + DateTimeLiteral: + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp). + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + format: date-time + type: string + type: object + DeadmanCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + level: + $ref: '#/components/schemas/CheckStatusLevel' + offset: + description: Duration to delay after the schedule, before executing check. + type: string + reportZero: + description: If only zero values reported since time, trigger an alert + type: boolean + staleTime: + description: String duration for time that a series is considered stale and should not trigger deadman. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + timeSince: + description: String duration before deadman triggers. + type: string + type: + enum: + - deadman + type: string + required: + - type + type: object + DecimalPlaces: + description: Indicates whether decimal places should be enforced, and how many digits it should show. + properties: + digits: + description: The number of digits after decimal to display + format: int32 + type: integer + isEnforced: + description: Indicates whether decimal point setting should be enforced + type: boolean + type: object + DeletePredicateRequest: + description: The delete predicate request. + properties: + predicate: + description: | + An expression in [delete predicate syntax](/influxdb/latest/reference/syntax/delete-predicate/). + example: tag1="value1" and (tag2="value2" and tag3!="value3") + type: string + start: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)). + The earliest time to delete from. + format: date-time + type: string + stop: + description: | + A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)). + The latest time to delete from. + format: date-time + type: string + required: + - start + - stop + type: object + Dialect: + description: | + Options for tabular data output. + Default output is [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/#csv-response-format) with headers. - - [Authorize API requests](/influxdb/latest/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/latest/security/tokens/) - - [Assign a token to a specific user](/influxdb/latest/security/tokens/create-token/) - name: Authorizations (API tokens) - - name: Backup - - description: | - Store your data in InfluxDB [buckets](/influxdb/latest/reference/glossary/#bucket). - A bucket is a named location where time series data is stored. All buckets - have a [retention period](/influxdb/latest/reference/glossary/#retention-period), - a duration of time that each data point persists. InfluxDB drops all - points with timestamps older than the bucket’s retention period. - A bucket belongs to an organization. + For more information about tabular data **dialect**, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions). + properties: + annotations: + description: | + Annotation rows to include in the results. + An _annotation_ is metadata associated with an object (column) in the data model. - ### Related guides + #### Related guides - - [Manage buckets](/influxdb/latest/organizations/buckets/) - name: Buckets - - name: Cells - - name: Checks - - description: | - To specify resources, some InfluxDB API endpoints require parameters or - properties in the request--for example, - writing to a `bucket` resource in an `org` (_organization_ resource). + - See [Annotated CSV annotations](/influxdb/latest/reference/syntax/annotated-csv/#annotations) for examples and more information. - ### Common parameters + For more information about **annotations** in tabular data, + see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns). + items: + enum: + - group + - datatype + - default + type: string + type: array + uniqueItems: true + commentPrefix: + default: '#' + description: The character prefixed to comment strings. Default is a number sign (`#`). + maxLength: 1 + minLength: 0 + type: string + dateTimeFormat: + default: RFC3339 + description: | + The format for timestamps in results. + Default is [`RFC3339` date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp). + To include nanoseconds in timestamps, use `RFC3339Nano`. - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb/latest/organizations/buckets/view-buckets/). | - | `bucketID` | string | The bucket ID ([find your bucket](/influxdb/latest/organizations/buckets/view-buckets/). | - | `org` | string | The organization name or ID ([find your organization](/influxdb/latest/organizations/view-orgs/). | - | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb/latest/organizations/view-orgs/). | - name: Common parameters - x-traitTag: true - - name: Config - - name: Dashboards - - name: Data I/O endpoints - - description: | - The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database) - and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp). - InfluxDB 2.x replaces databases and retention policies with buckets. - To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, - databases and retention policies are mapped to buckets using the - database and retention policy (DBRP) mapping service. - The DBRP mapping service uses the database and retention policy - specified in 1.x compatibility API requests to route operations to a bucket. + #### Example formatted date/time values - ### Related guides + | Format | Value | + |:------------|:----------------------------| + | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | + | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | + enum: + - RFC3339 + - RFC3339Nano + type: string + delimiter: + default: ',' + description: The separator used between cells. Default is a comma (`,`). + maxLength: 1 + minLength: 1 + type: string + header: + default: true + description: If true, the results contain a header row. + type: boolean + type: object + DictExpression: + description: Used to create and directly specify the elements of a dictionary + properties: + elements: + description: Elements of the dictionary + items: + $ref: '#/components/schemas/DictItem' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + DictItem: + description: A key-value pair in a dictionary. + properties: + key: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + val: + $ref: '#/components/schemas/Expression' + type: object + Duration: + description: A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed. + properties: + magnitude: + type: integer + type: + $ref: '#/components/schemas/NodeType' + unit: + type: string + type: object + DurationLiteral: + description: Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration + properties: + type: + $ref: '#/components/schemas/NodeType' + values: + description: Duration values + items: + $ref: '#/components/schemas/Duration' + type: array + type: object + Error: + properties: + code: + $ref: '#/components/schemas/ErrorCode' + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + ErrorCode: + description: code is the machine-readable error code. + enum: + - internal error + - not implemented + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + - request too large + - unsupported media type + readOnly: true + type: string + Expression: + oneOf: + - $ref: '#/components/schemas/ArrayExpression' + - $ref: '#/components/schemas/DictExpression' + - $ref: '#/components/schemas/FunctionExpression' + - $ref: '#/components/schemas/BinaryExpression' + - $ref: '#/components/schemas/CallExpression' + - $ref: '#/components/schemas/ConditionalExpression' + - $ref: '#/components/schemas/LogicalExpression' + - $ref: '#/components/schemas/MemberExpression' + - $ref: '#/components/schemas/IndexExpression' + - $ref: '#/components/schemas/ObjectExpression' + - $ref: '#/components/schemas/ParenExpression' + - $ref: '#/components/schemas/PipeExpression' + - $ref: '#/components/schemas/UnaryExpression' + - $ref: '#/components/schemas/BooleanLiteral' + - $ref: '#/components/schemas/DateTimeLiteral' + - $ref: '#/components/schemas/DurationLiteral' + - $ref: '#/components/schemas/FloatLiteral' + - $ref: '#/components/schemas/IntegerLiteral' + - $ref: '#/components/schemas/PipeLiteral' + - $ref: '#/components/schemas/RegexpLiteral' + - $ref: '#/components/schemas/StringLiteral' + - $ref: '#/components/schemas/UnsignedIntegerLiteral' + - $ref: '#/components/schemas/Identifier' + ExpressionStatement: + description: May consist of an expression that doesn't return a value and is executed solely for its side-effects + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Field: + properties: + alias: + description: Alias overrides the field name in the returned response. Applies only if type is `func` + type: string + args: + description: Args are the arguments to the function + items: + $ref: '#/components/schemas/Field' + type: array + type: + description: '`type` describes the field type. `func` is a function. `field` is a field reference.' + enum: + - func + - field + - integer + - number + - regex + - wildcard + type: string + value: + description: value is the value of the field. Meaning of the value is implied by the `type` key + type: string + type: object + File: + description: Represents a source from a single file + properties: + body: + description: List of Flux statements + items: + $ref: '#/components/schemas/Statement' + type: array + imports: + description: A list of package imports + items: + $ref: '#/components/schemas/ImportDeclaration' + type: array + name: + description: The name of the file. + type: string + package: + $ref: '#/components/schemas/PackageClause' + type: + $ref: '#/components/schemas/NodeType' + type: object + Flags: + additionalProperties: true + type: object + FloatLiteral: + description: Represents floating point numbers according to the double representations defined by the IEEE-754-1985 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: number + type: object + FluxResponse: + description: Rendered flux that backs the check or notification. + properties: + flux: + type: string + FluxSuggestion: + properties: + name: + type: string + params: + additionalProperties: + type: string + type: object + type: object + FluxSuggestions: + properties: + funcs: + items: + $ref: '#/components/schemas/FluxSuggestion' + type: array + type: object + FunctionExpression: + description: Function expression + properties: + body: + $ref: '#/components/schemas/Node' + params: + description: Function parameters + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + GaugeViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - gauge + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + GeoCircleViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Circle color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + interpolateColors: + description: Interpolate circle color based on displayed value + type: boolean + radius: + description: Maximum radius size in pixels + type: integer + radiusDimension: + $ref: '#/components/schemas/Axis' + radiusField: + description: Radius field + type: string + required: + - radiusField + - radiusDimension + - colorField + - colorDimension + - colors + type: object + GeoHeatMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + blur: + description: Blur for heatmap points + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + intensityDimension: + $ref: '#/components/schemas/Axis' + intensityField: + description: Intensity field + type: string + radius: + description: Radius size in pixels + type: integer + required: + - intensityField + - intensityDimension + - radius + - blur + - colors + type: object + GeoPointMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - properties: + colorDimension: + $ref: '#/components/schemas/Axis' + colorField: + description: Marker color field + type: string + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + isClustered: + description: Cluster close markers together + type: boolean + tooltipColumns: + description: An array for which columns to display in tooltip + items: + type: string + type: array + required: + - colorField + - colorDimension + - colors + type: object + GeoTrackMapViewLayer: + allOf: + - $ref: '#/components/schemas/GeoViewLayerProperties' + - required: + - trackWidth + - speed + - randomColors + - trackPointVisualization + type: object + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + randomColors: + description: Assign different colors to different tracks + type: boolean + speed: + description: Speed of the track animation + type: integer + trackWidth: + description: Width of the track + type: integer + GeoViewLayer: + oneOf: + - $ref: '#/components/schemas/GeoCircleViewLayer' + - $ref: '#/components/schemas/GeoHeatMapViewLayer' + - $ref: '#/components/schemas/GeoPointMapViewLayer' + - $ref: '#/components/schemas/GeoTrackMapViewLayer' + type: object + GeoViewLayerProperties: + properties: + type: + enum: + - heatmap + - circleMap + - pointMap + - trackMap + type: string + required: + - type + type: object + GeoViewProperties: + properties: + allowPanAndZoom: + default: true + description: If true, map zoom and pan controls are enabled on the dashboard view + type: boolean + center: + description: Coordinates of the center of the map + properties: + lat: + description: Latitude of the center of the map + format: double + type: number + lon: + description: Longitude of the center of the map + format: double + type: number + required: + - lat + - lon + type: object + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + detectCoordinateFields: + default: true + description: If true, search results get automatically regroupped so that lon,lat and value are treated as columns + type: boolean + latLonColumns: + $ref: '#/components/schemas/LatLonColumns' + layers: + description: List of individual layers shown in the map + items: + $ref: '#/components/schemas/GeoViewLayer' + type: array + mapStyle: + description: Define map type - regular, satellite etc. + type: string + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + s2Column: + description: String to define the column + type: string + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - geo + type: string + useS2CellID: + description: If true, S2 column is used to calculate lat/lon + type: boolean + zoom: + description: Zoom level used for initial display of the map + format: double + maximum: 28 + minimum: 1 + type: number + required: + - type + - shape + - queries + - note + - showNoteWhenEmpty + - center + - zoom + - allowPanAndZoom + - detectCoordinateFields + - layers + type: object + GreaterThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - greater + type: string + value: + format: float + type: number + required: + - type + - value + type: object + HTTPNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + authMethod: + enum: + - none + - basic + - bearer + type: string + contentTemplate: + type: string + headers: + additionalProperties: + type: string + description: Customized headers. + type: object + method: + enum: + - POST + - GET + - PUT + type: string + password: + type: string + token: + type: string + url: + type: string + username: + type: string + required: + - url + - authMethod + - method + type: object + type: object + HTTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/HTTPNotificationRuleBase' + HTTPNotificationRuleBase: + properties: + type: + enum: + - http + type: string + url: + type: string + required: + - type + type: object + HealthCheck: + properties: + checks: + items: + $ref: '#/components/schemas/HealthCheck' + type: array + commit: + type: string + message: + type: string + name: + type: string + status: + enum: + - pass + - fail + type: string + version: + type: string + required: + - name + - status + type: object + HeatmapViewProperties: + properties: + adaptiveZoomHide: + type: boolean + binSize: + type: number + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - heatmap + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + - binSize + type: object + HistogramViewProperties: + properties: + binCount: + type: integer + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + fillColumns: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - histogram + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + format: float + type: number + type: array + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - fillColumns + - xDomain + - xAxisLabel + - position + - binCount + type: object + Identifier: + description: A valid Flux identifier + properties: + name: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + ImportDeclaration: + description: Declares a package import + properties: + as: + $ref: '#/components/schemas/Identifier' + path: + $ref: '#/components/schemas/StringLiteral' + type: + $ref: '#/components/schemas/NodeType' + type: object + IndexExpression: + description: Represents indexing into an array + properties: + array: + $ref: '#/components/schemas/Expression' + index: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + InfluxqlCsvResponse: + description: CSV Response to InfluxQL Query + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + type: string + InfluxqlJsonResponse: + description: JSON Response to InfluxQL Query + properties: + results: + items: + properties: + error: + type: string + series: + items: + properties: + columns: + items: + type: string + type: array + name: + type: string + partial: + type: boolean + tags: + additionalProperties: + type: string + type: object + values: + items: + items: {} + type: array + type: array + type: object + type: array + statement_id: + type: integer + type: object + type: array + type: object + IntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + IsOnboarding: + properties: + allowed: + description: | + If `true`, the InfluxDB instance hasn't had initial setup; + `false` otherwise. + type: boolean + type: object + Label: + properties: + id: + readOnly: true + type: string + name: + type: string + orgID: + readOnly: true + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + type: object + LabelCreateRequest: + properties: + name: + type: string + orgID: + type: string + properties: + additionalProperties: + type: string + description: | + Key-value pairs associated with this label. - - [Database and retention policy mapping](/influxdb/latest/reference/api/influxdb-1x/dbrp/) - name: DBRPs - - description: | - Generate profiling and trace reports. + To remove a property, send an update with an empty value (`""`) for the key. + example: + color: ffb3b3 + description: this is a description + type: object + required: + - orgID + - name + type: object + LabelMapping: + description: A _label mapping_ contains a `label` ID to attach to a resource. + properties: + labelID: + description: | + A label ID. + Specifies the label to attach. + type: string + required: + - labelID + type: object + LabelResponse: + properties: + label: + $ref: '#/components/schemas/Label' + links: + $ref: '#/components/schemas/Links' + type: object + LabelUpdate: + properties: + name: + type: string + properties: + additionalProperties: + description: | + Key-value pairs associated with this label. - Use routes under `/debug/pprof` to analyze the Go runtime of InfluxDB. - These endpoints generate [Go runtime profiles](https://pkg.go.dev/runtime/pprof) - and **trace** reports. - **Profiles** are collections of stack traces that show call sequences - leading to instances of a particular event, such as allocation. + To remove a property, send an update with an empty value (`""`) for the key. + type: string + example: + color: ffb3b3 + description: this is a description + type: object + type: object + Labels: + items: + $ref: '#/components/schemas/Label' + type: array + LabelsResponse: + properties: + labels: + $ref: '#/components/schemas/Labels' + links: + $ref: '#/components/schemas/Links' + type: object + LanguageRequest: + description: Flux query to be analyzed. + properties: + query: + description: | + The Flux query script to be analyzed. + type: string + required: + - query + type: object + LatLonColumn: + description: Object type for key and column definitions + properties: + column: + description: Column to look up Lat/Lon + type: string + key: + description: Key to determine whether the column is tag/field + type: string + required: + - key + - column + type: object + LatLonColumns: + description: Object type to define lat/lon columns + properties: + lat: + $ref: '#/components/schemas/LatLonColumn' + lon: + $ref: '#/components/schemas/LatLonColumn' + required: + - lat + - lon + type: object + LegacyAuthorizationPostRequest: + allOf: + - $ref: '#/components/schemas/AuthorizationUpdateRequest' + - properties: + orgID: + description: The organization ID. Identifies the organization that the authorization is scoped to. + type: string + permissions: + description: | + The list of permissions that provide `read` and `write` access to organization resources. + An authorization must contain at least one permission. + items: + $ref: '#/components/schemas/Permission' + minItems: 1 + type: array + token: + description: The name that you provide for the authorization. + type: string + userID: + description: The user ID. Identifies the user that the authorization is scoped to. + type: string + type: object + required: + - orgID + - permissions + LesserThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + type: + enum: + - lesser + type: string + value: + format: float + type: number + required: + - type + - value + type: object + LinePlusSingleStatProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + timeFormat: + type: string + type: + enum: + - line-plus-single-stat + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - prefix + - suffix + - decimalPlaces + - position + type: object + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - invalid + readOnly: true + type: string + message: + description: Human-readable message. + readOnly: true + type: string + required: + - code + - message + Link: + description: URI of resource. + format: uri + readOnly: true + type: string + Links: + description: | + URI pointers for additional paged results. + properties: + next: + $ref: '#/components/schemas/Link' + prev: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + required: + - self + type: object + LogEvent: + properties: + message: + description: A description of the event that occurred. + example: Halt and catch fire + readOnly: true + type: string + runID: + description: The ID of the task run that generated the event. + readOnly: true + type: string + time: + description: The time ([RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + type: object + LogicalExpression: + description: Represents the rule conditions that collectively evaluate to either true or false + properties: + left: + $ref: '#/components/schemas/Expression' + operator: + type: string + right: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Logs: + properties: + events: + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + type: object + MapVariableProperties: + properties: + type: + enum: + - map + type: string + values: + additionalProperties: + type: string + type: object + MarkdownViewProperties: + properties: + note: + type: string + shape: + enum: + - chronograf-v2 + type: string + type: + enum: + - markdown + type: string + required: + - type + - shape + - note + type: object + MemberAssignment: + description: Object property assignment + properties: + init: + $ref: '#/components/schemas/Expression' + member: + $ref: '#/components/schemas/MemberExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + MemberExpression: + description: Represents accessing a property of an object + properties: + object: + $ref: '#/components/schemas/Expression' + property: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + type: object + MetadataBackup: + properties: + buckets: + $ref: '#/components/schemas/BucketMetadataManifests' + kv: + format: binary + type: string + sql: + format: binary + type: string + required: + - kv + - sql + - buckets + type: object + MosaicViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + timeFormat: + type: string + type: + enum: + - mosaic + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yLabelColumnSeparator: + type: string + yLabelColumns: + items: + type: string + type: array + yPrefix: + type: string + ySeriesColumns: + items: + type: string + type: array + ySuffix: + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - ySeriesColumns + - fillColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + Node: + oneOf: + - $ref: '#/components/schemas/Expression' + - $ref: '#/components/schemas/Block' + NodeType: + description: Type of AST node + type: string + NotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + NotificationEndpointBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification endpoint. + type: string + id: + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + example: + labels: /api/v2/notificationEndpoints/1/labels + members: /api/v2/notificationEndpoints/1/members + owners: /api/v2/notificationEndpoints/1/owners + self: /api/v2/notificationEndpoints/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this endpoint. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this endpoint. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this endpoint. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + type: string + orgID: + type: string + status: + default: active + description: The status of the endpoint. + enum: + - active + - inactive + type: string + type: + $ref: '#/components/schemas/NotificationEndpointType' + updatedAt: + format: date-time + readOnly: true + type: string + userID: + type: string + required: + - type + - name + type: object + NotificationEndpointDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationEndpoint' + pagerduty: '#/components/schemas/PagerDutyNotificationEndpoint' + slack: '#/components/schemas/SlackNotificationEndpoint' + telegram: '#/components/schemas/TelegramNotificationEndpoint' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationEndpoint' + - $ref: '#/components/schemas/PagerDutyNotificationEndpoint' + - $ref: '#/components/schemas/HTTPNotificationEndpoint' + - $ref: '#/components/schemas/TelegramNotificationEndpoint' + NotificationEndpointType: + enum: + - slack + - pagerduty + - http + - telegram + type: string + NotificationEndpointUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationEndpoints: + properties: + links: + $ref: '#/components/schemas/Links' + notificationEndpoints: + items: + $ref: '#/components/schemas/NotificationEndpoint' + type: array + NotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + NotificationRuleBase: + properties: + createdAt: + format: date-time + readOnly: true + type: string + description: + description: An optional description of the notification rule. + type: string + endpointID: + type: string + every: + description: The notification repetition interval. + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + limit: + description: Don't notify me more than times every seconds. If set, limitEvery cannot be empty. + type: integer + limitEvery: + description: Don't notify me more than times every seconds. If set, limit cannot be empty. + type: integer + links: + example: + labels: /api/v2/notificationRules/1/labels + members: /api/v2/notificationRules/1/members + owners: /api/v2/notificationRules/1/owners + query: /api/v2/notificationRules/1/query + self: /api/v2/notificationRules/1 + properties: + labels: + $ref: '#/components/schemas/Link' + description: The URL to retrieve labels for this notification rule. + members: + $ref: '#/components/schemas/Link' + description: The URL to retrieve members for this notification rule. + owners: + $ref: '#/components/schemas/Link' + description: The URL to retrieve owners for this notification rule. + query: + $ref: '#/components/schemas/Link' + description: The URL to retrieve the Flux script for this notification rule. + self: + $ref: '#/components/schemas/Link' + description: The URL for this endpoint. + readOnly: true + type: object + name: + description: Human-readable name describing the notification rule. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + orgID: + description: The ID of the organization that owns this notification rule. + type: string + ownerID: + description: The ID of creator used to create this notification rule. + readOnly: true + type: string + runbookLink: + type: string + sleepUntil: + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + statusRules: + description: List of status rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/StatusRule' + minItems: 1 + type: array + tagRules: + description: List of tag rules the notification rule attempts to match. + items: + $ref: '#/components/schemas/TagRule' + type: array + taskID: + description: The ID of the task associated with this notification rule. + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - orgID + - status + - name + - statusRules + - endpointID + type: object + NotificationRuleDiscriminator: + discriminator: + mapping: + http: '#/components/schemas/HTTPNotificationRule' + pagerduty: '#/components/schemas/PagerDutyNotificationRule' + slack: '#/components/schemas/SlackNotificationRule' + smtp: '#/components/schemas/SMTPNotificationRule' + telegram: '#/components/schemas/TelegramNotificationRule' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SlackNotificationRule' + - $ref: '#/components/schemas/SMTPNotificationRule' + - $ref: '#/components/schemas/PagerDutyNotificationRule' + - $ref: '#/components/schemas/HTTPNotificationRule' + - $ref: '#/components/schemas/TelegramNotificationRule' + NotificationRuleUpdate: + properties: + description: + type: string + name: + type: string + status: + enum: + - active + - inactive + type: string + type: object + NotificationRules: + properties: + links: + $ref: '#/components/schemas/Links' + notificationRules: + items: + $ref: '#/components/schemas/NotificationRule' + type: array + ObjectExpression: + description: Allows the declaration of an anonymous object within a declaration + properties: + properties: + description: Object properties + items: + $ref: '#/components/schemas/Property' + type: array + type: + $ref: '#/components/schemas/NodeType' + type: object + OnboardingRequest: + properties: + bucket: + type: string + org: + type: string + password: + type: string + retentionPeriodHrs: + deprecated: true + description: | + Retention period *in nanoseconds* for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use `retentionPeriodSeconds` + type: integer + retentionPeriodSeconds: + format: int64 + type: integer + token: + description: | + Authentication token to set on the initial user. If not specified, the server will generate a token. + type: string + username: + type: string + required: + - username + - org + - bucket + type: object + OnboardingResponse: + properties: + auth: + $ref: '#/components/schemas/Authorization' + bucket: + $ref: '#/components/schemas/Bucket' + org: + $ref: '#/components/schemas/Organization' + user: + $ref: '#/components/schemas/UserResponse' + type: object + OptionStatement: + description: A single variable declaration + properties: + assignment: + oneOf: + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Organization: + properties: + createdAt: + format: date-time + readOnly: true + type: string + defaultStorageType: + description: Discloses whether the organization uses TSM or IOx. + enum: + - tsm + - iox + type: string + description: + type: string + id: + readOnly: true + type: string + links: + example: + buckets: /api/v2/buckets?org=myorg + dashboards: /api/v2/dashboards?org=myorg + labels: /api/v2/orgs/1/labels + members: /api/v2/orgs/1/members + owners: /api/v2/orgs/1/owners + secrets: /api/v2/orgs/1/secrets + self: /api/v2/orgs/1 + tasks: /api/v2/tasks?org=myorg + properties: + buckets: + $ref: '#/components/schemas/Link' + dashboards: + $ref: '#/components/schemas/Link' + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + secrets: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + tasks: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + type: string + status: + default: active + description: If inactive, the organization is inactive. + enum: + - active + - inactive + type: string + updatedAt: + format: date-time + readOnly: true + type: string + required: + - name + Organizations: + properties: + links: + $ref: '#/components/schemas/Links' + orgs: + items: + $ref: '#/components/schemas/Organization' + type: array + type: object + Package: + description: Represents a complete package source tree. + properties: + files: + description: Package files + items: + $ref: '#/components/schemas/File' + type: array + package: + description: Package name + type: string + path: + description: Package import path + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + PackageClause: + description: Defines a package identifier + properties: + name: + $ref: '#/components/schemas/Identifier' + type: + $ref: '#/components/schemas/NodeType' + type: object + PagerDutyNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + clientURL: + type: string + routingKey: + type: string + required: + - routingKey + type: object + type: object + PagerDutyNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/PagerDutyNotificationRuleBase' + PagerDutyNotificationRuleBase: + properties: + messageTemplate: + type: string + type: + enum: + - pagerduty + type: string + required: + - type + - messageTemplate + type: object + ParenExpression: + description: Represents an expression wrapped in parenthesis + properties: + expression: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PasswordResetBody: + properties: + password: + type: string + required: + - password + PatchBucketRequest: + description: | + An object that contains updated bucket properties to apply. + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The name of the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/PatchRetentionRules' + type: object + PatchOrganizationRequest: + description: | + An object that contains updated organization properties to apply. + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + type: object + PatchRetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The number of seconds to keep data. + Default duration is `2592000` (30 days). + `0` represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The [shard group duration](/influxdb/latest/reference/glossary/#shard). + The number of seconds that each shard group covers. - For more information about **pprof profile** and **trace** reports, - see the following resources: + #### InfluxDB Cloud - - [Google pprof tool](https://github.com/google/pprof) - - [Golang diagnostics](https://go.dev/doc/diagnostics) - name: Debug - - description: | - Delete data from an InfluxDB bucket. - name: Delete - - description: | - InfluxDB HTTP API endpoints use standard HTTP request and response headers. - The following table shows common headers used by many InfluxDB API endpoints. - Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the `POST /api/v2/write` endpoint accepts the `Content-Encoding` header to indicate the compression applied to line protocol in the request body. + - Doesn't use `shardGroupDurationsSeconds`. - | Header | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `Accept` | string | The content type that the client can understand. | - | `Authorization` | string | The authorization scheme and credential. | - | `Content-Length` | integer | The size of the entity-body, in bytes, sent to the database. | - | `Content-Type` | string | The format of the data in the request body. | - name: Headers - x-traitTag: true - - name: Health - - name: Labels - - name: Legacy Authorizations - - name: Legacy Query - - name: Legacy Write - - name: Metrics - - name: NotificationEndpoints - - name: NotificationRules - - description: | - Create and manage your [organizations](/influxdb/latest/reference/glossary/#organization). - An organization is a workspace for a group of users. Organizations can be - used to separate different environments, projects, teams or users within - InfluxDB. + #### InfluxDB OSS - Use the `/api/v2/orgs` endpoints to create, view, and manage organizations. - name: Organizations - - description: | - Some InfluxDB API [list operations](#tag/SupportedOperations) may support the following query parameters for paginating results: + - Default value depends on the [bucket retention period](/influxdb/latest/reference/internals/shards/#shard-group-duration). - | Query parameter | Value type | Description | - |:------------------------ |:--------------------- |:-------------------------------------------| - | `limit` | integer | The maximum number of records to return (after other parameters are applied). | - | `offset` | integer | The number of records to skip (before `limit`, after other parameters are applied). | - | `after` | string (resource ID) | Only returns resources created after the specified resource. | + #### Related guides - ### Limitations + - InfluxDB [shards and shard groups](/influxdb/latest/reference/internals/shards/) + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + PatchRetentionRules: + description: Updates to rules to expire or retain data. No rules means no updates. + items: + $ref: '#/components/schemas/PatchRetentionRule' + type: array + Permission: + properties: + action: + enum: + - read + - write + type: string + resource: + $ref: '#/components/schemas/Resource' + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + required: + - action + - resource + PipeExpression: + description: Call expression with pipe argument + properties: + argument: + $ref: '#/components/schemas/Expression' + call: + $ref: '#/components/schemas/CallExpression' + type: + $ref: '#/components/schemas/NodeType' + type: object + PipeLiteral: + description: Represents a specialized literal value, indicating the left hand value of a pipe expression + properties: + type: + $ref: '#/components/schemas/NodeType' + type: object + PostBucketRequest: + properties: + description: + description: | + A description of the bucket. + type: string + name: + description: | + The bucket name. + type: string + orgID: + description: | + The organization ID. + Specifies the organization that owns the bucket. + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + rp: + default: '0' + description: | + The retention policy for the bucket. + For InfluxDB 1.x, specifies the duration of time that each data point + in the retention policy persists. - - For specific endpoint parameters and examples, see the endpoint definition. - - If you specify an `offset` parameter value greater than the total number of records, - then InfluxDB returns an empty list in the response - (given `offset` skips the specified number of records). + If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property; + otherwise, see the `retentionRules` property. - The following example passes `offset=50` to skip the first 50 results, - but the user only has 10 buckets: + [Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) + is an InfluxDB 1.x concept. + The InfluxDB 2.x and Cloud equivalent is + [retention period](/influxdb/latest/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. + type: string + schemaType: + $ref: '#/components/schemas/SchemaType' + default: implicit + description: | + The schema Type. Default is `implicit`. + + #### InfluxDB Cloud v2 + + - Use `explicit` to enforce column names, tags, fields, and data types for + your data. + + #### InfluxDB OSS + + - Doesn't support `explicit` bucket schemas. + required: + - orgID + - name + PostCheck: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + PostNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + PostNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleDiscriminator' + PostOrganizationRequest: + properties: + description: + description: | + The description of the organization. + type: string + name: + description: | + The name of the organization. + type: string + required: + - name + type: object + Property: + description: The value associated with a key + properties: + key: + $ref: '#/components/schemas/PropertyKey' + type: + $ref: '#/components/schemas/NodeType' + value: + $ref: '#/components/schemas/Expression' + type: object + PropertyKey: + oneOf: + - $ref: '#/components/schemas/Identifier' + - $ref: '#/components/schemas/StringLiteral' + Query: + description: Query InfluxDB with the Flux language + properties: + dialect: + $ref: '#/components/schemas/Dialect' + extern: + $ref: '#/components/schemas/File' + now: + description: | + Specifies the time that should be reported as `now` in the query. + Default is the server `now` time. + format: date-time + type: string + query: + description: The query script to execute. + type: string + type: + description: The type of query. Must be "flux". + enum: + - flux + type: string + required: + - query + type: object + QueryEditMode: + enum: + - builder + - advanced + type: string + QueryVariableProperties: + properties: + type: + enum: + - query + type: string + values: + properties: + language: + type: string + query: + type: string + type: object + RangeThreshold: + allOf: + - $ref: '#/components/schemas/ThresholdBase' + - properties: + max: + format: float + type: number + min: + format: float + type: number + type: + enum: + - range + type: string + within: + type: boolean + required: + - type + - min + - max + - within + type: object + Ready: + properties: + started: + example: '2019-03-13T10:09:33.891196-04:00' + format: date-time + type: string + status: + enum: + - ready + type: string + up: + example: 14m45.911966424s + type: string + type: object + RegexpLiteral: + description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2 + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + RemoteConnection: + properties: + allowInsecureTLS: + default: false + type: boolean + description: + type: string + id: + type: string + name: + type: string + orgID: + type: string + remoteOrgID: + type: string + remoteURL: + format: uri + type: string + required: + - id + - name + - orgID + - remoteURL + - allowInsecureTLS + type: object + RemoteConnectionCreationRequest: + properties: + allowInsecureTLS: + default: false + type: boolean + description: + type: string + name: + type: string + orgID: + type: string + remoteAPIToken: + type: string + remoteOrgID: + type: string + remoteURL: + format: uri + type: string + required: + - name + - orgID + - remoteURL + - remoteAPIToken + - allowInsecureTLS + type: object + RemoteConnectionUpdateRequest: + properties: + allowInsecureTLS: + default: false + type: boolean + description: + type: string + name: + type: string + remoteAPIToken: + type: string + remoteOrgID: + type: string + remoteURL: + format: uri + type: string + type: object + RemoteConnections: + properties: + remotes: + items: + $ref: '#/components/schemas/RemoteConnection' + type: array + type: object + RenamableField: + description: Describes a field that can be renamed and made visible or invisible. + properties: + displayName: + description: The name that a field is renamed to by the user. + type: string + internalName: + description: The calculated name of a field. + readOnly: true + type: string + visible: + description: Indicates whether this field should be visible on the table. + type: boolean + type: object + Replication: + properties: + currentQueueSizeBytes: + format: int64 + type: integer + description: + type: string + dropNonRetryableData: + type: boolean + id: + type: string + latestErrorMessage: + type: string + latestResponseCode: + type: integer + localBucketID: + type: string + maxQueueSizeBytes: + format: int64 + type: integer + name: + type: string + orgID: + type: string + remainingBytesToBeSynced: + format: int64 + type: integer + remoteBucketID: + type: string + remoteBucketName: + type: string + remoteID: + type: string + required: + - id + - name + - remoteID + - orgID + - localBucketID + - maxQueueSizeBytes + type: object + ReplicationCreationRequest: + properties: + description: + type: string + dropNonRetryableData: + default: false + type: boolean + localBucketID: + type: string + maxAgeSeconds: + default: 604800 + format: int64 + minimum: 0 + type: integer + maxQueueSizeBytes: + default: 67108860 + format: int64 + minimum: 33554430 + type: integer + name: + type: string + orgID: + type: string + remoteBucketID: + type: string + remoteBucketName: + type: string + remoteID: + type: string + required: + - name + - orgID + - remoteID + - localBucketID + - maxQueueSizeBytes + - maxAgeSeconds + type: object + ReplicationUpdateRequest: + properties: + description: + type: string + dropNonRetryableData: + type: boolean + maxAgeSeconds: + format: int64 + minimum: 0 + type: integer + maxQueueSizeBytes: + format: int64 + minimum: 33554430 + type: integer + name: + type: string + remoteBucketID: + type: string + remoteBucketName: + type: string + remoteID: + type: string + type: object + Replications: + properties: + replications: + items: + $ref: '#/components/schemas/Replication' + type: array + type: object + Resource: + properties: + id: + description: | + A resource ID. + Identifies a specific resource. + type: string + name: + description: | + The name of the resource. + _Note: not all resource types have a `name` property_. + type: string + org: + description: | + An organization name. + The organization that owns the resource. + type: string + orgID: + description: | + An organization ID. + Identifies the organization that owns the resource. + type: string + type: + description: | + A resource type. + Identifies the API resource's type (or _kind_). + enum: + - authorizations + - buckets + - dashboards + - orgs + - tasks + - telegrafs + - users + - variables + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + - dbrp + - annotations + - sources + - scrapers + - notebooks + - remotes + - replications + - instance + - flows + - functions + - subscriptions + type: string + required: + - type + type: object + ResourceMember: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: member + enum: + - member + type: string + type: object + ResourceMembers: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceMember' + type: array + type: object + ResourceOwner: + allOf: + - $ref: '#/components/schemas/UserResponse' + - properties: + role: + default: owner + enum: + - owner + type: string + type: object + ResourceOwners: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/ResourceOwner' + type: array + type: object + RestoredBucketMappings: + properties: + id: + description: New ID of the restored bucket + type: string + name: + type: string + shardMappings: + $ref: '#/components/schemas/BucketShardMappings' + required: + - id + - name + - shardMappings + type: object + RetentionPolicyManifest: + properties: + duration: + format: int64 + type: integer + name: + type: string + replicaN: + type: integer + shardGroupDuration: + format: int64 + type: integer + shardGroups: + $ref: '#/components/schemas/ShardGroupManifests' + subscriptions: + $ref: '#/components/schemas/SubscriptionManifests' + required: + - name + - replicaN + - duration + - shardGroupDuration + - shardGroups + - subscriptions + type: object + RetentionPolicyManifests: + items: + $ref: '#/components/schemas/RetentionPolicyManifest' + type: array + RetentionRule: + properties: + everySeconds: + default: 2592000 + description: | + The duration in seconds for how long data will be kept in the database. + The default duration is 2592000 (30 days). + 0 represents infinite retention. + example: 86400 + format: int64 + minimum: 0 + type: integer + shardGroupDurationSeconds: + description: | + The shard group duration. + The duration or interval (in seconds) that each shard group covers. + + #### InfluxDB Cloud + + - Does not use `shardGroupDurationsSeconds`. + + #### InfluxDB OSS + + - Default value depends on the + [bucket retention period](/influxdb/latest/reference/internals/shards/#shard-group-duration). + format: int64 + type: integer + type: + default: expire + enum: + - expire + type: string + required: + - everySeconds + type: object + RetentionRules: + description: | + Retention rules to expire or retain data. + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/latest/reference/glossary/#retention-period). + + #### InfluxDB Cloud + + - `retentionRules` is required. + + #### InfluxDB OSS + + - `retentionRules` isn't required. + items: + $ref: '#/components/schemas/RetentionRule' + type: array + ReturnStatement: + description: Defines an expression to return + properties: + argument: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + Routes: + properties: + authorizations: + format: uri + type: string + buckets: + format: uri + type: string + dashboards: + format: uri + type: string + external: + properties: + statusFeed: + format: uri + type: string + type: object + flags: + format: uri + type: string + me: + format: uri + type: string + orgs: + format: uri + type: string + query: + properties: + analyze: + format: uri + type: string + ast: + format: uri + type: string + self: + format: uri + type: string + suggestions: + format: uri + type: string + type: object + setup: + format: uri + type: string + signin: + format: uri + type: string + signout: + format: uri + type: string + sources: + format: uri + type: string + system: + properties: + debug: + format: uri + type: string + health: + format: uri + type: string + metrics: + format: uri + type: string + type: object + tasks: + format: uri + type: string + telegrafs: + format: uri + type: string + users: + format: uri + type: string + variables: + format: uri + type: string + write: + format: uri + type: string + RuleStatusLevel: + description: The state to record if check matches a criteria. + enum: + - UNKNOWN + - OK + - INFO + - CRIT + - WARN + - ANY + type: string + Run: + properties: + finishedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + flux: + description: Flux used for the task + readOnly: true + type: string + id: + readOnly: true + type: string + links: + example: + retry: /api/v2/tasks/1/runs/1/retry + self: /api/v2/tasks/1/runs/1 + task: /api/v2/tasks/1 + properties: + retry: + format: uri + type: string + self: + format: uri + type: string + task: + format: uri + type: string + readOnly: true + type: object + log: + description: An array of logs associated with the run. + items: + $ref: '#/components/schemas/LogEvent' + readOnly: true + type: array + requestedAt: + description: The time ([RFC3339Nano date/time format](/influxdb/latest/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + scheduledFor: + description: The time [RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. + format: date-time + type: string + startedAt: + description: The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing. + example: 2006-01-02T15:04:05.999999999Z07:00 + format: date-time + readOnly: true + type: string + status: + enum: + - scheduled + - started + - failed + - success + - canceled + readOnly: true + type: string + taskID: + readOnly: true + type: string + RunManually: + properties: + scheduledFor: + description: | + The time [RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp) + used for the run's `now` option. + Default is the server _now_ time. + format: date-time + nullable: true + type: string + Runs: + properties: + links: + $ref: '#/components/schemas/Links' + runs: + items: + $ref: '#/components/schemas/Run' + type: array + type: object + SMTPNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SMTPNotificationRuleBase' + SMTPNotificationRuleBase: + properties: + bodyTemplate: + type: string + subjectTemplate: + type: string + to: + type: string + type: + enum: + - smtp + type: string + required: + - type + - subjectTemplate + - to + type: object + ScatterViewProperties: + properties: + adaptiveZoomHide: + type: boolean + colors: + description: Colors define color encoding of data into a visualization + items: + type: string + type: array + fillColumns: + items: + type: string + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + symbolColumns: + items: + type: string + type: array + timeFormat: + type: string + type: + enum: + - scatter + type: string + xAxisLabel: + type: string + xColumn: + type: string + xDomain: + items: + type: number + maxItems: 2 + type: array + xPrefix: + type: string + xSuffix: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yAxisLabel: + type: string + yColumn: + type: string + yDomain: + items: + type: number + maxItems: 2 + type: array + yPrefix: + type: string + ySuffix: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - xColumn + - yColumn + - fillColumns + - symbolColumns + - xDomain + - yDomain + - xAxisLabel + - yAxisLabel + - xPrefix + - yPrefix + - xSuffix + - ySuffix + type: object + SchemaType: + enum: + - implicit + - explicit + type: string + ScraperTargetRequest: + properties: + allowInsecure: + default: false + description: Skip TLS verification on endpoint. + type: boolean + bucketID: + description: The ID of the bucket to write to. + type: string + name: + description: The name of the scraper target. + type: string + orgID: + description: The organization ID. + type: string + type: + description: The type of the metrics to be parsed. + enum: + - prometheus + type: string + url: + description: The URL of the metrics endpoint. + example: http://localhost:9090/metrics + type: string + type: object + ScraperTargetResponse: + allOf: + - $ref: '#/components/schemas/ScraperTargetRequest' + - properties: + bucket: + description: The bucket name. + type: string + id: + readOnly: true + type: string + links: + example: + bucket: /api/v2/buckets/1 + members: /api/v2/scrapers/1/members + organization: /api/v2/orgs/1 + owners: /api/v2/scrapers/1/owners + self: /api/v2/scrapers/1 + properties: + bucket: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + organization: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + org: + description: The name of the organization. + type: string + type: object + type: object + ScraperTargetResponses: + properties: + configurations: + items: + $ref: '#/components/schemas/ScraperTargetResponse' + type: array + type: object + SecretKeys: + properties: + secrets: + items: + type: string + type: array + type: object + SecretKeysResponse: + allOf: + - $ref: '#/components/schemas/SecretKeys' + - properties: + links: + properties: + org: + type: string + self: + type: string + readOnly: true + type: object + type: object + Secrets: + additionalProperties: + type: string + example: + apikey: abc123xyz + ShardGroupManifest: + properties: + deletedAt: + format: date-time + type: string + endTime: + format: date-time + type: string + id: + format: int64 + type: integer + shards: + $ref: '#/components/schemas/ShardManifests' + startTime: + format: date-time + type: string + truncatedAt: + format: date-time + type: string + required: + - id + - startTime + - endTime + - shards + type: object + ShardGroupManifests: + items: + $ref: '#/components/schemas/ShardGroupManifest' + type: array + ShardManifest: + properties: + id: + format: int64 + type: integer + shardOwners: + $ref: '#/components/schemas/ShardOwners' + required: + - id + - shardOwners + type: object + ShardManifests: + items: + $ref: '#/components/schemas/ShardManifest' + type: array + ShardOwner: + properties: + nodeID: + description: The ID of the node that owns the shard. + format: int64 + type: integer + required: + - nodeID + type: object + ShardOwners: + items: + $ref: '#/components/schemas/ShardOwner' + type: array + SimpleTableViewProperties: + properties: + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showAll: + type: boolean + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + type: + enum: + - simple-table + type: string + required: + - type + - showAll + - queries + - shape + - note + - showNoteWhenEmpty + type: object + SingleStatViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + note: + type: string + prefix: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + suffix: + type: string + tickPrefix: + type: string + tickSuffix: + type: string + type: + enum: + - single-stat + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - prefix + - tickPrefix + - suffix + - tickSuffix + - decimalPlaces + type: object + SlackNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + token: + description: Specifies the API token string. Specify either `URL` or `Token`. + type: string + url: + description: Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`. + type: string + type: object + type: object + SlackNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/SlackNotificationRuleBase' + SlackNotificationRuleBase: + properties: + channel: + type: string + messageTemplate: + type: string + type: + enum: + - slack + type: string + required: + - type + - messageTemplate + type: object + Source: + properties: + default: + type: boolean + defaultRP: + type: string + id: + type: string + insecureSkipVerify: + type: boolean + languages: + items: + enum: + - flux + - influxql + type: string + readOnly: true + type: array + links: + properties: + buckets: + type: string + health: + type: string + query: + type: string + self: + type: string + type: object + metaUrl: + format: uri + type: string + name: + type: string + orgID: + type: string + password: + type: string + sharedSecret: + type: string + telegraf: + type: string + token: + type: string + type: + enum: + - v1 + - v2 + - self + type: string + url: + format: uri + type: string + username: + type: string + type: object + Sources: + properties: + links: + properties: + self: + format: uri + type: string + type: object + sources: + items: + $ref: '#/components/schemas/Source' + type: array + type: object + Stack: + properties: + createdAt: + format: date-time + readOnly: true + type: string + events: + items: + properties: + description: + type: string + eventType: + type: string + name: + type: string + resources: + items: + properties: + apiVersion: + type: string + associations: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + metaName: + type: string + type: object + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + links: + properties: + self: + type: string + type: object + resourceID: + type: string + templateMetaName: + type: string + type: object + type: array + sources: + items: + type: string + type: array + updatedAt: + format: date-time + readOnly: true + type: string + urls: + items: + type: string + type: array + type: object + type: array + id: + type: string + orgID: + type: string + type: object + Statement: + oneOf: + - $ref: '#/components/schemas/BadStatement' + - $ref: '#/components/schemas/VariableAssignment' + - $ref: '#/components/schemas/MemberAssignment' + - $ref: '#/components/schemas/ExpressionStatement' + - $ref: '#/components/schemas/ReturnStatement' + - $ref: '#/components/schemas/OptionStatement' + - $ref: '#/components/schemas/BuiltinStatement' + - $ref: '#/components/schemas/TestStatement' + StaticLegend: + description: StaticLegend represents the options specific to the static legend + properties: + colorizeRows: + type: boolean + heightRatio: + format: float + type: number + opacity: + format: float + type: number + orientationThreshold: + type: integer + show: + type: boolean + valueAxis: + type: string + widthRatio: + format: float + type: number + type: object + StatusRule: + properties: + count: + type: integer + currentLevel: + $ref: '#/components/schemas/RuleStatusLevel' + period: + type: string + previousLevel: + $ref: '#/components/schemas/RuleStatusLevel' + type: object + StringLiteral: + description: Expressions begin and end with double quote marks + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + SubscriptionManifest: + properties: + destinations: + items: + type: string + type: array + mode: + type: string + name: + type: string + required: + - name + - mode + - destinations + type: object + SubscriptionManifests: + items: + $ref: '#/components/schemas/SubscriptionManifest' + type: array + TableViewProperties: + properties: + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + decimalPlaces: + $ref: '#/components/schemas/DecimalPlaces' + fieldOptions: + description: fieldOptions represent the fields retrieved by the query with customization options + items: + $ref: '#/components/schemas/RenamableField' + type: array + note: + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + tableOptions: + properties: + fixFirstColumn: + description: fixFirstColumn indicates whether the first column of the table should be locked + type: boolean + sortBy: + $ref: '#/components/schemas/RenamableField' + verticalTimeAxis: + description: verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically + type: boolean + wrapping: + description: Wrapping describes the text wrapping style to be used in table views + enum: + - truncate + - wrap + - single-line + type: string + type: object + timeFormat: + description: timeFormat describes the display format for time values according to moment.js date formatting + type: string + type: + enum: + - table + type: string + required: + - type + - queries + - colors + - shape + - note + - showNoteWhenEmpty + - tableOptions + - fieldOptions + - timeFormat + - decimalPlaces + type: object + TagRule: + properties: + key: + type: string + operator: + enum: + - equal + - notequal + - equalregex + - notequalregex + type: string + value: + type: string + type: object + Task: + properties: + authorizationID: + description: | + An authorization ID. + Specifies the authorization used when the task communicates with the query engine. + + To find an authorization ID, use the + [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to + list authorizations. + type: string + createdAt: + format: date-time + readOnly: true + type: string + cron: + description: A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions. + type: string + description: + description: A description of the task. + type: string + every: + description: The interval ([duration literal](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time. + format: duration + type: string + flux: + description: The Flux script that the task executes. + format: flux + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + lastRunError: + readOnly: true + type: string + lastRunStatus: + enum: + - failed + - success + - canceled + readOnly: true + type: string + latestCompleted: + description: A timestamp ([RFC3339 date/time format](/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. + format: date-time + readOnly: true + type: string + links: + example: + labels: /api/v2/tasks/1/labels + logs: /api/v2/tasks/1/logs + members: /api/v2/tasks/1/members + owners: /api/v2/tasks/1/owners + runs: /api/v2/tasks/1/runs + self: /api/v2/tasks/1 + properties: + labels: + $ref: '#/components/schemas/Link' + logs: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + runs: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + name: + description: The name of the task. + type: string + offset: + description: A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. + format: duration + type: string + org: + description: | + An [organization](/influxdb/latest/reference/glossary/#organization) name. + Specifies the organization that owns the task. + type: string + orgID: + description: | + An [organization](/influxdb/latest/reference/glossary/#organization) ID. + Specifies the organization that owns the task. + type: string + ownerID: + description: | + A [user](/influxdb/latest/reference/glossary/#user) ID. + Specifies the owner of the task. + + To find a user ID, you can use the + [`GET /api/v2/users` endpoint](#operation/GetUsers) to + list users. + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + updatedAt: + format: date-time + readOnly: true + type: string + required: + - id + - name + - orgID + - flux + type: object + TaskCreateRequest: + properties: + description: + description: An optional description of the task. + type: string + flux: + description: The Flux script to run for this task. + type: string + org: + description: The name of the organization that owns this Task. + type: string + orgID: + description: The ID of the organization that owns this Task. + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + required: + - flux + type: object + TaskStatusType: + description: | + `inactive` cancels scheduled runs and prevents manual runs of the task. + enum: + - active + - inactive + type: string + TaskUpdateRequest: + properties: + cron: + description: Update the 'cron' option in the flux script. + type: string + description: + description: Update the description of the task. + type: string + every: + description: Update the 'every' option in the flux script. + type: string + flux: + description: The Flux script that the task runs. + type: string + name: + description: Update the 'name' option in the flux script. + type: string + offset: + description: Update the 'offset' option in the flux script. + type: string + status: + $ref: '#/components/schemas/TaskStatusType' + type: object + Tasks: + properties: + links: + $ref: '#/components/schemas/Links' + readOnly: true + tasks: + items: + $ref: '#/components/schemas/Task' + type: array + type: object + Telegraf: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + readOnly: true + links: + example: + labels: /api/v2/telegrafs/1/labels + members: /api/v2/telegrafs/1/members + owners: /api/v2/telegrafs/1/owners + self: /api/v2/telegrafs/1 + properties: + labels: + $ref: '#/components/schemas/Link' + members: + $ref: '#/components/schemas/Link' + owners: + $ref: '#/components/schemas/Link' + self: + $ref: '#/components/schemas/Link' + readOnly: true + type: object + type: object + type: object + TelegrafPlugin: + properties: + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + TelegrafPluginRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + plugins: + items: + properties: + alias: + type: string + config: + type: string + description: + type: string + name: + type: string + type: + type: string + type: object + type: array + type: object + TelegrafPlugins: + properties: + os: + type: string + plugins: + items: + $ref: '#/components/schemas/TelegrafPlugin' + type: array + version: + type: string + type: object + TelegrafRequest: + properties: + config: + type: string + description: + type: string + metadata: + properties: + buckets: + items: + type: string + type: array + type: object + name: + type: string + orgID: + type: string + type: object + Telegrafs: + properties: + configurations: + items: + $ref: '#/components/schemas/Telegraf' + type: array + type: object + TelegramNotificationEndpoint: + allOf: + - $ref: '#/components/schemas/NotificationEndpointBase' + - properties: + channel: + description: The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage . + type: string + token: + description: Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot . + type: string + required: + - token + - channel + type: object + type: object + TelegramNotificationRule: + allOf: + - $ref: '#/components/schemas/NotificationRuleBase' + - $ref: '#/components/schemas/TelegramNotificationRuleBase' + TelegramNotificationRuleBase: + properties: + disableWebPagePreview: + description: Disables preview of web links in the sent messages when "true". Defaults to "false". + type: boolean + messageTemplate: + description: The message template as a flux interpolated string. + type: string + parseMode: + description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". + enum: + - MarkdownV2 + - HTML + - Markdown + type: string + type: + description: The discriminator between other types of notification rules is "telegram". + enum: + - telegram + type: string + required: + - type + - messageTemplate + - channel + type: object + Template: + items: + description: | + A template entry. + Defines an InfluxDB resource in a template. + properties: + apiVersion: + example: influxdata.com/v2alpha1 + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + metadata: + description: | + Metadata properties used for the resource when the template is applied. + properties: + name: + type: string + type: object + spec: + description: | + Configuration properties used for the resource when the template is applied. + Key-value pairs map to the specification for the resource. + + The following code samples show `spec` configurations for template resources: + + - A bucket: + + ```json + { "spec": { + "name": "iot_center", + "retentionRules": [{ + "everySeconds": 2.592e+06, + "type": "expire" + }] + } + } + ``` + + - A variable: + + ```json + { "spec": { + "language": "flux", + "name": "Node_Service", + "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\", + tag: \"service\")", + "type": "query" + } + } + ``` + type: object + type: object + type: array + TemplateApply: + properties: + actions: + description: | + A list of `action` objects. + Actions let you customize how InfluxDB applies templates in the request. + + You can use the following actions to prevent creating or updating resources: + + - A `skipKind` action skips template resources of a specified `kind`. + - A `skipResource` action skips template resources with a specified `metadata.name` + and `kind`. + items: + oneOf: + - properties: + action: + enum: + - skipKind + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + required: + - kind + type: object + type: object + - properties: + action: + enum: + - skipResource + type: string + properties: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + resourceTemplateName: + type: string + required: + - kind + - resourceTemplateName + type: object + type: object + type: array + dryRun: + description: | + Only applies a dry run of the templates passed in the request. + + - Validates the template and generates a resource diff and summary. + - Doesn't install templates or make changes to the InfluxDB instance. + type: boolean + envRefs: + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + description: | + An object with key-value pairs that map to **environment references** in templates. + + Environment references in templates are `envRef` objects with an `envRef.key` + property. + To substitute a custom environment reference value when applying templates, + pass `envRefs` with the `envRef.key` and the value. + + When you apply a template, InfluxDB replaces `envRef` objects in the template + with the values that you provide in the `envRefs` parameter. + For more examples, see how to [define environment references](/influxdb/latest/influxdb-templates/use/#define-environment-references). + + The following template fields may use environment references: + + - `metadata.name` + - `spec.endpointName` + - `spec.associations.name` + + For more information about including environment references in template fields, see how to + [include user-definable resource names](/influxdb/latest/influxdb-templates/create/#include-user-definable-resource-names). + type: object + orgID: + description: | + Organization ID. + InfluxDB applies templates to this organization. + The organization owns all resources created by the template. + + To find your organization, see how to + [view organizations](/influxdb/latest/organizations/view-orgs/). + type: string + remotes: + description: | + A list of URLs for template files. + + To apply a template manifest file located at a URL, pass `remotes` + with an array that contains the URL. + items: + properties: + contentType: + type: string + url: + type: string + required: + - url + type: object + type: array + secrets: + additionalProperties: + type: string + description: | + An object with key-value pairs that map to **secrets** in queries. + + Queries may reference secrets stored in InfluxDB--for example, + the following Flux script retrieves `POSTGRES_USERNAME` and `POSTGRES_PASSWORD` + secrets and then uses them to connect to a PostgreSQL database: + + ```js + import "sql" + import "influxdata/influxdb/secrets" + + username = secrets.get(key: "POSTGRES_USERNAME") + password = secrets.get(key: "POSTGRES_PASSWORD") + + sql.from( + driverName: "postgres", + dataSourceName: "postgresql://${username}:${password}@localhost:5432", + query: "SELECT * FROM example_table", + ) + ``` + + To define secret values in your `/api/v2/templates/apply` request, + pass the `secrets` parameter with key-value pairs--for example: + + ```json + { + ... + "secrets": { + "POSTGRES_USERNAME": "pguser", + "POSTGRES_PASSWORD": "foo" + } + ... + } + ``` + + InfluxDB stores the key-value pairs as secrets that you can access with `secrets.get()`. + Once stored, you can't view secret values in InfluxDB. + + #### Related guides + + - [How to pass secrets when installing a template](/influxdb/latest/influxdb-templates/use/#pass-secrets-when-installing-a-template) + type: object + stackID: + description: | + ID of the stack to update. + + To apply templates to an existing stack in the organization, use the `stackID` parameter. + If you apply templates without providing a stack ID, + InfluxDB initializes a new stack with all new resources. + + To find a stack ID, use the InfluxDB [`/api/v2/stacks` API endpoint](#operation/ListStacks) to list stacks. + + #### Related guides + + - [Stacks](/influxdb/latest/influxdb-templates/stacks/) + - [View stacks](/influxdb/latest/influxdb-templates/stacks/view/) + type: string + template: + description: | + A template object to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Pass `template` to apply only one template object. + If you use `template`, you can't use the `templates` parameter. + If you want to apply multiple template objects, use `templates` instead. + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + templates: + description: | + A list of template objects to apply. + A template object has a `contents` property + with an array of InfluxDB resource configurations. + + Use the `templates` parameter to apply multiple template objects. + If you use `templates`, you can't use the `template` parameter. + items: + properties: + contentType: + type: string + contents: + $ref: '#/components/schemas/Template' + sources: + items: + type: string + type: array + type: object + type: array + type: object + TemplateChart: + properties: + height: + type: integer + properties: + $ref: '#/components/schemas/ViewProperties' + width: + type: integer + xPos: + type: integer + yPos: + type: integer + type: object + TemplateEnvReferences: + items: + properties: + defaultValue: + description: Default value that will be provided for the reference when no value is provided + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + envRefKey: + description: Key identified as environment reference and is the key identified in the template + type: string + resourceField: + description: Field the environment reference corresponds too + type: string + value: + description: Value provided to fulfill reference + nullable: true + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + required: + - resourceField + - envRefKey + type: object + type: array + TemplateExportByID: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + description: if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported + type: string + required: + - id + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateExportByName: + properties: + orgIDs: + items: + properties: + orgID: + type: string + resourceFilters: + properties: + byLabel: + items: + type: string + type: array + byResourceKind: + items: + $ref: '#/components/schemas/TemplateKind' + type: array + type: object + type: object + type: array + resources: + items: + properties: + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + required: + - name + - kind + type: object + type: array + stackID: + type: string + type: object + TemplateKind: + enum: + - Bucket + - Check + - CheckDeadman + - CheckThreshold + - Dashboard + - Label + - NotificationEndpoint + - NotificationEndpointHTTP + - NotificationEndpointPagerDuty + - NotificationEndpointSlack + - NotificationRule + - Task + - Telegraf + - Variable + type: string + TemplateSummary: + properties: + diff: + properties: + buckets: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + old: + properties: + description: + type: string + name: + type: string + retentionRules: + $ref: '#/components/schemas/RetentionRules' + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + checks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/CheckDiscriminator' + old: + $ref: '#/components/schemas/CheckDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + old: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + old: + properties: + color: + type: string + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationEndpoints: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + old: + $ref: '#/components/schemas/NotificationEndpointDiscriminator' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + old: + properties: + description: + type: string + endpointID: + type: string + endpointName: + type: string + endpointType: + type: string + every: + type: string + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + old: + properties: + cron: + type: string + description: + type: string + every: + type: string + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + $ref: '#/components/schemas/TelegrafRequest' + old: + $ref: '#/components/schemas/TelegrafRequest' + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + new: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + old: + properties: + args: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + name: + type: string + type: object + stateStatus: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + errors: + items: + properties: + fields: + items: + type: string + type: array + indexes: + items: + type: integer + type: array + kind: + $ref: '#/components/schemas/TemplateKind' + reason: + type: string + type: object + type: array + sources: + items: + type: string + type: array + stackID: + type: string + summary: + properties: + buckets: + items: + properties: + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + retentionPeriod: + type: integer + templateMetaName: + type: string + type: object + type: array + checks: + items: + allOf: + - $ref: '#/components/schemas/CheckDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + dashboards: + items: + properties: + charts: + items: + $ref: '#/components/schemas/TemplateChart' + type: array + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + labelMappings: + items: + properties: + labelID: + type: string + labelName: + type: string + labelTemplateMetaName: + type: string + resourceID: + type: string + resourceName: + type: string + resourceTemplateMetaName: + type: string + resourceType: + type: string + status: + type: string + type: object + type: array + labels: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + missingEnvRefs: + items: + type: string + type: array + missingSecrets: + items: + type: string + type: array + notificationEndpoints: + items: + allOf: + - $ref: '#/components/schemas/NotificationEndpointDiscriminator' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + notificationRules: + items: + properties: + description: + type: string + endpointID: + type: string + endpointTemplateMetaName: + type: string + endpointType: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + messageTemplate: + type: string + name: + type: string + offset: + type: string + status: + type: string + statusRules: + items: + properties: + currentLevel: + type: string + previousLevel: + type: string + type: object + type: array + tagRules: + items: + properties: + key: + type: string + operator: + type: string + value: + type: string + type: object + type: array + templateMetaName: + type: string + type: object + type: array + tasks: + items: + properties: + cron: + type: string + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + every: + type: string + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + offset: + type: string + query: + type: string + status: + type: string + templateMetaName: + type: string + type: object + type: array + telegrafConfigs: + items: + allOf: + - $ref: '#/components/schemas/TelegrafRequest' + - properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + templateMetaName: + type: string + type: object + type: array + variables: + items: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + description: + type: string + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + labelAssociations: + items: + $ref: '#/components/schemas/TemplateSummaryLabel' + type: array + name: + type: string + orgID: + type: string + templateMetaName: + type: string + type: object + type: array + type: object + type: object + TemplateSummaryLabel: + properties: + envReferences: + $ref: '#/components/schemas/TemplateEnvReferences' + id: + type: string + kind: + $ref: '#/components/schemas/TemplateKind' + name: + type: string + orgID: + type: string + properties: + properties: + color: + type: string + description: + type: string + type: object + templateMetaName: + type: string + type: object + TestStatement: + description: Declares a Flux test case + properties: + assignment: + $ref: '#/components/schemas/VariableAssignment' + type: + $ref: '#/components/schemas/NodeType' + type: object + Threshold: + discriminator: + mapping: + greater: '#/components/schemas/GreaterThreshold' + lesser: '#/components/schemas/LesserThreshold' + range: '#/components/schemas/RangeThreshold' + propertyName: type + oneOf: + - $ref: '#/components/schemas/GreaterThreshold' + - $ref: '#/components/schemas/LesserThreshold' + - $ref: '#/components/schemas/RangeThreshold' + ThresholdBase: + properties: + allValues: + description: If true, only alert if all values meet threshold. + type: boolean + level: + $ref: '#/components/schemas/CheckStatusLevel' + ThresholdCheck: + allOf: + - $ref: '#/components/schemas/CheckBase' + - properties: + every: + description: Check repetition interval. + type: string + offset: + description: Duration to delay after the schedule, before executing check. + type: string + statusMessageTemplate: + description: The template used to generate and write a status message. + type: string + tags: + description: List of tags to write to each status. + items: + properties: + key: + type: string + value: + type: string + type: object + type: array + thresholds: + items: + $ref: '#/components/schemas/Threshold' + type: array + type: + enum: + - threshold + type: string + required: + - type + type: object + Token: + properties: + token: + type: string + type: object + UnaryExpression: + description: Uses operators to act on a single operand in an expression + properties: + argument: + $ref: '#/components/schemas/Expression' + operator: + type: string + type: + $ref: '#/components/schemas/NodeType' + type: object + UnsignedIntegerLiteral: + description: Represents integer numbers + properties: + type: + $ref: '#/components/schemas/NodeType' + value: + type: string + type: object + User: + properties: + id: + description: The user ID. + readOnly: true + type: string + name: + description: The user name. + type: string + status: + default: active + description: | + If `inactive`, the user is inactive. + Default is `active`. + enum: + - active + - inactive + type: string + required: + - name + UserResponse: + properties: + id: + description: | + The user ID. + readOnly: true + type: string + links: + example: + self: /api/v2/users/1 + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: | + The user name. + type: string + status: + default: active + description: | + The status of a user. + An inactive user can't read or write resources. + enum: + - active + - inactive + type: string + required: + - name + Users: + properties: + links: + properties: + self: + format: uri + type: string + type: object + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + type: object + Variable: + properties: + arguments: + $ref: '#/components/schemas/VariableProperties' + createdAt: + format: date-time + type: string + description: + type: string + id: + readOnly: true + type: string + labels: + $ref: '#/components/schemas/Labels' + links: + properties: + labels: + format: uri + type: string + org: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + name: + type: string + orgID: + type: string + selected: + items: + type: string + type: array + updatedAt: + format: date-time + type: string + required: + - name + - orgID + - arguments + type: object + VariableAssignment: + description: Represents the declaration of a variable + properties: + id: + $ref: '#/components/schemas/Identifier' + init: + $ref: '#/components/schemas/Expression' + type: + $ref: '#/components/schemas/NodeType' + type: object + VariableProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariableProperties' + - $ref: '#/components/schemas/ConstantVariableProperties' + - $ref: '#/components/schemas/MapVariableProperties' + type: object + Variables: + example: + variables: + - arguments: + type: constant + values: + - howdy + - hello + - hi + - yo + - oy + id: '1221432' + name: ':ok:' + selected: + - hello + - arguments: + type: map + values: + a: fdjaklfdjkldsfjlkjdsa + b: dfaksjfkljekfajekdljfas + c: fdjksajfdkfeawfeea + id: '1221432' + name: ':ok:' + selected: + - c + - arguments: + language: flux + query: 'from(bucket: "foo") |> showMeasurements()' + type: query + id: '1221432' + name: ':ok:' + selected: + - host + properties: + variables: + items: + $ref: '#/components/schemas/Variable' + type: array + type: object + View: + properties: + id: + readOnly: true + type: string + links: + properties: + self: + type: string + readOnly: true + type: object + name: + type: string + properties: + $ref: '#/components/schemas/ViewProperties' + required: + - name + - properties + ViewProperties: + oneOf: + - $ref: '#/components/schemas/LinePlusSingleStatProperties' + - $ref: '#/components/schemas/XYViewProperties' + - $ref: '#/components/schemas/SingleStatViewProperties' + - $ref: '#/components/schemas/HistogramViewProperties' + - $ref: '#/components/schemas/GaugeViewProperties' + - $ref: '#/components/schemas/TableViewProperties' + - $ref: '#/components/schemas/SimpleTableViewProperties' + - $ref: '#/components/schemas/MarkdownViewProperties' + - $ref: '#/components/schemas/CheckViewProperties' + - $ref: '#/components/schemas/ScatterViewProperties' + - $ref: '#/components/schemas/HeatmapViewProperties' + - $ref: '#/components/schemas/MosaicViewProperties' + - $ref: '#/components/schemas/BandViewProperties' + - $ref: '#/components/schemas/GeoViewProperties' + Views: + properties: + links: + properties: + self: + type: string + type: object + views: + items: + $ref: '#/components/schemas/View' + type: array + type: object + WritePrecision: + enum: + - ms + - s + - us + - ns + type: string + XYGeom: + enum: + - line + - step + - stacked + - bar + - monotoneX + - stepBefore + - stepAfter + type: string + XYViewProperties: + properties: + adaptiveZoomHide: + type: boolean + axes: + $ref: '#/components/schemas/Axes' + colorMapping: + $ref: '#/components/schemas/ColorMapping' + description: An object that contains information about the color mapping + colors: + description: Colors define color encoding of data into a visualization + items: + $ref: '#/components/schemas/DashboardColor' + type: array + generateXAxisTicks: + items: + type: string + type: array + generateYAxisTicks: + items: + type: string + type: array + geom: + $ref: '#/components/schemas/XYGeom' + hoverDimension: + enum: + - auto + - x + - 'y' + - xy + type: string + legendColorizeRows: + type: boolean + legendHide: + type: boolean + legendOpacity: + format: float + type: number + legendOrientationThreshold: + type: integer + note: + type: string + position: + enum: + - overlaid + - stacked + type: string + queries: + items: + $ref: '#/components/schemas/DashboardQuery' + type: array + shadeBelow: + type: boolean + shape: + enum: + - chronograf-v2 + type: string + showNoteWhenEmpty: + description: If true, will display note when empty + type: boolean + staticLegend: + $ref: '#/components/schemas/StaticLegend' + timeFormat: + type: string + type: + enum: + - xy + type: string + xColumn: + type: string + xTickStart: + format: float + type: number + xTickStep: + format: float + type: number + xTotalTicks: + type: integer + yColumn: + type: string + yTickStart: + format: float + type: number + yTickStep: + format: float + type: number + yTotalTicks: + type: integer + required: + - type + - geom + - queries + - shape + - axes + - colors + - note + - showNoteWhenEmpty + - position + type: object + securitySchemes: + BasicAuthentication: + description: | + ### Basic authentication scheme + + Use the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it: + + ### Syntax + + `Authorization: Basic BASE64_ENCODED_CREDENTIALS` + + To construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and + the password with a colon (`USERNAME:PASSWORD`), and then encode the + resulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64). + Many HTTP clients encode the credentials for you before sending the + request. + + _**Warning**: Base64-encoding can easily be reversed to obtain the original + username and password. It is used to keep the data intact and does not provide + security. You should always use HTTPS when authenticating or sending a request with + sensitive information._ + + ### Examples + + In the examples, replace the following: + + - **`USERNAME`**: InfluxDB username + - **`PASSWORD`**: InfluxDB [API token](/influxdb/latest/reference/glossary/#token) + - **`INFLUX_URL`**: your InfluxDB URL + + #### Encode credentials with cURL + + The following example shows how to use cURL to send an API request that uses Basic authentication. + With the `--user` option, cURL encodes the credentials and passes them + in the `Authorization: Basic` header. ```sh - curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \ - --header "Authorization: Token INFLUX_API_TOKEN" + curl --get "INFLUX_URL/api/v2/signin" + --user "USERNAME":"PASSWORD" ``` - The response contains the following: + #### Encode credentials with Flux - ```json - { - "links": { - "prev": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=49\u0026orgID=ORG_ID", - "self": "/api/v2/buckets?descending=false\u0026limit=1\u0026offset=50\u0026orgID=ORG_ID" - }, - "buckets": [] - } + The Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded + basic authentication header using a specified username and password combination. + + #### Encode credentials with JavaScript + + The following example shows how to use the JavaScript `btoa()` function + to create a Base64-encoded string: + + ```js + btoa('USERNAME:PASSWORD') ``` - name: Pagination - x-traitTag: true - - name: Ping - - description: | - Retrieve data, analyze queries, and get query suggestions. - name: Query - - description: | - See the [**API Quick Start**](/influxdb/latest/api-guide/api_intro/) - to get up and running authenticating with tokens, writing to buckets, and querying data. - [**InfluxDB API client libraries**](/influxdb/latest/api-guide/client-libraries/) - are available for popular languages and ready to import into your application. - name: Quick start - x-traitTag: true - - name: Ready - - name: RemoteConnections - - name: Replications - - name: Resources - - description: | - InfluxDB HTTP API endpoints use standard HTTP status codes for success and failure responses. - The response body may include additional details. - For details about a specific operation's response, - see **Responses** and **Response Samples** for that operation. + The output is the following: - API operations may return the following HTTP status codes: + ```js + 'VVNFUk5BTUU6UEFTU1dPUkQ=' + ``` - |  Code  | Status | Description | - |:-----------:|:------------------------ |:--------------------- | - | `200` | Success | | - | `204` | Success. No content | InfluxDB doesn't return data for the request. | - | `400` | Bad request | May indicate one of the following:
  • 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.
  • `Authorization` header is missing or malformed or the API token doesn't have permission for the operation.
| - | `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/latest/security/tokens/)
| - | `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | - | `413` | Request entity too large | Request payload exceeds the size limit. | - | `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. | - | `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. | - | `500` | Internal server error | | - | `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. | - name: Response codes - x-traitTag: true - - name: Restore - - name: Routes - - name: Rules - - name: Scraper Targets - - name: Secrets - - name: Security and access endpoints - - name: Setup - - name: Signin - - name: Signout - - name: Sources - - 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" - name: Supported operations - x-traitTag: true - - name: System information endpoints - - description: | - Process and analyze your data with [tasks](/influxdb/latest/reference/glossary/#task) - in the InfluxDB task engine. - Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs. + Once you have the Base64-encoded credentials, you can pass them in the + `Authorization` header--for example: - 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). + ```sh + curl --get "INFLUX_URL/api/v2/signin" + --header "Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=" + ``` - + To learn more about HTTP authentication, see + [Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._ + scheme: basic + type: http + TokenAuthentication: + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. - ### Properties + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. - A `task` object contains information about an InfluxDB task resource. + ### Syntax - The following table defines the properties that appear in a `task` object: + `Authorization: Token INFLUX_API_TOKEN` - + ### Example - ### Related guides + #### Use Token authentication with cURL - - [Get started with tasks](/influxdb/latest/process-data/get-started/) - - [Common data processing tasks](/influxdb/latest/process-data/common-tasks/) - name: Tasks - - name: Telegraf Plugins - - name: Telegrafs - - description: | - Export and apply InfluxDB **templates**. - Manage **stacks** of templated InfluxDB resources. + The following example shows how to use cURL to send an API request that uses Token authentication: - InfluxDB templates are prepackaged configurations for - everything from dashboards and Telegraf to notifications and alerts. - Use InfluxDB templates to quickly configure a fresh instance of InfluxDB, - back up your dashboard configuration, or share your configuration with the - InfluxData community. + ```sh + curl --request GET "INFLUX_URL/api/v2/buckets" \ + --header "Authorization: Token INFLUX_API_TOKEN" + ``` - Use the `/api/v2/templates` endpoints to export templates and apply templates. + Replace the following: - **InfluxDB stacks** are stateful InfluxDB templates that let you - add, update, and remove installed template resources over time, avoid duplicating - resources when applying the same or similar templates more than once, and - apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud. + - *`INFLUX_URL`*: your InfluxDB URL + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/latest/reference/glossary/#token) - Use the `/api/v2/stacks` endpoints to manage installed template resources. + ### Related endpoints - ### Related guides + - [`/authorizations` endpoints](#tag/Authorizations-(API-tokens)) - - [InfluxDB stacks](/influxdb/latest/influxdb-templates/stacks/) - - [InfluxDB templates](/influxdb/latest/influxdb-templates/) - name: Templates - - description: | - Manage users for your organization. - Users are those with access to InfluxDB. - To grant a user permission to access data, add them as a member of an - organization and provide them with an API token. + ### Related guides - ### User sessions with authorizations - - Optionally, you can scope an authorization (and its API token) to a user. - If a user signs in with username and password, creating a _user session_, - 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). - - ### Related guides - - - [Manage users](/influxdb/latest/influxdb/latest/users/) - - [Create a token scoped to a user](/influxdb/latest/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) - name: Users - - name: Variables - - name: Views - - description: | - Write time series data to [buckets](/influxdb/latest/reference/glossary/#bucket). - name: Write + - [Authorize API requests](/influxdb/latest/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb/latest/security/tokens/) + in: header + name: Authorization + type: apiKey x-tagGroups: - name: Using the InfluxDB HTTP API tags: diff --git a/api-docs/cloud/content/v1compat/info.yml b/api-docs/v2/v1-compatibility/content/info.yml similarity index 59% rename from api-docs/cloud/content/v1compat/info.yml rename to api-docs/v2/v1-compatibility/content/info.yml index e5d9d3ec3..17ab99443 100644 --- a/api-docs/cloud/content/v1compat/info.yml +++ b/api-docs/v2/v1-compatibility/content/info.yml @@ -1,11 +1,11 @@ -title: InfluxDB Cloud v1 compatibility API documentation +title: InfluxDB v1 HTTP API for InfluxDB v2 OSS +summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints. description: | The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. - If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud/api/). - This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + license: name: MIT - url: 'https://opensource.org/licenses/MIT' \ No newline at end of file + url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/v2/v1-compatibility/swaggerV1Compat.yml b/api-docs/v2/v1-compatibility/swaggerV1Compat.yml new file mode 100644 index 000000000..19b9b5c49 --- /dev/null +++ b/api-docs/v2/v1-compatibility/swaggerV1Compat.yml @@ -0,0 +1,446 @@ +openapi: 3.0.0 +info: + title: InfluxDB v1 HTTP API for InfluxDB v2 OSS + version: '' + description: | + The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. + + This documentation is generated from the + [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml). + license: + name: MIT + url: https://opensource.org/licenses/MIT + summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints. +servers: + - url: / +security: + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + The InfluxDB 1.x API requires authentication for all requests. + InfluxDB Cloud uses InfluxDB API tokens to authenticate requests. + + + For more information, see the following: + - [Token authentication](#section/Authentication/TokenAuthentication) + - [Basic authentication](#section/Authentication/BasicAuthentication) + - [Querystring authentication](#section/Authentication/QuerystringAuthentication) + + + x-traitTag: true + - name: Query + - name: Write +paths: + /write: + post: + operationId: PostWriteV1 + tags: + - Write + summary: Write time series data into InfluxDB in a V1-compatible format + requestBody: + description: Line protocol body + required: true + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: query + name: db + schema: + type: string + required: true + description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: precision + schema: + type: string + description: Write precision. + - in: header + name: Content-Encoding + description: When present, its value indicates to the database that compression is applied to the line protocol body. + schema: + type: string + description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + responses: + '204': + description: Write data is correctly formatted and accepted for writing to the bucket. + '400': + description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolError' + '401': + description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: No token was sent and they are required. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '413': + description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. + content: + application/json: + schema: + $ref: '#/components/schemas/LineProtocolLengthError' + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + '503': + description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /query: + post: + operationId: PostQueryV1 + tags: + - Query + summary: Query InfluxDB in a V1 compatible format + requestBody: + description: InfluxQL query to execute. + content: + text/plain: + schema: + type: string + parameters: + - $ref: '#/components/parameters/TraceSpan' + - $ref: '#/components/parameters/AuthUserV1' + - $ref: '#/components/parameters/AuthPassV1' + - in: header + name: Accept + schema: + type: string + description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + default: application/json + enum: + - application/json + - application/csv + - text/csv + - application/x-msgpack + - in: header + name: Accept-Encoding + description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. + schema: + type: string + description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + - in: header + name: Content-Type + schema: + type: string + enum: + - application/vnd.influxql + - in: query + name: db + schema: + type: string + required: true + description: Bucket to query. + - in: query + name: rp + schema: + type: string + description: Retention policy name. + - in: query + name: q + description: Defines the influxql query to run. + schema: + type: string + responses: + '200': + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + application/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + text/csv: + schema: + $ref: '#/components/schemas/InfluxQLCSVResponse' + application/json: + schema: + $ref: '#/components/schemas/InfluxQLResponse' + application/x-msgpack: + schema: + type: string + format: binary + '429': + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query + content: + application/json: + schema: + $ref: '#/components/schemas/Error' +components: + parameters: + TraceSpan: + in: header + name: Zap-Trace-Span + description: OpenTracing span context + example: + trace_id: '1' + span_id: '1' + baggage: + key: value + required: false + schema: + type: string + AuthUserV1: + in: query + name: u + required: false + schema: + type: string + description: Username. + AuthPassV1: + in: query + name: p + required: false + schema: + type: string + description: User token. + schemas: + InfluxQLResponse: + properties: + results: + type: array + oneOf: + - required: + - statement_id + - error + - required: + - statement_id + - series + items: + type: object + properties: + statement_id: + type: integer + error: + type: string + series: + type: array + items: + type: object + properties: + name: + type: string + tags: + type: object + additionalProperties: + type: string + partial: + type: boolean + columns: + type: array + items: + type: string + values: + type: array + items: + type: array + items: {} + InfluxQLCSVResponse: + type: string + example: | + name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value + Error: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - unprocessable entity + - empty value + - unavailable + - forbidden + - too many requests + - unauthorized + - method not allowed + message: + readOnly: true + description: Message is a human-readable message. + type: string + required: + - code + - message + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + message: + readOnly: true + description: Message is a human-readable message. + type: string + op: + readOnly: true + description: Op describes the logical code operation during error. Useful for debugging. + type: string + err: + readOnly: true + description: Err is a stack of errors that occurred during processing of the request. Useful for debugging. + type: string + line: + readOnly: true + description: First line within sent body containing malformed data + type: integer + format: int32 + required: + - code + - message + - op + - err + LineProtocolLengthError: + properties: + code: + description: Code is the machine-readable error code. + readOnly: true + type: string + enum: + - invalid + message: + readOnly: true + description: Message is a human-readable message. + type: string + maxLength: + readOnly: true + description: Max length in bytes for a body of line-protocol. + type: integer + format: int32 + required: + - code + - message + - maxLength + securitySchemes: + TokenAuthentication: + type: apiKey + name: Authorization + in: header + description: | + Use the [Token authentication](#section/Authentication/TokenAuthentication) + scheme to authenticate to the InfluxDB API. + + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and an InfluxDB API token. + The word `Token` is case-sensitive. + + + ### Syntax + + `Authorization: Token YOUR_INFLUX_TOKEN` + + + For examples and more information, see the following: + - [`/authorizations`](#tag/Authorizations) endpoint. + - [Authorize API requests](/influxdb/cloud/api-guide/api_intro/#authentication). + - [Manage API tokens](/influxdb/cloud/security/tokens/). + BasicAuthentication: + type: http + scheme: basic + description: | + Use the HTTP [Basic authentication](#section/Authentication/BasicAuthentication) + scheme with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme): + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: | + Use the [Querystring authentication](#section/Authentication/QuerystringAuthentication) + scheme with InfluxDB 1.x API parameters to provide credentials through the query string. + + + For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/). +x-tagGroups: + - name: Using the InfluxDB HTTP API + tags: + - Quick start + - Authentication + - Supported operations + - Headers + - Pagination + - Response codes + - Data I/O endpoints + - Security and access endpoints + - System information endpoints + - name: All endpoints + tags: + - Query + - Write diff --git a/assets/js/influxdb-url.js b/assets/js/influxdb-url.js index cf656169e..b17ff34f9 100644 --- a/assets/js/influxdb-url.js +++ b/assets/js/influxdb-url.js @@ -287,16 +287,17 @@ function appendUrlSelector () { placeholderUrls.clustered, ]; - if (context() === 'cloud' || 'serverless') { - var selectorText = 'InfluxDB Cloud Region'; - } else if (context() === 'dedicated') { - var selectorText = 'Set Dedicated cluster URL'; - } else if (context() === 'clustered') { - var selectorText = 'Set InfluxDB cluster URL'; - } else if (context() === 'oss/enterprise') { - var selectorText = 'Change InfluxDB URL'; - } else { - var selectorText = 'InfluxDB Cloud or OSS?'; + getBtnText = (context) => { + contextText = { + 'oss/enterprise': 'Change InfluxDB URL', + 'cloud': 'InfluxDB Cloud Region', + 'serverless': 'InfluxDB Cloud Region', + 'dedicated': 'Set Dedicated cluster URL', + 'clustered': 'Set InfluxDB cluster URL', + 'other': 'InfluxDB Cloud or OSS?' + } + + return contextText[context] } appendToUrls.forEach(function (url) { @@ -305,7 +306,7 @@ function appendUrlSelector () { if (code.includes(url)) { $(this).after( "
" + - selectorText + + getBtnText(context()) + '
' ); $('.select-url').fadeIn(400); diff --git a/assets/js/tabbed-content.js b/assets/js/tabbed-content.js index 33a6416a8..536301828 100644 --- a/assets/js/tabbed-content.js +++ b/assets/js/tabbed-content.js @@ -40,6 +40,7 @@ function getTabQueryParam () { // Add query param to .keep-tab paginated navigation buttons to persist tab // selection when navigating between the pages. + function updateBtnURLs (tabId, op = 'update') { $('a.keep-tab').each(function () { var link = $(this)[0].href; @@ -54,7 +55,7 @@ function updateBtnURLs (tabId, op = 'update') { } function activateTabs (selector, tab) { - const anchor = window.location.hash; + var anchor = window.location.hash; if (tab !== '') { let targetTab = $(`${selector} a:contains("${tab}")`); if (!targetTab.length) { @@ -71,25 +72,27 @@ function activateTabs (selector, tab) { scrollToAnchor(anchor); } } - - const queryParams = new URLSearchParams(window.location.search); - $(`${selector} p a`).click(function () { - if ($(this).is(':not(":first-child")')) { - queryParams.set('t', $(this).html()); - window.history.replaceState( - {}, - '', - `${location.pathname}?${queryParams}${anchor}` - ); - updateBtnURLs($(this).html()); - } else { - queryParams.delete('t'); - window.history.replaceState({}, '', `${location.pathname}${anchor}`); - updateBtnURLs($(this).html(), 'delete'); - } - }); } +$(`.tabs p a, .code-tabs p a`).click(function () { + var queryParams = new URLSearchParams(window.location.search); + var anchor = window.location.hash; + + if ($(this).is(':not(":first-child")')) { + queryParams.set('t', $(this).html()); + window.history.replaceState( + {}, + '', + `${location.pathname}?${queryParams}${anchor}` + ); + updateBtnURLs($(this).html()); + } else { + queryParams.delete('t'); + window.history.replaceState({}, '', `${location.pathname}${anchor}`); + updateBtnURLs($(this).html(), 'delete'); + } +}); + //////////////////// Activate Tab with Cookie or Query Param /////////////////// tab = getTabQueryParam(); diff --git a/compose.yaml b/compose.yaml index bdf2562cf..c963d729a 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,5 +1,5 @@ -# For examples, see the Awesome Compose repository: -# https://github.com/docker/awesome-compose +# This is a Docker Compose file for the InfluxData documentation site. +## Run documentation tests for code samples. services: test: image: docs-v2-tests @@ -19,3 +19,18 @@ services: args: - SOURCE_DIR=test - DOCKER_IMAGE=docs-v2-tests + ## Run InfluxData documentation with the hugo development server on port 1313. + ## For more information about the hugomods/hugo image, see + ## https://docker.hugomods.com/docs/development/docker-compose/ + local-dev: + image: hugomods/hugo:exts-0.123.8 + command: hugo server --bind 0.0.0.0 + ports: + - 1313:1313 + volumes: + - type: bind + source: "$PWD" + target: /src + - type: bind + source: $HOME/hugo_cache + target: /tmp/hugo_cache diff --git a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md index bed36cc78..04b719aae 100644 --- a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md +++ b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md @@ -238,8 +238,8 @@ Environment variable: `INFLUXDB_META_LEADER_LEASE_TIMEOUT` Default is `"50ms"`. -The commit timeout is the amount of time a Raft node will tolerate between -commands before issuing a heartbeat to tell the leader it is alive. +The commit timeout is the interval that the leader waits between sending messages with +the leader's commit index to followerers. The default setting should work for most systems. Environment variable: `INFLUXDB_META_COMMIT_TIMEOUT` diff --git a/content/enterprise_influxdb/v1/administration/configure/security/enable_tls.md b/content/enterprise_influxdb/v1/administration/configure/security/enable_tls.md index e61ffe566..cface4733 100644 --- a/content/enterprise_influxdb/v1/administration/configure/security/enable_tls.md +++ b/content/enterprise_influxdb/v1/administration/configure/security/enable_tls.md @@ -55,7 +55,7 @@ Regardless of your certificate's type, InfluxDB Enterprise supports certificates a private key file (`.key`) and a signed certificate file (`.crt`) file pair, as well as certificates that combine the private key file and the signed certificate file into a single bundled file (`.pem`). -In general, each node node should have its own certificate, whether signed or unsiged. +In general, each node node should have its own certificate, whether signed or unsigned. ## Set up HTTPS in an InfluxDB Enterprise cluster diff --git a/content/enterprise_influxdb/v1/tools/grafana.md b/content/enterprise_influxdb/v1/tools/grafana.md index f50c565a2..85e8042d5 100644 --- a/content/enterprise_influxdb/v1/tools/grafana.md +++ b/content/enterprise_influxdb/v1/tools/grafana.md @@ -12,29 +12,34 @@ canonical: /influxdb/v2/tools/grafana/ --- Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/products/cloud/) -to visualize data from your **InfluxDB Enterprise v1.8** instance. +to visualize data from your **InfluxDB Enterprise** cluster. {{% note %}} #### Required -- The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**. +- The instructions in this guide require **Grafana Cloud** or **Grafana v10.3+**. For information about using InfluxDB with other versions of Grafana, - see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/). -- To use **Flux**, use **InfluxDB Enterprise 1.8.1+** and [enable Flux](/enterprise_influxdb/v1/flux/installation/) - in your InfluxDB data node configuration file. + see the [Grafana documentation](https://grafana.com/docs/grafana/latest/datasources/influxdb/). +- To use **Flux**, use **InfluxDB 1.8.1+** and [enable Flux](/influxdb/v1/flux/installation/) + in your InfluxDB configuration file. {{% /note %}} -1. [Set up an InfluxDB Enterprise cluster](/enterprise_influxdb/v1/introduction/installation/). -2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or - [download and install Grafana](https://grafana.com/grafana/download). -3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, - [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit - `http://localhost:3000` in your browser. -4. In the left navigation of the Grafana UI, hover over the gear - icon to expand the **Configuration** section. Click **Data Sources**. -5. Click **Add data source**. -6. Select **InfluxDB** from the list of available data sources. -7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. -8. Under **Query Language**, select one of the following: +1. [Set up an InfluxDB Enterprise cluster](/enterprise_influxdb/v1/introduction/installation/). +2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or + [download and install Grafana](https://grafana.com/grafana/download). +3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, + [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit + in your browser. +4. In the left navigation of the Grafana UI, expand the **Connections** section + and click **Add new connection**. +5. Select **InfluxDB** from the list of available data sources and click + **Add data source**. +6. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. +7. In the **Query Language** drop-down menu, select one of the query languages + supported by InfluxDB {{< current-version >}} (InfluxQL or Flux): + + {{% note %}} +SQL is only supported in InfluxDB v3. + {{% /note %}} {{< tabs-wrapper >}} {{% tabs %}} @@ -52,25 +57,25 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se - **URL**: Your **InfluxDB Enterprise URL** or **load balancer URL**. ```sh - http://localhost:8086/ + http://localhost:8086 ``` - - **Access**: Server (default) 2. Under **InfluxDB Details**, enter the following: - **Database**: your database name - - **User**: your InfluxDB Enterprise username _(if [authentication is enabled](/enterprise_influxdb/v1/administration/authentication_and_authorization/))_ - - **Password**: your InfluxDB Enterprise password _(if [authentication is enabled](/enterprise_influxdb/v1/administration/authentication_and_authorization/))_ - - **HTTP Method**: select **GET** or **POST** _(for differences between the two, + - **User**: your InfluxDB username _(if [authentication is enabled](/enterprise_influxdb/v1/administration/authentication_and_authorization/))_ + - **Password**: your InfluxDB password _(if [authentication is enabled](/enterprise_influxdb/v1/administration/authentication_and_authorization/))_ + - **HTTP Method**: Select **GET** or **POST** _(for differences between the two, see the [query HTTP endpoint documentation](/enterprise_influxdb/v1/tools/api/#query-http-endpoint))_ 3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)** (default is 10s). - {{< img-hd src="/img/enterprise/1-7-tools-grafana-influxql.png" />}} + {{< img-hd src="/img/influxdb/v1-tools-grafana-influxql.png" />}} -4. Click **Save & Test**. Grafana attempts to connect to InfluxDB Enterprise and returns +4. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns the result of the test. + {{% /tab-content %}} @@ -80,18 +85,22 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se With **Flux** selected as the query language in your InfluxDB data source, configure your InfluxDB connection: -1. Ensure [Flux is enabled](/enterprise_influxdb/v1/flux/installation/) in InfluxDB Enterprise data nodes. +1. Ensure [Flux is enabled](/enterprise_influxdb/v1/flux/installation/) in + your InfluxDB Enterprise data nodes. -2. Under **Connection**, enter the following: +2. Under **HTTP**, enter the following: - **URL**: Your **InfluxDB Enterprise URL** or **load balancer URL**. ```sh - http://localhost:8086/ + http://localhost:8086 ``` +3. Under **InfluxDB Details**, enter the following: + - **Organization**: Provide an arbitrary value. - - **Token**: Provide your InfluxDB Enterprise username and password using the following syntax: + - **Token**: If [InfluxDB authentication is enabled](/enterprise_influxdb/v1/administration/authentication_and_authorization/), + provide your InfluxDB username and password using the following syntax: ```sh # Syntax @@ -101,9 +110,7 @@ configure your InfluxDB connection: johndoe:mY5uP3rS3crE7pA5Sw0Rd ``` - We recommend [enabling authentication](/enterprise_influxdb/v1/administration/authentication_and_authorization/) - on all InfluxDB Enterprise clusters. If you choose to leave authentication disabled, - leave this field blank. + If authentication is not enabled, leave blank. - **Default Bucket**: Provide a default database and retention policy combination using the following syntax: @@ -119,9 +126,9 @@ configure your InfluxDB connection: - **Min time interval**: [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval). - {{< img-hd src="/img/enterprise/1-8-tools-grafana-flux.png" />}} + {{< img-hd src="/img/influxdb/v1-tools-grafana-flux.png" />}} -3. Click **Save & Test**. Grafana attempts to connect to InfluxDB Enterprise and returns +3. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns the result of the test. {{% /tab-content %}} diff --git a/content/flux/v0/stdlib/array/concat.md b/content/flux/v0/stdlib/array/concat.md index 24fe935a4..6a3db8776 100644 --- a/content/flux/v0/stdlib/array/concat.md +++ b/content/flux/v0/stdlib/array/concat.md @@ -40,7 +40,9 @@ Neither input array is mutated and a new array is returned. (<-arr: [A], v: [A]) => [A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/array/filter.md b/content/flux/v0/stdlib/array/filter.md index 5644a45e1..7c56769ce 100644 --- a/content/flux/v0/stdlib/array/filter.md +++ b/content/flux/v0/stdlib/array/filter.md @@ -40,7 +40,9 @@ a new array with only elements that match the predicate. (<-arr: [A], fn: (x: A) => bool) => [A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/array/from.md b/content/flux/v0/stdlib/array/from.md index b00a0823f..739c1c23d 100644 --- a/content/flux/v0/stdlib/array/from.md +++ b/content/flux/v0/stdlib/array/from.md @@ -38,7 +38,9 @@ records must have the same keys and data types. (<-rows: [A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/array/map.md b/content/flux/v0/stdlib/array/map.md index 9ebce3cfa..d7aaeb75a 100644 --- a/content/flux/v0/stdlib/array/map.md +++ b/content/flux/v0/stdlib/array/map.md @@ -40,7 +40,9 @@ and then returns a new array. (<-arr: [A], fn: (x: A) => B) => [B] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/sand.md b/content/flux/v0/stdlib/bitwise/sand.md index 91b55bf6e..de8838278 100644 --- a/content/flux/v0/stdlib/bitwise/sand.md +++ b/content/flux/v0/stdlib/bitwise/sand.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/sclear.md b/content/flux/v0/stdlib/bitwise/sclear.md index db2fcf899..088f806d6 100644 --- a/content/flux/v0/stdlib/bitwise/sclear.md +++ b/content/flux/v0/stdlib/bitwise/sclear.md @@ -38,7 +38,9 @@ Both `a` and `b` are integers. (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/slshift.md b/content/flux/v0/stdlib/bitwise/slshift.md index 89020d9b2..0c8d3c9b1 100644 --- a/content/flux/v0/stdlib/bitwise/slshift.md +++ b/content/flux/v0/stdlib/bitwise/slshift.md @@ -38,7 +38,9 @@ Both `a` and `b` are integers. (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/snot.md b/content/flux/v0/stdlib/bitwise/snot.md index 618b6cacf..2456503f6 100644 --- a/content/flux/v0/stdlib/bitwise/snot.md +++ b/content/flux/v0/stdlib/bitwise/snot.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/sor.md b/content/flux/v0/stdlib/bitwise/sor.md index 77a606e81..d9564c3e8 100644 --- a/content/flux/v0/stdlib/bitwise/sor.md +++ b/content/flux/v0/stdlib/bitwise/sor.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/srshift.md b/content/flux/v0/stdlib/bitwise/srshift.md index f8e5d55ac..426be8b0d 100644 --- a/content/flux/v0/stdlib/bitwise/srshift.md +++ b/content/flux/v0/stdlib/bitwise/srshift.md @@ -38,7 +38,9 @@ Both `a` and `b` are integers. (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/sxor.md b/content/flux/v0/stdlib/bitwise/sxor.md index a340849dd..916644860 100644 --- a/content/flux/v0/stdlib/bitwise/sxor.md +++ b/content/flux/v0/stdlib/bitwise/sxor.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/uand.md b/content/flux/v0/stdlib/bitwise/uand.md index 97dc79fd2..3fd706925 100644 --- a/content/flux/v0/stdlib/bitwise/uand.md +++ b/content/flux/v0/stdlib/bitwise/uand.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/uclear.md b/content/flux/v0/stdlib/bitwise/uclear.md index 356efed6f..a5896481e 100644 --- a/content/flux/v0/stdlib/bitwise/uclear.md +++ b/content/flux/v0/stdlib/bitwise/uclear.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/ulshift.md b/content/flux/v0/stdlib/bitwise/ulshift.md index 0a6564a15..5b29af4b8 100644 --- a/content/flux/v0/stdlib/bitwise/ulshift.md +++ b/content/flux/v0/stdlib/bitwise/ulshift.md @@ -38,7 +38,9 @@ Both `a` and `b` are unsigned integers. (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/unot.md b/content/flux/v0/stdlib/bitwise/unot.md index ab492580b..ffce69d31 100644 --- a/content/flux/v0/stdlib/bitwise/unot.md +++ b/content/flux/v0/stdlib/bitwise/unot.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/uor.md b/content/flux/v0/stdlib/bitwise/uor.md index f7ed5e111..8ccf6d68f 100644 --- a/content/flux/v0/stdlib/bitwise/uor.md +++ b/content/flux/v0/stdlib/bitwise/uor.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/urshift.md b/content/flux/v0/stdlib/bitwise/urshift.md index ca5f165bd..2a677f9db 100644 --- a/content/flux/v0/stdlib/bitwise/urshift.md +++ b/content/flux/v0/stdlib/bitwise/urshift.md @@ -38,7 +38,9 @@ Both `a` and `b` are unsigned integers. (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/bitwise/uxor.md b/content/flux/v0/stdlib/bitwise/uxor.md index b077c2b48..4da1ab9c5 100644 --- a/content/flux/v0/stdlib/bitwise/uxor.md +++ b/content/flux/v0/stdlib/bitwise/uxor.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naivebayes.md b/content/flux/v0/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naivebayes.md index c021905df..326797755 100644 --- a/content/flux/v0/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naivebayes.md +++ b/content/flux/v0/stdlib/contrib/RohanSreerama5/naiveBayesClassifier/naivebayes.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[F] where A: Equatable, B: Equatable, D: Equatable, E: Equatable, F: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/anaisdg/anomalydetection/mad.md b/content/flux/v0/stdlib/contrib/anaisdg/anomalydetection/mad.md index 123f9ff1c..d300717e4 100644 --- a/content/flux/v0/stdlib/contrib/anaisdg/anomalydetection/mad.md +++ b/content/flux/v0/stdlib/contrib/anaisdg/anomalydetection/mad.md @@ -42,7 +42,9 @@ Output data is grouped by `_time` and includes the following columns of interest (<-table: stream[B], ?threshold: A) => stream[{C with level: string, _value_diff_med: D, _value_diff: D, _value: D}] where A: Comparable + Equatable, B: Record, D: Comparable + Divisible + Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/anaisdg/statsmodels/linearregression.md b/content/flux/v0/stdlib/contrib/anaisdg/statsmodels/linearregression.md index 8525d0363..4a0568585 100644 --- a/content/flux/v0/stdlib/contrib/anaisdg/statsmodels/linearregression.md +++ b/content/flux/v0/stdlib/contrib/anaisdg/statsmodels/linearregression.md @@ -64,7 +64,9 @@ Output data includes the following columns: }] where A: Record, D: Divisible + Subtractable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/alert.md b/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/alert.md index 6950f81ff..20ce862b7 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/alert.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/alert.md @@ -53,7 +53,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/endpoint.md b/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/endpoint.md index f1d9dc97b..db18b8c4c 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/endpoint.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/alerta/endpoint.md @@ -80,7 +80,9 @@ For more information, see `alerta.alert()` parameters. ) => (<-tables: stream[C]) => stream[{C with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/bytes.md b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/bytes.md index 35bc0a53b..780118f1d 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/bytes.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/bytes.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => bytes ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/int.md b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/int.md index 484f7dd05..37608be3b 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/int.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/int.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/string.md b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/string.md index 108a8586a..102a78fb5 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/string.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/string.md @@ -38,7 +38,9 @@ types to hexadecimal lowercase characters. (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/uint.md b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/uint.md index 75a715738..09856f780 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/hex/uint.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/hex/uint.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/endpoint.md b/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/endpoint.md index 65ea8cc23..65742a2cd 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/endpoint.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/endpoint.md @@ -75,7 +75,9 @@ For more information, see `servicenow.event()` parameters. ) => (<-tables: stream[B]) => stream[{B with _sent: string}] where J: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/event.md b/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/event.md index f19f2975f..f6434ad45 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/event.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/servicenow/event.md @@ -51,7 +51,9 @@ ServiceNow Event API fields are described in ) => int where B: Equatable, C: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/alert.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/alert.md index f404ccac3..5148408cc 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/alert.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/alert.md @@ -80,7 +80,9 @@ TICKscript [`alert()`](/kapacitor/v1/reference/nodes/alert_node/). }] where E: Record, I: Record, M: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/compute.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/compute.md index e17d32e3a..ba17681f9 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/compute.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/compute.md @@ -39,7 +39,9 @@ optionally applies an aggregate or selector function. (<-tables: B, as: string, ?column: A, ?fn: (<-: B, column: A) => stream[C]) => stream[D] where A: Equatable, C: Record, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/deadman.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/deadman.md index d6fcfd3f6..03b7e5345 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/deadman.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/deadman.md @@ -79,7 +79,9 @@ This function is comparable to [Kapacitor AlertNode deadman](/kapacitor/latest/n }] where E: Record, F: Record, L: Comparable + Equatable, M: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck.md index 8006cf70f..0ea4a9681 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (id: A, name: B, ?type: C) => {tags: {}, _type: C, _check_name: B, _check_id: A} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/groupby.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/groupby.md index 1c6baeb92..50a0277f9 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/groupby.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/groupby.md @@ -39,7 +39,9 @@ This function is comparable to [Kapacitor QueryNode .groupBy](/kapacitor/latest/ (<-tables: stream[A], columns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/join.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/join.md index 241e2bbd3..7e4a5d7f8 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/join.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/join.md @@ -39,7 +39,9 @@ This function is comparable to [Kapacitor JoinNode](/kapacitor/latest/nodes/join (measurement: A, tables: B, ?on: [string]) => stream[{C with _measurement: A}] where B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/select.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/select.md index fd72ad025..0639a2a42 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/select.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/select.md @@ -49,7 +49,9 @@ query("SELECT f(x) AS y") (<-tables: B, as: string, ?column: A, ?fn: (<-: B, column: A) => stream[C]) => stream[D] where A: Equatable, C: Record, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/selectwindow.md b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/selectwindow.md index 00674c6ef..a04c349e1 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/selectwindow.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/selectwindow.md @@ -53,7 +53,9 @@ query("SELECT f(x) AS y") ) => stream[E] where B: Record, C: Record, D: Record, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/alert.md b/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/alert.md index 59085830f..a1d666f60 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/alert.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/alert.md @@ -45,7 +45,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/endpoint.md b/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/endpoint.md index e0a8d6d2d..1d01b0d9f 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/endpoint.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/victorops/endpoint.md @@ -67,7 +67,9 @@ For more information, see `victorops.event()` parameters. ) => (<-tables: stream[B]) => stream[{B with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/endpoint.md b/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/endpoint.md index a93bc724a..e93ea97f4 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/endpoint.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/endpoint.md @@ -78,7 +78,9 @@ For more information, see `zenoss.event()` parameters. ) => (<-tables: stream[F]) => stream[{F with _sent: string}] where B: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/event.md b/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/event.md index 933ed5c65..47bd336b5 100644 --- a/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/event.md +++ b/content/flux/v0/stdlib/contrib/bonitoo-io/zenoss/event.md @@ -54,7 +54,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int where C: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/chobbs/discord/endpoint.md b/content/flux/v0/stdlib/contrib/chobbs/discord/endpoint.md index 73d0f4527..fbab4172b 100644 --- a/content/flux/v0/stdlib/contrib/chobbs/discord/endpoint.md +++ b/content/flux/v0/stdlib/contrib/chobbs/discord/endpoint.md @@ -58,7 +58,9 @@ For more information, see the `discord.send()` `content` parameter. ) => (mapFn: (r: C) => {D with content: E}) => (<-tables: stream[C]) => stream[{C with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/chobbs/discord/send.md b/content/flux/v0/stdlib/contrib/chobbs/discord/send.md index 87230a29c..25a857435 100644 --- a/content/flux/v0/stdlib/contrib/chobbs/discord/send.md +++ b/content/flux/v0/stdlib/contrib/chobbs/discord/send.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/jsternberg/influxdb/from.md b/content/flux/v0/stdlib/contrib/jsternberg/influxdb/from.md index 81686c42e..a1b8c1d5a 100644 --- a/content/flux/v0/stdlib/contrib/jsternberg/influxdb/from.md +++ b/content/flux/v0/stdlib/contrib/jsternberg/influxdb/from.md @@ -52,7 +52,9 @@ This version of `from` is equivalent to `from() |> range()` in a single call. }] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/jsternberg/influxdb/select.md b/content/flux/v0/stdlib/contrib/jsternberg/influxdb/select.md index f3a5fd93b..a90e72cd5 100644 --- a/content/flux/v0/stdlib/contrib/jsternberg/influxdb/select.md +++ b/content/flux/v0/stdlib/contrib/jsternberg/influxdb/select.md @@ -63,7 +63,9 @@ returned by InfluxQL `SELECT` statements. ) => stream[F] where A: Equatable, F: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/clickhouse/query.md b/content/flux/v0/stdlib/contrib/qxip/clickhouse/query.md index 3a4798b0d..4679e9da3 100644 --- a/content/flux/v0/stdlib/contrib/qxip/clickhouse/query.md +++ b/content/flux/v0/stdlib/contrib/qxip/clickhouse/query.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[C] where A: Stringable, B: Stringable, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/b64.md b/content/flux/v0/stdlib/contrib/qxip/hash/b64.md index 1caf2af10..876c6239b 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/b64.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/b64.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/cityhash64.md b/content/flux/v0/stdlib/contrib/qxip/hash/cityhash64.md index 4046d407e..250790271 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/cityhash64.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/cityhash64.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/hmac.md b/content/flux/v0/stdlib/contrib/qxip/hash/hmac.md index 5efbf40a9..1015df238 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/hmac.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/hmac.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (k: A, v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/md5.md b/content/flux/v0/stdlib/contrib/qxip/hash/md5.md index 0f03360c9..43f1a45d0 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/md5.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/md5.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/sha1.md b/content/flux/v0/stdlib/contrib/qxip/hash/sha1.md index 39458080e..6d1d1e68a 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/sha1.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/sha1.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/sha256.md b/content/flux/v0/stdlib/contrib/qxip/hash/sha256.md index f22f2e245..2e88ad241 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/sha256.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/sha256.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/hash/xxhash64.md b/content/flux/v0/stdlib/contrib/qxip/hash/xxhash64.md index 827f0ad64..37f943fac 100644 --- a/content/flux/v0/stdlib/contrib/qxip/hash/xxhash64.md +++ b/content/flux/v0/stdlib/contrib/qxip/hash/xxhash64.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/qxip/logql/query_range.md b/content/flux/v0/stdlib/contrib/qxip/logql/query_range.md index bb6721ada..59e3b7013 100644 --- a/content/flux/v0/stdlib/contrib/qxip/logql/query_range.md +++ b/content/flux/v0/stdlib/contrib/qxip/logql/query_range.md @@ -50,7 +50,9 @@ All values are returned as string values (using `raw` mode in `csv.from`) ) => stream[E] where A: Timeable, B: Stringable, C: Timeable, D: Stringable, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/endpoint.md b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/endpoint.md index e27d07fc3..e47ee5453 100644 --- a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/endpoint.md +++ b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/endpoint.md @@ -53,7 +53,9 @@ _For more information, see `bigpanda.sendAlert()` parameters._ ) => (mapFn: (r: B) => {C with status: D}) => (<-tables: stream[B]) => stream[{B with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/sendalert.md b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/sendalert.md index b99418894..19ec2ead1 100644 --- a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/sendalert.md +++ b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/sendalert.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/statusfromlevel.md b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/statusfromlevel.md index 5b7f4f897..5abd913ff 100644 --- a/content/flux/v0/stdlib/contrib/rhajek/bigpanda/statusfromlevel.md +++ b/content/flux/v0/stdlib/contrib/rhajek/bigpanda/statusfromlevel.md @@ -36,7 +36,9 @@ BigPanda accepts one of ok, warning, or critical,. (level: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/opsgenie/endpoint.md b/content/flux/v0/stdlib/contrib/sranka/opsgenie/endpoint.md index b5de022b5..1db2355a7 100644 --- a/content/flux/v0/stdlib/contrib/sranka/opsgenie/endpoint.md +++ b/content/flux/v0/stdlib/contrib/sranka/opsgenie/endpoint.md @@ -75,7 +75,9 @@ For more information, see `opsgenie.sendAlert`. ) => (<-tables: stream[A]) => stream[{A with _sent: string}] where D: Stringable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/opsgenie/responderstojson.md b/content/flux/v0/stdlib/contrib/sranka/opsgenie/responderstojson.md index 90b7cd312..1c36512fd 100644 --- a/content/flux/v0/stdlib/contrib/sranka/opsgenie/responderstojson.md +++ b/content/flux/v0/stdlib/contrib/sranka/opsgenie/responderstojson.md @@ -38,7 +38,9 @@ to a string-encoded JSON array that can be embedded in an alert message. (v: [string]) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/opsgenie/sendalert.md b/content/flux/v0/stdlib/contrib/sranka/opsgenie/sendalert.md index 940bbe0d8..dc1b20eea 100644 --- a/content/flux/v0/stdlib/contrib/sranka/opsgenie/sendalert.md +++ b/content/flux/v0/stdlib/contrib/sranka/opsgenie/sendalert.md @@ -50,7 +50,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int where B: Stringable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/sensu/endpoint.md b/content/flux/v0/stdlib/contrib/sranka/sensu/endpoint.md index 946d95581..293ce682f 100644 --- a/content/flux/v0/stdlib/contrib/sranka/sensu/endpoint.md +++ b/content/flux/v0/stdlib/contrib/sranka/sensu/endpoint.md @@ -62,7 +62,9 @@ For more information, see `sensu.event()` parameters. ) => (<-tables: stream[B]) => stream[{B with _sent: string}] where D: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/sensu/event.md b/content/flux/v0/stdlib/contrib/sranka/sensu/event.md index 8e40e5d48..bd453f7c7 100644 --- a/content/flux/v0/stdlib/contrib/sranka/sensu/event.md +++ b/content/flux/v0/stdlib/contrib/sranka/sensu/event.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int where C: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/sensu/tosensuname.md b/content/flux/v0/stdlib/contrib/sranka/sensu/tosensuname.md index bb958653c..6015c0d83 100644 --- a/content/flux/v0/stdlib/contrib/sranka/sensu/tosensuname.md +++ b/content/flux/v0/stdlib/contrib/sranka/sensu/tosensuname.md @@ -38,7 +38,9 @@ by replacing non-alphanumeric characters (`[a-zA-Z0-9_.-]`) with underscores (`_ (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/teams/endpoint.md b/content/flux/v0/stdlib/contrib/sranka/teams/endpoint.md index 6950fa1ff..4e6f999b9 100644 --- a/content/flux/v0/stdlib/contrib/sranka/teams/endpoint.md +++ b/content/flux/v0/stdlib/contrib/sranka/teams/endpoint.md @@ -54,7 +54,9 @@ For more information, see `teams.message` parameters. ) => (<-tables: stream[A]) => stream[{A with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/teams/message.md b/content/flux/v0/stdlib/contrib/sranka/teams/message.md index d46a001dd..7fc4bcbe8 100644 --- a/content/flux/v0/stdlib/contrib/sranka/teams/message.md +++ b/content/flux/v0/stdlib/contrib/sranka/teams/message.md @@ -39,7 +39,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (text: string, title: A, url: string, ?summary: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/telegram/endpoint.md b/content/flux/v0/stdlib/contrib/sranka/telegram/endpoint.md index ff48972d9..6fec816fa 100644 --- a/content/flux/v0/stdlib/contrib/sranka/telegram/endpoint.md +++ b/content/flux/v0/stdlib/contrib/sranka/telegram/endpoint.md @@ -60,7 +60,9 @@ See `telegram.message` parameters for more information. ) => (<-tables: stream[C]) => stream[{C with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/telegram/message.md b/content/flux/v0/stdlib/contrib/sranka/telegram/message.md index 2728adf0a..7c63a7498 100644 --- a/content/flux/v0/stdlib/contrib/sranka/telegram/message.md +++ b/content/flux/v0/stdlib/contrib/sranka/telegram/message.md @@ -47,7 +47,9 @@ using the [`sendMessage`](https://core.telegram.org/bots/api#sendmessage) method ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/webexteams/endpoint.md b/content/flux/v0/stdlib/contrib/sranka/webexteams/endpoint.md index 6fa2ba66e..8ae77a531 100644 --- a/content/flux/v0/stdlib/contrib/sranka/webexteams/endpoint.md +++ b/content/flux/v0/stdlib/contrib/sranka/webexteams/endpoint.md @@ -55,7 +55,9 @@ For more information, see `webexteams.message` parameters. ) => (<-tables: stream[A]) => stream[{A with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/sranka/webexteams/message.md b/content/flux/v0/stdlib/contrib/sranka/webexteams/message.md index 0542c1738..8514b21fd 100644 --- a/content/flux/v0/stdlib/contrib/sranka/webexteams/message.md +++ b/content/flux/v0/stdlib/contrib/sranka/webexteams/message.md @@ -45,7 +45,9 @@ using the [Webex messages API](https://developer.webex.com/docs/api/v1/messages/ ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/contrib/tomhollingworth/events/duration.md b/content/flux/v0/stdlib/contrib/tomhollingworth/events/duration.md index 594b89b1e..d5b6e4c39 100644 --- a/content/flux/v0/stdlib/contrib/tomhollingworth/events/duration.md +++ b/content/flux/v0/stdlib/contrib/tomhollingworth/events/duration.md @@ -57,7 +57,9 @@ See the example [below](#compared-to-similar-functions). ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/csv/from.md b/content/flux/v0/stdlib/csv/from.md index af2a0e7ca..9b5cca19f 100644 --- a/content/flux/v0/stdlib/csv/from.md +++ b/content/flux/v0/stdlib/csv/from.md @@ -39,7 +39,9 @@ returns a stream of tables. (?csv: string, ?file: string, ?mode: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/add.md b/content/flux/v0/stdlib/date/add.md index 7dabd8f8a..d23256ef4 100644 --- a/content/flux/v0/stdlib/date/add.md +++ b/content/flux/v0/stdlib/date/add.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (d: duration, to: A, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/boundaries/friday.md b/content/flux/v0/stdlib/date/boundaries/friday.md index 3fb33b7b3..74ef321ba 100644 --- a/content/flux/v0/stdlib/date/boundaries/friday.md +++ b/content/flux/v0/stdlib/date/boundaries/friday.md @@ -38,7 +38,9 @@ Last Friday is relative to `now()`. If today is Friday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/monday.md b/content/flux/v0/stdlib/date/boundaries/monday.md index 46c082546..00e1c69ed 100644 --- a/content/flux/v0/stdlib/date/boundaries/monday.md +++ b/content/flux/v0/stdlib/date/boundaries/monday.md @@ -40,7 +40,9 @@ Last Monday is relative to `now()`. If today is Monday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/month.md b/content/flux/v0/stdlib/date/boundaries/month.md index 7ffa233b1..165bcdf41 100644 --- a/content/flux/v0/stdlib/date/boundaries/month.md +++ b/content/flux/v0/stdlib/date/boundaries/month.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?month_offset: int) => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/boundaries/saturday.md b/content/flux/v0/stdlib/date/boundaries/saturday.md index 0615db47d..2881dc278 100644 --- a/content/flux/v0/stdlib/date/boundaries/saturday.md +++ b/content/flux/v0/stdlib/date/boundaries/saturday.md @@ -38,7 +38,9 @@ Last Saturday is relative to `now()`. If today is Saturday, the function returns () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/sunday.md b/content/flux/v0/stdlib/date/boundaries/sunday.md index cd751f5a6..6ee6efc95 100644 --- a/content/flux/v0/stdlib/date/boundaries/sunday.md +++ b/content/flux/v0/stdlib/date/boundaries/sunday.md @@ -38,7 +38,9 @@ Last Sunday is relative to `now()`. If today is Sunday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/thursday.md b/content/flux/v0/stdlib/date/boundaries/thursday.md index 405e5480b..b13778f2a 100644 --- a/content/flux/v0/stdlib/date/boundaries/thursday.md +++ b/content/flux/v0/stdlib/date/boundaries/thursday.md @@ -38,7 +38,9 @@ Last Thursday is relative to `now()`. If today is Thursday, the function returns () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/tuesday.md b/content/flux/v0/stdlib/date/boundaries/tuesday.md index 588302701..0915510ea 100644 --- a/content/flux/v0/stdlib/date/boundaries/tuesday.md +++ b/content/flux/v0/stdlib/date/boundaries/tuesday.md @@ -38,7 +38,9 @@ Last Tuesday is relative to `now()`. If today is Tuesday, the function returns b () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/wednesday.md b/content/flux/v0/stdlib/date/boundaries/wednesday.md index bfcacef77..e67394644 100644 --- a/content/flux/v0/stdlib/date/boundaries/wednesday.md +++ b/content/flux/v0/stdlib/date/boundaries/wednesday.md @@ -38,7 +38,9 @@ Last Wednesday is relative to `now()`. If today is Wednesday, the function retur () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/boundaries/week.md b/content/flux/v0/stdlib/date/boundaries/week.md index 17d653c2f..499544155 100644 --- a/content/flux/v0/stdlib/date/boundaries/week.md +++ b/content/flux/v0/stdlib/date/boundaries/week.md @@ -40,7 +40,9 @@ By default, weeks start on Monday. (?start_sunday: bool, ?week_offset: int) => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/boundaries/yesterday.md b/content/flux/v0/stdlib/date/boundaries/yesterday.md index 4b8f8b9b4..7f8318504 100644 --- a/content/flux/v0/stdlib/date/boundaries/yesterday.md +++ b/content/flux/v0/stdlib/date/boundaries/yesterday.md @@ -39,7 +39,9 @@ Yesterday is relative to `now()`. () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/date/hour.md b/content/flux/v0/stdlib/date/hour.md index a92f4a1e6..d2341d416 100644 --- a/content/flux/v0/stdlib/date/hour.md +++ b/content/flux/v0/stdlib/date/hour.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/microsecond.md b/content/flux/v0/stdlib/date/microsecond.md index dbe97ad34..f0fb84205 100644 --- a/content/flux/v0/stdlib/date/microsecond.md +++ b/content/flux/v0/stdlib/date/microsecond.md @@ -38,7 +38,9 @@ Results range `from [0-999999]`. (t: A) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/millisecond.md b/content/flux/v0/stdlib/date/millisecond.md index 8a303d6f8..14643738e 100644 --- a/content/flux/v0/stdlib/date/millisecond.md +++ b/content/flux/v0/stdlib/date/millisecond.md @@ -38,7 +38,9 @@ Results range from `[0-999]`. (t: A) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/minute.md b/content/flux/v0/stdlib/date/minute.md index 392a2bef8..18f48121a 100644 --- a/content/flux/v0/stdlib/date/minute.md +++ b/content/flux/v0/stdlib/date/minute.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/month.md b/content/flux/v0/stdlib/date/month.md index 2859019ae..af16f49f9 100644 --- a/content/flux/v0/stdlib/date/month.md +++ b/content/flux/v0/stdlib/date/month.md @@ -49,7 +49,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/monthday.md b/content/flux/v0/stdlib/date/monthday.md index af1286774..33ddc97d0 100644 --- a/content/flux/v0/stdlib/date/monthday.md +++ b/content/flux/v0/stdlib/date/monthday.md @@ -38,7 +38,9 @@ Results range from `[1 - 31]`. (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/nanosecond.md b/content/flux/v0/stdlib/date/nanosecond.md index 0fb51d2d1..2b93f33b4 100644 --- a/content/flux/v0/stdlib/date/nanosecond.md +++ b/content/flux/v0/stdlib/date/nanosecond.md @@ -38,7 +38,9 @@ Results range from `[0-999999999]`. (t: A) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/quarter.md b/content/flux/v0/stdlib/date/quarter.md index aded96bfa..13ce0f6ff 100644 --- a/content/flux/v0/stdlib/date/quarter.md +++ b/content/flux/v0/stdlib/date/quarter.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/scale.md b/content/flux/v0/stdlib/date/scale.md index ffc3f7f22..2567e19d5 100644 --- a/content/flux/v0/stdlib/date/scale.md +++ b/content/flux/v0/stdlib/date/scale.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (d: duration, n: int) => duration ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/second.md b/content/flux/v0/stdlib/date/second.md index d420dd0e7..645115226 100644 --- a/content/flux/v0/stdlib/date/second.md +++ b/content/flux/v0/stdlib/date/second.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/sub.md b/content/flux/v0/stdlib/date/sub.md index c403b32a8..ea8e07a38 100644 --- a/content/flux/v0/stdlib/date/sub.md +++ b/content/flux/v0/stdlib/date/sub.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (d: duration, from: A, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/time.md b/content/flux/v0/stdlib/date/time.md index eb619b676..3c8fada67 100644 --- a/content/flux/v0/stdlib/date/time.md +++ b/content/flux/v0/stdlib/date/time.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/truncate.md b/content/flux/v0/stdlib/date/truncate.md index 82f9459b3..afe2aa88f 100644 --- a/content/flux/v0/stdlib/date/truncate.md +++ b/content/flux/v0/stdlib/date/truncate.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, unit: duration, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/week.md b/content/flux/v0/stdlib/date/week.md index 9d7ea0fe8..e67d5f6ad 100644 --- a/content/flux/v0/stdlib/date/week.md +++ b/content/flux/v0/stdlib/date/week.md @@ -38,7 +38,9 @@ Results range from `[1 - 53]`. (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/weekday.md b/content/flux/v0/stdlib/date/weekday.md index 5ea9a6cca..aea2a5406 100644 --- a/content/flux/v0/stdlib/date/weekday.md +++ b/content/flux/v0/stdlib/date/weekday.md @@ -46,7 +46,9 @@ Results range from `[0 - 6]`. (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/year.md b/content/flux/v0/stdlib/date/year.md index bb8c3b52d..115d080d0 100644 --- a/content/flux/v0/stdlib/date/year.md +++ b/content/flux/v0/stdlib/date/year.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/date/yearday.md b/content/flux/v0/stdlib/date/yearday.md index d0e8bfd9e..64add51dd 100644 --- a/content/flux/v0/stdlib/date/yearday.md +++ b/content/flux/v0/stdlib/date/yearday.md @@ -38,7 +38,9 @@ Results can include leap days and range from `[1 - 366]`. (t: A, ?location: {zone: string, offset: duration}) => int where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/dict/fromlist.md b/content/flux/v0/stdlib/dict/fromlist.md index 9728c9861..09963c5c2 100644 --- a/content/flux/v0/stdlib/dict/fromlist.md +++ b/content/flux/v0/stdlib/dict/fromlist.md @@ -38,7 +38,9 @@ properties. (pairs: [{value: B, key: A}]) => [A:B] where A: Comparable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/dict/get.md b/content/flux/v0/stdlib/dict/get.md index a2583c0a9..a18cabe30 100644 --- a/content/flux/v0/stdlib/dict/get.md +++ b/content/flux/v0/stdlib/dict/get.md @@ -38,7 +38,9 @@ if the key does not exist. (default: A, dict: [B:A], key: B) => A where B: Comparable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/dict/insert.md b/content/flux/v0/stdlib/dict/insert.md index 2d385eb4f..b677a4983 100644 --- a/content/flux/v0/stdlib/dict/insert.md +++ b/content/flux/v0/stdlib/dict/insert.md @@ -39,7 +39,9 @@ the existing value. (dict: [A:B], key: A, value: B) => [A:B] where A: Comparable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/dict/remove.md b/content/flux/v0/stdlib/dict/remove.md index 7a36264dc..e113a99f8 100644 --- a/content/flux/v0/stdlib/dict/remove.md +++ b/content/flux/v0/stdlib/dict/remove.md @@ -38,7 +38,9 @@ dictionary. (dict: [A:B], key: A) => [A:B] where A: Comparable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/addduration.md b/content/flux/v0/stdlib/experimental/addduration.md index 4c309b9a2..170c6b643 100644 --- a/content/flux/v0/stdlib/experimental/addduration.md +++ b/content/flux/v0/stdlib/experimental/addduration.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (d: duration, to: A, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/aggregate/rate.md b/content/flux/v0/stdlib/experimental/aggregate/rate.md index a1b4a80b5..c7aef4aa9 100644 --- a/content/flux/v0/stdlib/experimental/aggregate/rate.md +++ b/content/flux/v0/stdlib/experimental/aggregate/rate.md @@ -45,7 +45,9 @@ and should only be used with [counters](/flux/v0/prometheus/metric-types/counter (<-tables: stream[A], every: duration, ?groupColumns: [string], ?unit: duration) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/aligntime.md b/content/flux/v0/stdlib/experimental/aligntime.md index d959bb0b1..b8a4a6344 100644 --- a/content/flux/v0/stdlib/experimental/aligntime.md +++ b/content/flux/v0/stdlib/experimental/aligntime.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[B], ?alignTo: A) => stream[C] where B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/concat.md b/content/flux/v0/stdlib/experimental/array/concat.md index 0deb34f16..040c96c55 100644 --- a/content/flux/v0/stdlib/experimental/array/concat.md +++ b/content/flux/v0/stdlib/experimental/array/concat.md @@ -45,7 +45,9 @@ Neither input array is mutated and a new array is returned. (<-arr: [A], v: [A]) => [A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/filter.md b/content/flux/v0/stdlib/experimental/array/filter.md index 6ae7a8433..633a64a27 100644 --- a/content/flux/v0/stdlib/experimental/array/filter.md +++ b/content/flux/v0/stdlib/experimental/array/filter.md @@ -45,7 +45,9 @@ Experimental `array.filter()` is deprecated in favor of (<-arr: [A], fn: (x: A) => bool) => [A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/from.md b/content/flux/v0/stdlib/experimental/array/from.md index a1b8efc73..1570bb353 100644 --- a/content/flux/v0/stdlib/experimental/array/from.md +++ b/content/flux/v0/stdlib/experimental/array/from.md @@ -46,7 +46,9 @@ records must have the same keys and data types. (<-rows: [A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/map.md b/content/flux/v0/stdlib/experimental/array/map.md index 540bfff6a..ecaf72474 100644 --- a/content/flux/v0/stdlib/experimental/array/map.md +++ b/content/flux/v0/stdlib/experimental/array/map.md @@ -45,7 +45,9 @@ Experimental `array.map()` is deprecated in favor of (<-arr: [A], fn: (x: A) => B) => [B] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/tobool.md b/content/flux/v0/stdlib/experimental/array/tobool.md index f4ae9ffb9..4fd05ab9f 100644 --- a/content/flux/v0/stdlib/experimental/array/tobool.md +++ b/content/flux/v0/stdlib/experimental/array/tobool.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [bool] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/toduration.md b/content/flux/v0/stdlib/experimental/array/toduration.md index 608d1f4f1..a76c2c513 100644 --- a/content/flux/v0/stdlib/experimental/array/toduration.md +++ b/content/flux/v0/stdlib/experimental/array/toduration.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [duration] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/tofloat.md b/content/flux/v0/stdlib/experimental/array/tofloat.md index e3d61eac8..4669f04c2 100644 --- a/content/flux/v0/stdlib/experimental/array/tofloat.md +++ b/content/flux/v0/stdlib/experimental/array/tofloat.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [float] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/toint.md b/content/flux/v0/stdlib/experimental/array/toint.md index 0e40ea390..dfd121e03 100644 --- a/content/flux/v0/stdlib/experimental/array/toint.md +++ b/content/flux/v0/stdlib/experimental/array/toint.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [int] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/tostring.md b/content/flux/v0/stdlib/experimental/array/tostring.md index 46fa93b03..60bfaa884 100644 --- a/content/flux/v0/stdlib/experimental/array/tostring.md +++ b/content/flux/v0/stdlib/experimental/array/tostring.md @@ -45,7 +45,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/totime.md b/content/flux/v0/stdlib/experimental/array/totime.md index 928686ae4..62117f4fd 100644 --- a/content/flux/v0/stdlib/experimental/array/totime.md +++ b/content/flux/v0/stdlib/experimental/array/totime.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [time] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/array/touint.md b/content/flux/v0/stdlib/experimental/array/touint.md index 296f3bc8d..578891c8d 100644 --- a/content/flux/v0/stdlib/experimental/array/touint.md +++ b/content/flux/v0/stdlib/experimental/array/touint.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => [uint] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bigtable/from.md b/content/flux/v0/stdlib/experimental/bigtable/from.md index 3bd524fb5..cce58d66d 100644 --- a/content/flux/v0/stdlib/experimental/bigtable/from.md +++ b/content/flux/v0/stdlib/experimental/bigtable/from.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (instance: string, project: string, table: string, token: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/sand.md b/content/flux/v0/stdlib/experimental/bitwise/sand.md index af04c1624..c5d10480f 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/sand.md +++ b/content/flux/v0/stdlib/experimental/bitwise/sand.md @@ -40,7 +40,9 @@ Experimental `bitwise.sand` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/sclear.md b/content/flux/v0/stdlib/experimental/bitwise/sclear.md index 87792d4dd..608e1b688 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/sclear.md +++ b/content/flux/v0/stdlib/experimental/bitwise/sclear.md @@ -42,7 +42,9 @@ Experimental `bitwise.sclear` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/slshift.md b/content/flux/v0/stdlib/experimental/bitwise/slshift.md index 22e03866d..6cfd811a5 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/slshift.md +++ b/content/flux/v0/stdlib/experimental/bitwise/slshift.md @@ -42,7 +42,9 @@ Experimental `bitwise.slshift` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/snot.md b/content/flux/v0/stdlib/experimental/bitwise/snot.md index b632ddce0..73e690373 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/snot.md +++ b/content/flux/v0/stdlib/experimental/bitwise/snot.md @@ -40,7 +40,9 @@ Experimental `bitwise.snot` is deprecated in favor of (a: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/sor.md b/content/flux/v0/stdlib/experimental/bitwise/sor.md index 477a3961f..5f255bfba 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/sor.md +++ b/content/flux/v0/stdlib/experimental/bitwise/sor.md @@ -40,7 +40,9 @@ Experimental `bitwise.sor` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/srshift.md b/content/flux/v0/stdlib/experimental/bitwise/srshift.md index acb35ddd4..d2cf4a9b1 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/srshift.md +++ b/content/flux/v0/stdlib/experimental/bitwise/srshift.md @@ -42,7 +42,9 @@ Experimental `bitwise.srshift` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/sxor.md b/content/flux/v0/stdlib/experimental/bitwise/sxor.md index aa4fe0568..59e003469 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/sxor.md +++ b/content/flux/v0/stdlib/experimental/bitwise/sxor.md @@ -40,7 +40,9 @@ Experimental `bitwise.sxor` is deprecated in favor of (a: int, b: int) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/uand.md b/content/flux/v0/stdlib/experimental/bitwise/uand.md index 1067085d1..505d422c1 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/uand.md +++ b/content/flux/v0/stdlib/experimental/bitwise/uand.md @@ -40,7 +40,9 @@ Experimental `bitwise.uand` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/uclear.md b/content/flux/v0/stdlib/experimental/bitwise/uclear.md index f803df3ae..5f57b4044 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/uclear.md +++ b/content/flux/v0/stdlib/experimental/bitwise/uclear.md @@ -40,7 +40,9 @@ Experimental `bitwise.uclear` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/ulshift.md b/content/flux/v0/stdlib/experimental/bitwise/ulshift.md index 969b1d9d7..cfd49b060 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/ulshift.md +++ b/content/flux/v0/stdlib/experimental/bitwise/ulshift.md @@ -42,7 +42,9 @@ Experimental `bitwise.ulshift` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/unot.md b/content/flux/v0/stdlib/experimental/bitwise/unot.md index 2795a72a2..5cfaf90eb 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/unot.md +++ b/content/flux/v0/stdlib/experimental/bitwise/unot.md @@ -40,7 +40,9 @@ Experimental `bitwise.unot` is deprecated in favor of (a: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/uor.md b/content/flux/v0/stdlib/experimental/bitwise/uor.md index 7cc6361bb..3e98f6255 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/uor.md +++ b/content/flux/v0/stdlib/experimental/bitwise/uor.md @@ -40,7 +40,9 @@ Experimental `bitwise.uor` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/urshift.md b/content/flux/v0/stdlib/experimental/bitwise/urshift.md index 9c4df5720..0d52f63b0 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/urshift.md +++ b/content/flux/v0/stdlib/experimental/bitwise/urshift.md @@ -42,7 +42,9 @@ Experimental `bitwise.urshift` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/bitwise/uxor.md b/content/flux/v0/stdlib/experimental/bitwise/uxor.md index b66bf8637..0bd7da993 100644 --- a/content/flux/v0/stdlib/experimental/bitwise/uxor.md +++ b/content/flux/v0/stdlib/experimental/bitwise/uxor.md @@ -40,7 +40,9 @@ Experimental `bitwise.uxor` is deprecated in favor of (a: uint, b: uint) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/catch.md b/content/flux/v0/stdlib/experimental/catch.md index 6095e4051..29ba98738 100644 --- a/content/flux/v0/stdlib/experimental/catch.md +++ b/content/flux/v0/stdlib/experimental/catch.md @@ -40,7 +40,9 @@ If the function does not error the returned value is made into a string and retu (fn: () => A) => {value: A, msg: string, code: uint} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/chain.md b/content/flux/v0/stdlib/experimental/chain.md index 82429a143..b414e8e7e 100644 --- a/content/flux/v0/stdlib/experimental/chain.md +++ b/content/flux/v0/stdlib/experimental/chain.md @@ -51,7 +51,9 @@ has on the results of the first query are met. (first: stream[A], second: stream[B]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/count.md b/content/flux/v0/stdlib/experimental/count.md index 04836a292..d874fc43f 100644 --- a/content/flux/v0/stdlib/experimental/count.md +++ b/content/flux/v0/stdlib/experimental/count.md @@ -49,7 +49,9 @@ aggregateWindow(createEmpty: true) (<-tables: stream[{A with _value: B}]) => stream[{A with _value: int}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/csv/from.md b/content/flux/v0/stdlib/experimental/csv/from.md index 5a2e6e0f1..e2cf0fbf5 100644 --- a/content/flux/v0/stdlib/experimental/csv/from.md +++ b/content/flux/v0/stdlib/experimental/csv/from.md @@ -42,7 +42,9 @@ Experimental `csv.from()` is deprecated in favor of a combination of [`requests. (url: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/friday.md b/content/flux/v0/stdlib/experimental/date/boundaries/friday.md index 03722f303..65ed3e30c 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/friday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/friday.md @@ -38,7 +38,9 @@ Last Friday is relative to `now()`. If today is Friday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/monday.md b/content/flux/v0/stdlib/experimental/date/boundaries/monday.md index 53f99f451..f054ec6bc 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/monday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/monday.md @@ -40,7 +40,9 @@ Last Monday is relative to `now()`. If today is Monday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/month.md b/content/flux/v0/stdlib/experimental/date/boundaries/month.md index 5adf9f437..3bf89bc88 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/month.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/month.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?month_offset: int) => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/saturday.md b/content/flux/v0/stdlib/experimental/date/boundaries/saturday.md index 60b725ef7..76627ed17 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/saturday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/saturday.md @@ -38,7 +38,9 @@ Last Saturday is relative to `now()`. If today is Saturday, the function returns () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/sunday.md b/content/flux/v0/stdlib/experimental/date/boundaries/sunday.md index bec67296a..08aa40e41 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/sunday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/sunday.md @@ -38,7 +38,9 @@ Last Sunday is relative to `now()`. If today is Sunday, the function returns bou () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/thursday.md b/content/flux/v0/stdlib/experimental/date/boundaries/thursday.md index bb09a4f56..266c1dfa4 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/thursday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/thursday.md @@ -38,7 +38,9 @@ Last Thursday is relative to `now()`. If today is Thursday, the function returns () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/tuesday.md b/content/flux/v0/stdlib/experimental/date/boundaries/tuesday.md index c4dd8e327..af0d12a98 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/tuesday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/tuesday.md @@ -38,7 +38,9 @@ Last Tuesday is relative to `now()`. If today is Tuesday, the function returns b () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/wednesday.md b/content/flux/v0/stdlib/experimental/date/boundaries/wednesday.md index 106fda4dd..cba609321 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/wednesday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/wednesday.md @@ -38,7 +38,9 @@ Last Wednesday is relative to `now()`. If today is Wednesday, the function retur () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/week.md b/content/flux/v0/stdlib/experimental/date/boundaries/week.md index 29826057b..8af4a0d6c 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/week.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/week.md @@ -40,7 +40,9 @@ By default, weeks start on Monday. (?start_sunday: bool, ?week_offset: int) => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/date/boundaries/yesterday.md b/content/flux/v0/stdlib/experimental/date/boundaries/yesterday.md index 2fa9446bd..0783c2258 100644 --- a/content/flux/v0/stdlib/experimental/date/boundaries/yesterday.md +++ b/content/flux/v0/stdlib/experimental/date/boundaries/yesterday.md @@ -38,7 +38,9 @@ Yesterday is relative to `now()`. () => {stop: time, start: time} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/experimental/diff.md b/content/flux/v0/stdlib/experimental/diff.md index 7bef94a80..45697ea32 100644 --- a/content/flux/v0/stdlib/experimental/diff.md +++ b/content/flux/v0/stdlib/experimental/diff.md @@ -45,7 +45,9 @@ The only guarantees are those mentioned above. (<-got: stream[A], want: stream[A]) => stream[{A with _diff: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/distinct.md b/content/flux/v0/stdlib/experimental/distinct.md index cb34ceca6..324d38980 100644 --- a/content/flux/v0/stdlib/experimental/distinct.md +++ b/content/flux/v0/stdlib/experimental/distinct.md @@ -42,7 +42,9 @@ drops empty tables. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/dynamic/asarray.md b/content/flux/v0/stdlib/experimental/dynamic/asarray.md index 78fb61280..f2b04d326 100644 --- a/content/flux/v0/stdlib/experimental/dynamic/asarray.md +++ b/content/flux/v0/stdlib/experimental/dynamic/asarray.md @@ -37,7 +37,9 @@ The dynamic input value must be an array. If it is not an array, `dynamic.asArra (<-v: dynamic) => [dynamic] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/dynamic/dynamic.md b/content/flux/v0/stdlib/experimental/dynamic/dynamic.md index 1ebffd78e..8033e43b6 100644 --- a/content/flux/v0/stdlib/experimental/dynamic/dynamic.md +++ b/content/flux/v0/stdlib/experimental/dynamic/dynamic.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => dynamic ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/dynamic/istype.md b/content/flux/v0/stdlib/experimental/dynamic/istype.md index 9a41c6e80..60044271b 100644 --- a/content/flux/v0/stdlib/experimental/dynamic/istype.md +++ b/content/flux/v0/stdlib/experimental/dynamic/istype.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (type: string, v: dynamic) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/dynamic/jsonencode.md b/content/flux/v0/stdlib/experimental/dynamic/jsonencode.md index c78725a7b..03e883d3b 100644 --- a/content/flux/v0/stdlib/experimental/dynamic/jsonencode.md +++ b/content/flux/v0/stdlib/experimental/dynamic/jsonencode.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: dynamic) => bytes ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/dynamic/jsonparse.md b/content/flux/v0/stdlib/experimental/dynamic/jsonparse.md index d7d22397d..a776cb339 100644 --- a/content/flux/v0/stdlib/experimental/dynamic/jsonparse.md +++ b/content/flux/v0/stdlib/experimental/dynamic/jsonparse.md @@ -39,7 +39,9 @@ a statically typed value with `dynamic.asArray()` or casting functions in the `d (data: bytes) => dynamic ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/fill.md b/content/flux/v0/stdlib/experimental/fill.md index a8363847d..40b4439b1 100644 --- a/content/flux/v0/stdlib/experimental/fill.md +++ b/content/flux/v0/stdlib/experimental/fill.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{B with _value: A}], ?usePrevious: bool, ?value: A) => stream[{B with _value: A}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/first.md b/content/flux/v0/stdlib/experimental/first.md index 71383d159..1d386059e 100644 --- a/content/flux/v0/stdlib/experimental/first.md +++ b/content/flux/v0/stdlib/experimental/first.md @@ -40,7 +40,9 @@ for each input table. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/astracks.md b/content/flux/v0/stdlib/experimental/geo/astracks.md index 7ac8fe571..1419334db 100644 --- a/content/flux/v0/stdlib/experimental/geo/astracks.md +++ b/content/flux/v0/stdlib/experimental/geo/astracks.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?groupBy: [string], ?orderBy: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/filterrows.md b/content/flux/v0/stdlib/experimental/geo/filterrows.md index 0c7b476c3..b70d90860 100644 --- a/content/flux/v0/stdlib/experimental/geo/filterrows.md +++ b/content/flux/v0/stdlib/experimental/geo/filterrows.md @@ -46,7 +46,9 @@ Input data must include an `s2_cell_id` column that is **part of the group key** ) => stream[{B with s2_cell_id: string, lon: D, lat: C}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/getgrid.md b/content/flux/v0/stdlib/experimental/geo/getgrid.md index 63b946554..761f20b87 100644 --- a/content/flux/v0/stdlib/experimental/geo/getgrid.md +++ b/content/flux/v0/stdlib/experimental/geo/getgrid.md @@ -44,7 +44,9 @@ so results include S2 grid cells fully and partially covered by the region. ) => {set: [string], level: int} where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/getlevel.md b/content/flux/v0/stdlib/experimental/geo/getlevel.md index 7a672a0a1..ca2692579 100644 --- a/content/flux/v0/stdlib/experimental/geo/getlevel.md +++ b/content/flux/v0/stdlib/experimental/geo/getlevel.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (token: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/gridfilter.md b/content/flux/v0/stdlib/experimental/geo/gridfilter.md index 157e81e7b..7f32bea7f 100644 --- a/content/flux/v0/stdlib/experimental/geo/gridfilter.md +++ b/content/flux/v0/stdlib/experimental/geo/gridfilter.md @@ -51,7 +51,9 @@ Use `geo.toRows()` and `geo.strictFilter()` after `geo.gridFilter()` to precisel ) => stream[{B with s2_cell_id: string}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/groupbyarea.md b/content/flux/v0/stdlib/experimental/geo/groupbyarea.md index a6d87b902..9ff3b9989 100644 --- a/content/flux/v0/stdlib/experimental/geo/groupbyarea.md +++ b/content/flux/v0/stdlib/experimental/geo/groupbyarea.md @@ -45,7 +45,9 @@ Results are grouped by `newColumn`. ) => stream[B] where B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/s2cellidtoken.md b/content/flux/v0/stdlib/experimental/geo/s2cellidtoken.md index c329bff6a..566a80c8f 100644 --- a/content/flux/v0/stdlib/experimental/geo/s2cellidtoken.md +++ b/content/flux/v0/stdlib/experimental/geo/s2cellidtoken.md @@ -40,7 +40,9 @@ specified S2 cell level. (level: int, ?point: {lon: float, lat: float}, ?token: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/s2celllatlon.md b/content/flux/v0/stdlib/experimental/geo/s2celllatlon.md index fbd22e1c0..81c7c54d3 100644 --- a/content/flux/v0/stdlib/experimental/geo/s2celllatlon.md +++ b/content/flux/v0/stdlib/experimental/geo/s2celllatlon.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (token: string) => {lon: float, lat: float} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/shapedata.md b/content/flux/v0/stdlib/experimental/geo/shapedata.md index 9e89b1ab2..b6d9828ed 100644 --- a/content/flux/v0/stdlib/experimental/geo/shapedata.md +++ b/content/flux/v0/stdlib/experimental/geo/shapedata.md @@ -47,7 +47,9 @@ Use `geo.shapeData()` to ensure geotemporal data meets the requirements of the G ) => stream[{D with s2_cell_id: string, lon: float, lat: float}] where A: Equatable, B: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_contains.md b/content/flux/v0/stdlib/experimental/geo/st_contains.md index 1c3b5150f..9e9b83a5f 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_contains.md +++ b/content/flux/v0/stdlib/experimental/geo/st_contains.md @@ -40,7 +40,9 @@ specified GIS geometry. (geometry: A, region: B, ?units: {distance: string}) => bool where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_distance.md b/content/flux/v0/stdlib/experimental/geo/st_distance.md index ecf88ba7c..c473535a2 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_distance.md +++ b/content/flux/v0/stdlib/experimental/geo/st_distance.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (geometry: A, region: B, ?units: {distance: string}) => float where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_dwithin.md b/content/flux/v0/stdlib/experimental/geo/st_dwithin.md index 11e1f47ea..0d4979cf8 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_dwithin.md +++ b/content/flux/v0/stdlib/experimental/geo/st_dwithin.md @@ -40,7 +40,9 @@ the specified GIS geometry and returns `true` or `false`. (distance: A, geometry: B, region: C, ?units: {distance: string}) => bool where A: Comparable + Equatable, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_intersects.md b/content/flux/v0/stdlib/experimental/geo/st_intersects.md index 6b8dfa814..6a7ae4373 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_intersects.md +++ b/content/flux/v0/stdlib/experimental/geo/st_intersects.md @@ -40,7 +40,9 @@ specified region and returns `true` or `false`. (geometry: A, region: B, ?units: {distance: string}) => bool where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_length.md b/content/flux/v0/stdlib/experimental/geo/st_length.md index dde1359a8..16de12f07 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_length.md +++ b/content/flux/v0/stdlib/experimental/geo/st_length.md @@ -40,7 +40,9 @@ of the specified GIS geometry. (geometry: A, ?units: {distance: string}) => float where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/st_linestring.md b/content/flux/v0/stdlib/experimental/geo/st_linestring.md index a6cb6e59e..c06051b5a 100644 --- a/content/flux/v0/stdlib/experimental/geo/st_linestring.md +++ b/content/flux/v0/stdlib/experimental/geo/st_linestring.md @@ -41,7 +41,9 @@ the resulting linestring. (<-tables: stream[{A with lon: C, lat: B}]) => stream[D] where D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/stcontains.md b/content/flux/v0/stdlib/experimental/geo/stcontains.md index 6792fd786..8a335edca 100644 --- a/content/flux/v0/stdlib/experimental/geo/stcontains.md +++ b/content/flux/v0/stdlib/experimental/geo/stcontains.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (geometry: A, region: B, units: {distance: string}) => bool where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/stdistance.md b/content/flux/v0/stdlib/experimental/geo/stdistance.md index 98d72f00f..d89a13a88 100644 --- a/content/flux/v0/stdlib/experimental/geo/stdistance.md +++ b/content/flux/v0/stdlib/experimental/geo/stdistance.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (geometry: A, region: B, units: {distance: string}) => float where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/stlength.md b/content/flux/v0/stdlib/experimental/geo/stlength.md index df1a7ab13..9c849ceb6 100644 --- a/content/flux/v0/stdlib/experimental/geo/stlength.md +++ b/content/flux/v0/stdlib/experimental/geo/stlength.md @@ -40,7 +40,9 @@ of the specified GIS geometry. (geometry: A, units: {distance: string}) => float where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/strictfilter.md b/content/flux/v0/stdlib/experimental/geo/strictfilter.md index c7b82371c..3df03e816 100644 --- a/content/flux/v0/stdlib/experimental/geo/strictfilter.md +++ b/content/flux/v0/stdlib/experimental/geo/strictfilter.md @@ -39,7 +39,9 @@ Input rows must have `lat` and `lon` columns. (<-tables: stream[{B with lon: D, lat: C}], region: A) => stream[{B with lon: D, lat: C}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/torows.md b/content/flux/v0/stdlib/experimental/geo/torows.md index 1faa8fffe..59eafb088 100644 --- a/content/flux/v0/stdlib/experimental/geo/torows.md +++ b/content/flux/v0/stdlib/experimental/geo/torows.md @@ -39,7 +39,9 @@ Because most `geo` package transformation functions require rows to have (<-tables: stream[A]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/geo/totaldistance.md b/content/flux/v0/stdlib/experimental/geo/totaldistance.md index 68ca3f9b5..b4091d568 100644 --- a/content/flux/v0/stdlib/experimental/geo/totaldistance.md +++ b/content/flux/v0/stdlib/experimental/geo/totaldistance.md @@ -43,7 +43,9 @@ Use the `geo.units` option to specify the unit of distance to return (default is (<-tables: stream[{B with lon: float, lat: float}], ?outputColumn: A) => stream[C] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/group.md b/content/flux/v0/stdlib/experimental/group.md index 60d3f94ab..e293511fa 100644 --- a/content/flux/v0/stdlib/experimental/group.md +++ b/content/flux/v0/stdlib/experimental/group.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], columns: [string], mode: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/histogram.md b/content/flux/v0/stdlib/experimental/histogram.md index 59fe22717..b21d74d89 100644 --- a/content/flux/v0/stdlib/experimental/histogram.md +++ b/content/flux/v0/stdlib/experimental/histogram.md @@ -50,7 +50,9 @@ Bin counts are cumulative. (<-tables: stream[{A with _value: float}], bins: [float], ?normalize: bool) => stream[{A with le: float, _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/histogramquantile.md b/content/flux/v0/stdlib/experimental/histogramquantile.md index a63971288..a47e520a2 100644 --- a/content/flux/v0/stdlib/experimental/histogramquantile.md +++ b/content/flux/v0/stdlib/experimental/histogramquantile.md @@ -59,7 +59,9 @@ The function returns the value of the specified quantile from the histogram in t ) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/http/get.md b/content/flux/v0/stdlib/experimental/http/get.md index f052266af..7fb92be3e 100644 --- a/content/flux/v0/stdlib/experimental/http/get.md +++ b/content/flux/v0/stdlib/experimental/http/get.md @@ -49,7 +49,9 @@ Experimental `http.get()` is deprecated in favor of [`requests.get()`](/flux/v0/ (url: string, ?headers: A, ?timeout: duration) => {statusCode: int, headers: B, body: bytes} where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/http/requests/do.md b/content/flux/v0/stdlib/experimental/http/requests/do.md index e7bcc655d..759d958d8 100644 --- a/content/flux/v0/stdlib/experimental/http/requests/do.md +++ b/content/flux/v0/stdlib/experimental/http/requests/do.md @@ -54,7 +54,9 @@ The returned response contains the following properties: ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/http/requests/get.md b/content/flux/v0/stdlib/experimental/http/requests/get.md index 96592c3b1..3772b5790 100644 --- a/content/flux/v0/stdlib/experimental/http/requests/get.md +++ b/content/flux/v0/stdlib/experimental/http/requests/get.md @@ -46,7 +46,9 @@ Experimental `requests.get` is deprecated in favor of [`requests.get`](/flux/v0/ ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/http/requests/peek.md b/content/flux/v0/stdlib/experimental/http/requests/peek.md index 56b33590b..4ec0d13d8 100644 --- a/content/flux/v0/stdlib/experimental/http/requests/peek.md +++ b/content/flux/v0/stdlib/experimental/http/requests/peek.md @@ -51,7 +51,9 @@ and then use `array.from()` to construct a table from those values. ) => stream[{statusCode: E, headers: string, duration: int, body: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/http/requests/post.md b/content/flux/v0/stdlib/experimental/http/requests/post.md index 8d70f8d20..0fca1566c 100644 --- a/content/flux/v0/stdlib/experimental/http/requests/post.md +++ b/content/flux/v0/stdlib/experimental/http/requests/post.md @@ -46,7 +46,9 @@ Experimental `requests.post` is deprecated in favor of [`requests.post`](/flux/v ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/influxdb/api.md b/content/flux/v0/stdlib/experimental/influxdb/api.md index 9891039e5..782b4297a 100644 --- a/content/flux/v0/stdlib/experimental/influxdb/api.md +++ b/content/flux/v0/stdlib/experimental/influxdb/api.md @@ -56,7 +56,9 @@ Authorization permissions and limits apply to each request. ) => {statusCode: int, headers: [string:string], body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/integral.md b/content/flux/v0/stdlib/experimental/integral.md index 327488fbf..e0adce1f2 100644 --- a/content/flux/v0/stdlib/experimental/integral.md +++ b/content/flux/v0/stdlib/experimental/integral.md @@ -41,7 +41,9 @@ Input tables must have `_start`, _stop`, `_time`, and `_value` columns. (<-tables: stream[{A with _value: B, _time: time}], ?interpolate: string, ?unit: duration) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/iox/from.md b/content/flux/v0/stdlib/experimental/iox/from.md index fd4083904..4cc3d57ff 100644 --- a/content/flux/v0/stdlib/experimental/iox/from.md +++ b/content/flux/v0/stdlib/experimental/iox/from.md @@ -39,7 +39,9 @@ tag and field per time value. (bucket: string, measurement: string) => stream[{A with _time: time}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/iox/sql.md b/content/flux/v0/stdlib/experimental/iox/sql.md index 1b029e12d..11e64c0f1 100644 --- a/content/flux/v0/stdlib/experimental/iox/sql.md +++ b/content/flux/v0/stdlib/experimental/iox/sql.md @@ -38,7 +38,9 @@ This function creates a source that reads data from IOx. (bucket: string, query: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/iox/sqlinterval.md b/content/flux/v0/stdlib/experimental/iox/sqlinterval.md index 04f111892..9ba59250e 100644 --- a/content/flux/v0/stdlib/experimental/iox/sqlinterval.md +++ b/content/flux/v0/stdlib/experimental/iox/sqlinterval.md @@ -38,7 +38,9 @@ Duration values must be positive to work as a SQL interval string. (d: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/join.md b/content/flux/v0/stdlib/experimental/join.md index e7ad64bd9..eab1bc37b 100644 --- a/content/flux/v0/stdlib/experimental/join.md +++ b/content/flux/v0/stdlib/experimental/join.md @@ -50,7 +50,9 @@ group key before joining. (fn: (left: A, right: B) => C, left: stream[A], right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/json/parse.md b/content/flux/v0/stdlib/experimental/json/parse.md index 6a2be2f72..463f0adc4 100644 --- a/content/flux/v0/stdlib/experimental/json/parse.md +++ b/content/flux/v0/stdlib/experimental/json/parse.md @@ -45,7 +45,9 @@ JSON types are converted to Flux types as follows: (data: bytes) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/kaufmansama.md b/content/flux/v0/stdlib/experimental/kaufmansama.md index 54addacd5..93cde7cc0 100644 --- a/content/flux/v0/stdlib/experimental/kaufmansama.md +++ b/content/flux/v0/stdlib/experimental/kaufmansama.md @@ -41,7 +41,9 @@ account for market noise or volatility. (<-tables: stream[{A with _value: B}], n: int) => stream[{A with _value: float}] where B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/last.md b/content/flux/v0/stdlib/experimental/last.md index 8e3861374..28884d1a5 100644 --- a/content/flux/v0/stdlib/experimental/last.md +++ b/content/flux/v0/stdlib/experimental/last.md @@ -40,7 +40,9 @@ for each input table. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/max.md b/content/flux/v0/stdlib/experimental/max.md index 85024c658..5bf49de52 100644 --- a/content/flux/v0/stdlib/experimental/max.md +++ b/content/flux/v0/stdlib/experimental/max.md @@ -40,7 +40,9 @@ input table. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/mean.md b/content/flux/v0/stdlib/experimental/mean.md index ab63101d8..68242cec9 100644 --- a/content/flux/v0/stdlib/experimental/mean.md +++ b/content/flux/v0/stdlib/experimental/mean.md @@ -40,7 +40,9 @@ Output tables contain a single row the with the calculated mean in the `_value` (<-tables: stream[{A with _value: float}]) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/min.md b/content/flux/v0/stdlib/experimental/min.md index 1a5547034..e52914b86 100644 --- a/content/flux/v0/stdlib/experimental/min.md +++ b/content/flux/v0/stdlib/experimental/min.md @@ -40,7 +40,9 @@ input table. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/mode.md b/content/flux/v0/stdlib/experimental/mode.md index 720531f95..ad5507cc3 100644 --- a/content/flux/v0/stdlib/experimental/mode.md +++ b/content/flux/v0/stdlib/experimental/mode.md @@ -50,7 +50,9 @@ If there is no mode, it returns _null_. (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/mqtt/publish.md b/content/flux/v0/stdlib/experimental/mqtt/publish.md index 68ec8f36f..947770656 100644 --- a/content/flux/v0/stdlib/experimental/mqtt/publish.md +++ b/content/flux/v0/stdlib/experimental/mqtt/publish.md @@ -48,7 +48,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/mqtt/to.md b/content/flux/v0/stdlib/experimental/mqtt/to.md index 990bb4aff..e6bd028f3 100644 --- a/content/flux/v0/stdlib/experimental/mqtt/to.md +++ b/content/flux/v0/stdlib/experimental/mqtt/to.md @@ -51,7 +51,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/objectkeys.md b/content/flux/v0/stdlib/experimental/objectkeys.md index d5ce88bae..47d6363e2 100644 --- a/content/flux/v0/stdlib/experimental/objectkeys.md +++ b/content/flux/v0/stdlib/experimental/objectkeys.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (o: A) => [string] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/oee/apq.md b/content/flux/v0/stdlib/experimental/oee/apq.md index 70ef4f06e..5356ce198 100644 --- a/content/flux/v0/stdlib/experimental/oee/apq.md +++ b/content/flux/v0/stdlib/experimental/oee/apq.md @@ -71,7 +71,9 @@ For each input table, `oee.APQ` outputs a table with a single row that includes }] where C: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/oee/computeapq.md b/content/flux/v0/stdlib/experimental/oee/computeapq.md index f6a1d0e61..5c6767cb8 100644 --- a/content/flux/v0/stdlib/experimental/oee/computeapq.md +++ b/content/flux/v0/stdlib/experimental/oee/computeapq.md @@ -64,7 +64,9 @@ the following columns: }] where B: Record, D: Record, E: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/polyline/rdp.md b/content/flux/v0/stdlib/experimental/polyline/rdp.md index 4d598966a..c7ba09372 100644 --- a/content/flux/v0/stdlib/experimental/polyline/rdp.md +++ b/content/flux/v0/stdlib/experimental/polyline/rdp.md @@ -45,7 +45,9 @@ of line segments into visually indistinguishable curves with fewer points. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/preview.md b/content/flux/v0/stdlib/experimental/preview.md index 3e381360f..ccecbe471 100644 --- a/content/flux/v0/stdlib/experimental/preview.md +++ b/content/flux/v0/stdlib/experimental/preview.md @@ -39,7 +39,9 @@ that the engine sends them. (<-tables: stream[A], ?nrows: int, ?ntables: int) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/prometheus/histogramquantile.md b/content/flux/v0/stdlib/experimental/prometheus/histogramquantile.md index 5ef215c19..794264e72 100644 --- a/content/flux/v0/stdlib/experimental/prometheus/histogramquantile.md +++ b/content/flux/v0/stdlib/experimental/prometheus/histogramquantile.md @@ -39,7 +39,9 @@ InfluxDB scrapers available in InfluxDB OSS. (<-tables: stream[{B with le: D, _field: C}], quantile: float, ?metricVersion: A, ?onNonmonotonic: string) => stream[E] where A: Equatable, C: Equatable, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/prometheus/scrape.md b/content/flux/v0/stdlib/experimental/prometheus/scrape.md index 3a9c7fb2a..6f17ed10f 100644 --- a/content/flux/v0/stdlib/experimental/prometheus/scrape.md +++ b/content/flux/v0/stdlib/experimental/prometheus/scrape.md @@ -39,7 +39,9 @@ them as a stream of tables. (url: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/quantile.md b/content/flux/v0/stdlib/experimental/quantile.md index c84a466b4..62f044965 100644 --- a/content/flux/v0/stdlib/experimental/quantile.md +++ b/content/flux/v0/stdlib/experimental/quantile.md @@ -66,7 +66,9 @@ value that represents the specified quantile. ) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/query/filterfields.md b/content/flux/v0/stdlib/experimental/query/filterfields.md index 24d4e2968..0765937c5 100644 --- a/content/flux/v0/stdlib/experimental/query/filterfields.md +++ b/content/flux/v0/stdlib/experimental/query/filterfields.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-table: stream[{B with _field: A}], ?fields: [A]) => stream[{B with _field: A}] where A: Nullable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/query/filtermeasurement.md b/content/flux/v0/stdlib/experimental/query/filtermeasurement.md index eb9ac5a40..98cf9e1e1 100644 --- a/content/flux/v0/stdlib/experimental/query/filtermeasurement.md +++ b/content/flux/v0/stdlib/experimental/query/filtermeasurement.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-table: stream[{B with _measurement: C}], measurement: A) => stream[{B with _measurement: C}] where A: Equatable, C: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/query/fromrange.md b/content/flux/v0/stdlib/experimental/query/fromrange.md index f3c24af89..68c4e44ab 100644 --- a/content/flux/v0/stdlib/experimental/query/fromrange.md +++ b/content/flux/v0/stdlib/experimental/query/fromrange.md @@ -49,7 +49,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md }] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/query/inbucket.md b/content/flux/v0/stdlib/experimental/query/inbucket.md index 5f2a92aa6..6c9acb46a 100644 --- a/content/flux/v0/stdlib/experimental/query/inbucket.md +++ b/content/flux/v0/stdlib/experimental/query/inbucket.md @@ -64,7 +64,9 @@ filters data by measurement, field, and optional predicate expressions. }] where A: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/record/get.md b/content/flux/v0/stdlib/experimental/record/get.md index c47266e3a..2ec23ece8 100644 --- a/content/flux/v0/stdlib/experimental/record/get.md +++ b/content/flux/v0/stdlib/experimental/record/get.md @@ -42,7 +42,9 @@ For more information, see [influxdata/flux#4073](https://github.com/influxdata/f (default: A, key: string, r: B) => A where B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/set.md b/content/flux/v0/stdlib/experimental/set.md index fcaa427a6..35d786c50 100644 --- a/content/flux/v0/stdlib/experimental/set.md +++ b/content/flux/v0/stdlib/experimental/set.md @@ -39,7 +39,9 @@ If a column does not exist, the function adds it with the specified value. (<-tables: stream[B], o: A) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/skew.md b/content/flux/v0/stdlib/experimental/skew.md index 5dfd4658f..e2aad774b 100644 --- a/content/flux/v0/stdlib/experimental/skew.md +++ b/content/flux/v0/stdlib/experimental/skew.md @@ -40,7 +40,9 @@ input table as a float. (<-tables: stream[{A with _value: float}]) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/spread.md b/content/flux/v0/stdlib/experimental/spread.md index 96ddaf046..a5aa57b22 100644 --- a/content/flux/v0/stdlib/experimental/spread.md +++ b/content/flux/v0/stdlib/experimental/spread.md @@ -40,7 +40,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] where B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/stddev.md b/content/flux/v0/stdlib/experimental/stddev.md index c20f07401..e6714e2f3 100644 --- a/content/flux/v0/stdlib/experimental/stddev.md +++ b/content/flux/v0/stdlib/experimental/stddev.md @@ -49,7 +49,9 @@ population of its own. (<-tables: stream[{A with _value: float}], ?mode: string) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/subduration.md b/content/flux/v0/stdlib/experimental/subduration.md index 34cb366e0..00172243a 100644 --- a/content/flux/v0/stdlib/experimental/subduration.md +++ b/content/flux/v0/stdlib/experimental/subduration.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (d: duration, from: A, ?location: {zone: string, offset: duration}) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/sum.md b/content/flux/v0/stdlib/experimental/sum.md index 9a7aa3d72..f9200d346 100644 --- a/content/flux/v0/stdlib/experimental/sum.md +++ b/content/flux/v0/stdlib/experimental/sum.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] where B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/table/fill.md b/content/flux/v0/stdlib/experimental/table/fill.md index 1122a039e..5455fdd83 100644 --- a/content/flux/v0/stdlib/experimental/table/fill.md +++ b/content/flux/v0/stdlib/experimental/table/fill.md @@ -38,7 +38,9 @@ Columns not in the group key are filled with a null value. (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/to.md b/content/flux/v0/stdlib/experimental/to.md index 6170818e7..581383e1c 100644 --- a/content/flux/v0/stdlib/experimental/to.md +++ b/content/flux/v0/stdlib/experimental/to.md @@ -61,7 +61,9 @@ data into the structure `experimental.to()` expects. ) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/unique.md b/content/flux/v0/stdlib/experimental/unique.md index 8628e9f48..5bd4f0350 100644 --- a/content/flux/v0/stdlib/experimental/unique.md +++ b/content/flux/v0/stdlib/experimental/unique.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/unpivot.md b/content/flux/v0/stdlib/experimental/unpivot.md index f6eca787d..cf91ca2b3 100644 --- a/content/flux/v0/stdlib/experimental/unpivot.md +++ b/content/flux/v0/stdlib/experimental/unpivot.md @@ -45,7 +45,9 @@ The output stream retains the group key and all group key columns of the input s (<-tables: stream[{A with _time: time}], ?otherColumns: [string]) => stream[{B with _value: C, _field: string}] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/usage/from.md b/content/flux/v0/stdlib/experimental/usage/from.md index b68534488..d6cca45d8 100644 --- a/content/flux/v0/stdlib/experimental/usage/from.md +++ b/content/flux/v0/stdlib/experimental/usage/from.md @@ -59,7 +59,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[D] where D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/usage/limits.md b/content/flux/v0/stdlib/experimental/usage/limits.md index 32a5a896a..345d6472f 100644 --- a/content/flux/v0/stdlib/experimental/usage/limits.md +++ b/content/flux/v0/stdlib/experimental/usage/limits.md @@ -54,7 +54,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?host: string, ?orgID: string, ?token: string) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/experimental/window.md b/content/flux/v0/stdlib/experimental/window.md index b9b8d93ad..72e057652 100644 --- a/content/flux/v0/stdlib/experimental/window.md +++ b/content/flux/v0/stdlib/experimental/window.md @@ -57,7 +57,9 @@ calendar months (`1mo`) and years (`1y`). ) => stream[{A with _time: time, _stop: time, _start: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/generate/from.md b/content/flux/v0/stdlib/generate/from.md index 11a223e73..49fc0c291 100644 --- a/content/flux/v0/stdlib/generate/from.md +++ b/content/flux/v0/stdlib/generate/from.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (count: int, fn: (n: int) => int, start: A, stop: A) => stream[{_value: int, _time: time, _stop: time, _start: time}] where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/basicauth.md b/content/flux/v0/stdlib/http/basicauth.md index 1b4dc6f31..005299661 100644 --- a/content/flux/v0/stdlib/http/basicauth.md +++ b/content/flux/v0/stdlib/http/basicauth.md @@ -40,7 +40,9 @@ using a specified username and password combination. (p: string, u: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/endpoint.md b/content/flux/v0/stdlib/http/endpoint.md index d57eb95b6..90938eccf 100644 --- a/content/flux/v0/stdlib/http/endpoint.md +++ b/content/flux/v0/stdlib/http/endpoint.md @@ -51,7 +51,9 @@ _For information about properties, see `http.post`._ ) => (mapFn: (r: A) => {B with headers: C, data: bytes}) => (<-tables: stream[A]) => stream[{A with _sent: string}] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/pathescape.md b/content/flux/v0/stdlib/http/pathescape.md index 6396d2342..1b235ae05 100644 --- a/content/flux/v0/stdlib/http/pathescape.md +++ b/content/flux/v0/stdlib/http/pathescape.md @@ -40,7 +40,9 @@ and replaces non-ASCII characters with hexadecimal representations (`%XX`). (inputString: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/post.md b/content/flux/v0/stdlib/http/post.md index cac5377fc..56407945a 100644 --- a/content/flux/v0/stdlib/http/post.md +++ b/content/flux/v0/stdlib/http/post.md @@ -40,7 +40,9 @@ and returns the HTTP status code. (url: string, ?data: bytes, ?headers: A) => int where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/requests/do.md b/content/flux/v0/stdlib/http/requests/do.md index ba1313792..0ed84c154 100644 --- a/content/flux/v0/stdlib/http/requests/do.md +++ b/content/flux/v0/stdlib/http/requests/do.md @@ -51,7 +51,9 @@ The returned response contains the following properties: ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/requests/get.md b/content/flux/v0/stdlib/http/requests/get.md index 1b7dfb724..58060542d 100644 --- a/content/flux/v0/stdlib/http/requests/get.md +++ b/content/flux/v0/stdlib/http/requests/get.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/requests/peek.md b/content/flux/v0/stdlib/http/requests/peek.md index 52f35b3d1..211213c46 100644 --- a/content/flux/v0/stdlib/http/requests/peek.md +++ b/content/flux/v0/stdlib/http/requests/peek.md @@ -46,7 +46,9 @@ and then use `array.from()` to construct a table from those values. ) => stream[{statusCode: E, headers: string, duration: int, body: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/http/requests/post.md b/content/flux/v0/stdlib/http/requests/post.md index 4b89abd38..070164313 100644 --- a/content/flux/v0/stdlib/http/requests/post.md +++ b/content/flux/v0/stdlib/http/requests/post.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => {statusCode: int, headers: [string:string], duration: duration, body: bytes} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/buckets.md b/content/flux/v0/stdlib/influxdata/influxdb/buckets.md index 37dd89571..d5219c184 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/buckets.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/buckets.md @@ -49,7 +49,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md }] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/cardinality.md b/content/flux/v0/stdlib/influxdata/influxdb/cardinality.md index af23fc033..0a1d5672f 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/cardinality.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/cardinality.md @@ -48,7 +48,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[{_value: int, _stop: time, _start: time}] where A: Timeable, D: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/from.md b/content/flux/v0/stdlib/influxdata/influxdb/from.md index 54697bbae..03660cdf4 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/from.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/from.md @@ -56,7 +56,9 @@ Flux prelude and does not require an import statement or package namespace. ) => stream[{A with _value: B, _time: time, _measurement: string, _field: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/check.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/check.md index 20e70e8d3..9605863c1 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/check.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/check.md @@ -75,7 +75,9 @@ to the `statuses` measurement in the `_monitoring` bucket. }] where E: Record, J: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/deadman.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/deadman.md index b337ef21c..630f53121 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/deadman.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/deadman.md @@ -41,7 +41,9 @@ Otherwise, `dead` is set to `true`. (<-tables: stream[{B with _time: C}], t: A) => stream[{B with dead: bool, _time: C}] where A: Comparable, C: Comparable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/from.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/from.md index 318b6005d..a1f2c3a00 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/from.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/from.md @@ -52,7 +52,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/log.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/log.md index 0957ffe90..812f0922a 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/log.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/log.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/logs.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/logs.md index 5ef780def..9f08eb550 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/logs.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/logs.md @@ -53,7 +53,9 @@ in the `_monitoring` bucket. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/notify.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/notify.md index da2fa6e55..996c0de5b 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/notify.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/notify.md @@ -42,7 +42,9 @@ measurement in the `_monitoring` bucket. ) => stream[D] where A: Record, D: Record, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechanges.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechanges.md index a8fdccfa1..085315bcb 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechanges.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechanges.md @@ -40,7 +40,9 @@ and outputs records that change from `fromLevel` to `toLevel`. (<-tables: stream[{C with _level: D}], ?fromLevel: A, ?toLevel: B) => stream[E] where A: Equatable, B: Equatable, D: Equatable, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechangesonly.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechangesonly.md index 31608ad0f..e9bbb5eb2 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechangesonly.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/statechangesonly.md @@ -42,7 +42,9 @@ represents a state change. (<-tables: stream[{A with _level: B}]) => stream[C] where B: Equatable, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/monitor/write.md b/content/flux/v0/stdlib/influxdata/influxdb/monitor/write.md index 31808bf6d..32cdf5d5d 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/monitor/write.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/monitor/write.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/sample/aligntonow.md b/content/flux/v0/stdlib/influxdata/influxdb/sample/aligntonow.md index a62ec57c2..8b212edeb 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/sample/aligntonow.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/sample/aligntonow.md @@ -41,7 +41,9 @@ Input data must have a `_time` column. (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/sample/data.md b/content/flux/v0/stdlib/influxdata/influxdb/sample/data.md index 8564bcfee..92c71ecf9 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/sample/data.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/sample/data.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (set: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/sample/list.md b/content/flux/v0/stdlib/influxdata/influxdb/sample/list.md index 0cdfa95f7..c93063ad1 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/sample/list.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/sample/list.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md }] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldkeys.md index db4a08bec..8fb4e8610 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldkeys.md @@ -55,7 +55,9 @@ keys in a given bucket. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldsascols.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldsascols.md index e2df070c4..446529f57 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldsascols.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/fieldsascols.md @@ -41,7 +41,9 @@ have the same timestamp. (<-tables: stream[A]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementfieldkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementfieldkeys.md index 38dd1ebea..998e53972 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementfieldkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementfieldkeys.md @@ -37,7 +37,9 @@ Results include a single table with a single column, `_value`. (bucket: string, measurement: A, ?start: B, ?stop: C) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurements.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurements.md index c1ad6790a..b44df5428 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurements.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurements.md @@ -37,7 +37,9 @@ Results include a single table with a single column, `_value`. (bucket: string, ?start: A, ?stop: B) => stream[C] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagkeys.md index 1e1158b7b..121267032 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagkeys.md @@ -37,7 +37,9 @@ Results include a single table with a single column, `_value`. (bucket: string, measurement: A, ?start: B, ?stop: C) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagvalues.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagvalues.md index 04e48cb8c..445960229 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagvalues.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/measurementtagvalues.md @@ -43,7 +43,9 @@ Results include a single table with a single column, `_value`. ) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/tagkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/tagkeys.md index e838b3bb2..3ccf26bb3 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/tagkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/tagkeys.md @@ -52,7 +52,9 @@ Results include a single table with a single column, `_value`. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/schema/tagvalues.md b/content/flux/v0/stdlib/influxdata/influxdb/schema/tagvalues.md index 1c955bb45..0091289f9 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/schema/tagvalues.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/schema/tagvalues.md @@ -53,7 +53,9 @@ Results include a single table with a single column, `_value`. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/secrets/get.md b/content/flux/v0/stdlib/influxdata/influxdb/secrets/get.md index 0c6e6509d..571c975dd 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/secrets/get.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/secrets/get.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (key: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/tasks/lastsuccess.md b/content/flux/v0/stdlib/influxdata/influxdb/tasks/lastsuccess.md index 167f12936..434036193 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/tasks/lastsuccess.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/tasks/lastsuccess.md @@ -38,7 +38,9 @@ or the value of the `orTime` parameter if the task has never successfully run. (orTime: A) => time where A: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/to.md b/content/flux/v0/stdlib/influxdata/influxdb/to.md index dc964e9ec..5dc4eda58 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/to.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/to.md @@ -66,7 +66,9 @@ Flux prelude and does not require an import statement or package namespace. ) => stream[A] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/databases.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/databases.md index 0d83da06b..9f993e670 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/databases.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/databases.md @@ -54,7 +54,9 @@ Output includes the following columns: }] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldkeys.md index e55e17223..e362c3127 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldkeys.md @@ -56,7 +56,9 @@ keys in a given bucket. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldsascols.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldsascols.md index d73394948..05a472eba 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldsascols.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/fieldsascols.md @@ -45,7 +45,9 @@ See influxdata/influxdata/schema.fieldsAsCols. (<-tables: stream[A]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/json.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/json.md index acce4d765..c120b63cc 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/json.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/json.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?file: string, ?json: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementfieldkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementfieldkeys.md index 5b8715d21..97feb8485 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementfieldkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementfieldkeys.md @@ -38,7 +38,9 @@ Results include a single table with a single column, `_value`. (bucket: string, measurement: A, ?start: B, ?stop: C) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurements.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurements.md index 6ff670576..0fa65cc73 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurements.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurements.md @@ -38,7 +38,9 @@ Results include a single table with a single column, `_value`. (bucket: string, ?start: A, ?stop: B) => stream[C] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagkeys.md index c3c4efc13..852f8817c 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagkeys.md @@ -38,7 +38,9 @@ Results include a single table with a single column, `_value`. (bucket: string, measurement: A, ?start: B, ?stop: C) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagvalues.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagvalues.md index f6f9c2d3b..ea790ec0d 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagvalues.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/measurementtagvalues.md @@ -44,7 +44,9 @@ Results include a single table with a single column, `_value`. ) => stream[D] where A: Equatable, D: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/tagkeys.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/tagkeys.md index f60d62d2f..13b6791e6 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/tagkeys.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/tagkeys.md @@ -53,7 +53,9 @@ Results include a single table with a single column, `_value`. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/v1/tagvalues.md b/content/flux/v0/stdlib/influxdata/influxdb/v1/tagvalues.md index 78762ae74..a2393ab0f 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/v1/tagvalues.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/v1/tagvalues.md @@ -54,7 +54,9 @@ Results include a single table with a single column, `_value`. ) => stream[E] where E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/influxdata/influxdb/wideto.md b/content/flux/v0/stdlib/influxdata/influxdb/wideto.md index 183b3da0a..f32dbc6bb 100644 --- a/content/flux/v0/stdlib/influxdata/influxdb/wideto.md +++ b/content/flux/v0/stdlib/influxdata/influxdb/wideto.md @@ -56,7 +56,9 @@ data into the structure `experimental.to()` expects. ) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/feature.md b/content/flux/v0/stdlib/internal/debug/feature.md index 579891300..d6f2674a1 100644 --- a/content/flux/v0/stdlib/internal/debug/feature.md +++ b/content/flux/v0/stdlib/internal/debug/feature.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (key: string) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/getoption.md b/content/flux/v0/stdlib/internal/debug/getoption.md index ed8cdaa00..a818f5db3 100644 --- a/content/flux/v0/stdlib/internal/debug/getoption.md +++ b/content/flux/v0/stdlib/internal/debug/getoption.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (name: string, pkg: string) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/null.md b/content/flux/v0/stdlib/internal/debug/null.md index 712072a56..d7115584f 100644 --- a/content/flux/v0/stdlib/internal/debug/null.md +++ b/content/flux/v0/stdlib/internal/debug/null.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?type: string) => A where A: Basic ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/opaque.md b/content/flux/v0/stdlib/internal/debug/opaque.md index a1158bb17..35df71353 100644 --- a/content/flux/v0/stdlib/internal/debug/opaque.md +++ b/content/flux/v0/stdlib/internal/debug/opaque.md @@ -40,7 +40,9 @@ input type has any correlation with the output type. (<-tables: stream[A]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/pass.md b/content/flux/v0/stdlib/internal/debug/pass.md index 0d689bfeb..f4df76945 100644 --- a/content/flux/v0/stdlib/internal/debug/pass.md +++ b/content/flux/v0/stdlib/internal/debug/pass.md @@ -38,7 +38,9 @@ It is best used to interrupt any planner rules that rely on a specific ordering. (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/sink.md b/content/flux/v0/stdlib/internal/debug/sink.md index 926390998..060436c4b 100644 --- a/content/flux/v0/stdlib/internal/debug/sink.md +++ b/content/flux/v0/stdlib/internal/debug/sink.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/debug/slurp.md b/content/flux/v0/stdlib/internal/debug/slurp.md index 3756c00a1..3ae2a7b9d 100644 --- a/content/flux/v0/stdlib/internal/debug/slurp.md +++ b/content/flux/v0/stdlib/internal/debug/slurp.md @@ -40,7 +40,9 @@ buffers versus a single buffer. (<-tables: stream[A]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/gen/tables.md b/content/flux/v0/stdlib/internal/gen/tables.md index fd487f0ca..035f6099b 100644 --- a/content/flux/v0/stdlib/internal/gen/tables.md +++ b/content/flux/v0/stdlib/internal/gen/tables.md @@ -41,7 +41,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[{A with _value: float, _time: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/changes.md b/content/flux/v0/stdlib/internal/promql/changes.md index af9b218d0..ac73660b4 100644 --- a/content/flux/v0/stdlib/internal/promql/changes.md +++ b/content/flux/v0/stdlib/internal/promql/changes.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: float}]) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/emptytable.md b/content/flux/v0/stdlib/internal/promql/emptytable.md index 1a370365b..302b775a0 100644 --- a/content/flux/v0/stdlib/internal/promql/emptytable.md +++ b/content/flux/v0/stdlib/internal/promql/emptytable.md @@ -40,5 +40,7 @@ PromQL's [`time()`](https://prometheus.io/docs/prometheus/latest/querying/functi () => stream[{_value: float, _time: time, _stop: time, _start: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} diff --git a/content/flux/v0/stdlib/internal/promql/extrapolatedrate.md b/content/flux/v0/stdlib/internal/promql/extrapolatedrate.md index 789a594ff..c7ead0b34 100644 --- a/content/flux/v0/stdlib/internal/promql/extrapolatedrate.md +++ b/content/flux/v0/stdlib/internal/promql/extrapolatedrate.md @@ -48,7 +48,9 @@ and [`increase()`](https://prometheus.io/docs/prometheus/latest/querying/functio ) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/holtwinters.md b/content/flux/v0/stdlib/internal/promql/holtwinters.md index 2f63fd5b3..779a8e772 100644 --- a/content/flux/v0/stdlib/internal/promql/holtwinters.md +++ b/content/flux/v0/stdlib/internal/promql/holtwinters.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/instantrate.md b/content/flux/v0/stdlib/internal/promql/instantrate.md index d6a8eeb3c..f6dfb0539 100644 --- a/content/flux/v0/stdlib/internal/promql/instantrate.md +++ b/content/flux/v0/stdlib/internal/promql/instantrate.md @@ -42,7 +42,9 @@ counters and is used to implement PromQL's (<-tables: stream[{A with _value: float, _time: time}], ?isRate: bool) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/join.md b/content/flux/v0/stdlib/internal/promql/join.md index adcfacf20..911d31161 100644 --- a/content/flux/v0/stdlib/internal/promql/join.md +++ b/content/flux/v0/stdlib/internal/promql/join.md @@ -38,7 +38,9 @@ See [`experimental.join`](/flux/v0/stdlib/experimental/join/). (fn: (left: A, right: B) => C, left: stream[A], right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/labelreplace.md b/content/flux/v0/stdlib/internal/promql/labelreplace.md index 65a4cd145..039169eac 100644 --- a/content/flux/v0/stdlib/internal/promql/labelreplace.md +++ b/content/flux/v0/stdlib/internal/promql/labelreplace.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/linearregression.md b/content/flux/v0/stdlib/internal/promql/linearregression.md index 6bc90f237..93b501916 100644 --- a/content/flux/v0/stdlib/internal/promql/linearregression.md +++ b/content/flux/v0/stdlib/internal/promql/linearregression.md @@ -44,7 +44,9 @@ and [`predict_linear()`](https://prometheus.io/docs/prometheus/latest/querying/f ) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promhistogramquantile.md b/content/flux/v0/stdlib/internal/promql/promhistogramquantile.md index 0c6a7e94a..599028199 100644 --- a/content/flux/v0/stdlib/internal/promql/promhistogramquantile.md +++ b/content/flux/v0/stdlib/internal/promql/promhistogramquantile.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqldayofmonth.md b/content/flux/v0/stdlib/internal/promql/promqldayofmonth.md index 69dbac457..1af988b5b 100644 --- a/content/flux/v0/stdlib/internal/promql/promqldayofmonth.md +++ b/content/flux/v0/stdlib/internal/promql/promqldayofmonth.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqldayofweek.md b/content/flux/v0/stdlib/internal/promql/promqldayofweek.md index dc8ceac3d..f7f958804 100644 --- a/content/flux/v0/stdlib/internal/promql/promqldayofweek.md +++ b/content/flux/v0/stdlib/internal/promql/promqldayofweek.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqldaysinmonth.md b/content/flux/v0/stdlib/internal/promql/promqldaysinmonth.md index 49fc23d2e..2a24cd8ba 100644 --- a/content/flux/v0/stdlib/internal/promql/promqldaysinmonth.md +++ b/content/flux/v0/stdlib/internal/promql/promqldaysinmonth.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqlhour.md b/content/flux/v0/stdlib/internal/promql/promqlhour.md index 2cd32cedd..645daabe6 100644 --- a/content/flux/v0/stdlib/internal/promql/promqlhour.md +++ b/content/flux/v0/stdlib/internal/promql/promqlhour.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqlminute.md b/content/flux/v0/stdlib/internal/promql/promqlminute.md index 23f52fb8d..a4dda738f 100644 --- a/content/flux/v0/stdlib/internal/promql/promqlminute.md +++ b/content/flux/v0/stdlib/internal/promql/promqlminute.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqlmonth.md b/content/flux/v0/stdlib/internal/promql/promqlmonth.md index 9c1d9d518..ae4db5773 100644 --- a/content/flux/v0/stdlib/internal/promql/promqlmonth.md +++ b/content/flux/v0/stdlib/internal/promql/promqlmonth.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/promqlyear.md b/content/flux/v0/stdlib/internal/promql/promqlyear.md index 428df9756..3f75d7197 100644 --- a/content/flux/v0/stdlib/internal/promql/promqlyear.md +++ b/content/flux/v0/stdlib/internal/promql/promqlyear.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (timestamp: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/quantile.md b/content/flux/v0/stdlib/internal/promql/quantile.md index d1d43309c..39989ca2b 100644 --- a/content/flux/v0/stdlib/internal/promql/quantile.md +++ b/content/flux/v0/stdlib/internal/promql/quantile.md @@ -40,7 +40,9 @@ column respectively. `q` must be a float. (<-tables: stream[A], q: float, ?method: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/resets.md b/content/flux/v0/stdlib/internal/promql/resets.md index 4dcd66d28..b2b84e6e5 100644 --- a/content/flux/v0/stdlib/internal/promql/resets.md +++ b/content/flux/v0/stdlib/internal/promql/resets.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: float}]) => stream[{B with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/promql/timestamp.md b/content/flux/v0/stdlib/internal/promql/timestamp.md index df25e39cd..51254b5b9 100644 --- a/content/flux/v0/stdlib/internal/promql/timestamp.md +++ b/content/flux/v0/stdlib/internal/promql/timestamp.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: float}]) => stream[{A with _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/testing/assertmatches.md b/content/flux/v0/stdlib/internal/testing/assertmatches.md index a342d97e8..aa085edec 100644 --- a/content/flux/v0/stdlib/internal/testing/assertmatches.md +++ b/content/flux/v0/stdlib/internal/testing/assertmatches.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (got: string, want: regexp) => stream[{v: string, _diff: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/testing/shoulderrorwithcode.md b/content/flux/v0/stdlib/internal/testing/shoulderrorwithcode.md index a04d6e773..b81d8388e 100644 --- a/content/flux/v0/stdlib/internal/testing/shoulderrorwithcode.md +++ b/content/flux/v0/stdlib/internal/testing/shoulderrorwithcode.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (code: uint, fn: () => A, want: regexp) => stream[{match: bool, code: uint, _diff: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/testutil/fail.md b/content/flux/v0/stdlib/internal/testutil/fail.md index b91f09174..cc103e522 100644 --- a/content/flux/v0/stdlib/internal/testutil/fail.md +++ b/content/flux/v0/stdlib/internal/testutil/fail.md @@ -36,5 +36,7 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md () => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} diff --git a/content/flux/v0/stdlib/internal/testutil/makeany.md b/content/flux/v0/stdlib/internal/testutil/makeany.md index b0476948d..15220a2d6 100644 --- a/content/flux/v0/stdlib/internal/testutil/makeany.md +++ b/content/flux/v0/stdlib/internal/testutil/makeany.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (typ: string) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/testutil/makerecord.md b/content/flux/v0/stdlib/internal/testutil/makerecord.md index 43a9d30ee..b385920af 100644 --- a/content/flux/v0/stdlib/internal/testutil/makerecord.md +++ b/content/flux/v0/stdlib/internal/testutil/makerecord.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (o: A) => B where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/internal/testutil/yield.md b/content/flux/v0/stdlib/internal/testutil/yield.md index e29ed08b2..c2daa0d73 100644 --- a/content/flux/v0/stdlib/internal/testutil/yield.md +++ b/content/flux/v0/stdlib/internal/testutil/yield.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-v: A) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/interpolate/linear.md b/content/flux/v0/stdlib/interpolate/linear.md index 793af81f3..356c2b96f 100644 --- a/content/flux/v0/stdlib/interpolate/linear.md +++ b/content/flux/v0/stdlib/interpolate/linear.md @@ -41,7 +41,9 @@ determine values for inserted rows. (<-tables: stream[{A with _value: float, _time: time}], every: duration) => stream[{A with _value: float, _time: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/full.md b/content/flux/v0/stdlib/join/full.md index 20bf4cf60..4cb066807 100644 --- a/content/flux/v0/stdlib/join/full.md +++ b/content/flux/v0/stdlib/join/full.md @@ -38,7 +38,9 @@ The function calls `join.tables()` with the `method` parameter set to `"full"`. (<-left: stream[A], as: (l: A, r: B) => C, on: (l: A, r: B) => bool, right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/inner.md b/content/flux/v0/stdlib/join/inner.md index 26a4615d4..7c2510b77 100644 --- a/content/flux/v0/stdlib/join/inner.md +++ b/content/flux/v0/stdlib/join/inner.md @@ -38,7 +38,9 @@ The function calls `join.tables()` with the `method` parameter set to `"inner"`. (<-left: stream[A], as: (l: A, r: B) => C, on: (l: A, r: B) => bool, right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/left.md b/content/flux/v0/stdlib/join/left.md index 93e04341d..a55d274f5 100644 --- a/content/flux/v0/stdlib/join/left.md +++ b/content/flux/v0/stdlib/join/left.md @@ -38,7 +38,9 @@ The function calls `join.tables()` with the `method` parameter set to `"left"`. (<-left: stream[A], as: (l: A, r: B) => C, on: (l: A, r: B) => bool, right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/right.md b/content/flux/v0/stdlib/join/right.md index cab5cb182..29d3e9a8e 100644 --- a/content/flux/v0/stdlib/join/right.md +++ b/content/flux/v0/stdlib/join/right.md @@ -38,7 +38,9 @@ The function calls `join.tables()` with the `method` parameter set to `"right"`. (<-left: stream[A], as: (l: A, r: B) => C, on: (l: A, r: B) => bool, right: stream[B]) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/tables.md b/content/flux/v0/stdlib/join/tables.md index e671e14c6..dbf760298 100644 --- a/content/flux/v0/stdlib/join/tables.md +++ b/content/flux/v0/stdlib/join/tables.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/join/time.md b/content/flux/v0/stdlib/join/time.md index 1312021e4..046d7b32b 100644 --- a/content/flux/v0/stdlib/join/time.md +++ b/content/flux/v0/stdlib/join/time.md @@ -43,7 +43,9 @@ This function calls `join.tables()` with the `on` parameter set to `(l, r) => l. ) => stream[E] where B: Equatable, D: Equatable, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/json/encode.md b/content/flux/v0/stdlib/json/encode.md index 54fa84a97..b451c5e13 100644 --- a/content/flux/v0/stdlib/json/encode.md +++ b/content/flux/v0/stdlib/json/encode.md @@ -43,7 +43,9 @@ This function encodes Flux types as follows: (v: A) => bytes ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/kafka/to.md b/content/flux/v0/stdlib/kafka/to.md index a683f86c6..b673ec49c 100644 --- a/content/flux/v0/stdlib/kafka/to.md +++ b/content/flux/v0/stdlib/kafka/to.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/abs.md b/content/flux/v0/stdlib/math/abs.md index 484bc6ffe..b746ad3cb 100644 --- a/content/flux/v0/stdlib/math/abs.md +++ b/content/flux/v0/stdlib/math/abs.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/acos.md b/content/flux/v0/stdlib/math/acos.md index 30af07cd8..e9b708637 100644 --- a/content/flux/v0/stdlib/math/acos.md +++ b/content/flux/v0/stdlib/math/acos.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/acosh.md b/content/flux/v0/stdlib/math/acosh.md index 50a78bbf9..2fac6aab2 100644 --- a/content/flux/v0/stdlib/math/acosh.md +++ b/content/flux/v0/stdlib/math/acosh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/asin.md b/content/flux/v0/stdlib/math/asin.md index ffb9915d2..341df971b 100644 --- a/content/flux/v0/stdlib/math/asin.md +++ b/content/flux/v0/stdlib/math/asin.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/asinh.md b/content/flux/v0/stdlib/math/asinh.md index ccf5dc974..97d75899f 100644 --- a/content/flux/v0/stdlib/math/asinh.md +++ b/content/flux/v0/stdlib/math/asinh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/atan.md b/content/flux/v0/stdlib/math/atan.md index 61c2f9b03..1316fc7fa 100644 --- a/content/flux/v0/stdlib/math/atan.md +++ b/content/flux/v0/stdlib/math/atan.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/atan2.md b/content/flux/v0/stdlib/math/atan2.md index c932e9890..a7d29154c 100644 --- a/content/flux/v0/stdlib/math/atan2.md +++ b/content/flux/v0/stdlib/math/atan2.md @@ -38,7 +38,9 @@ of the two to determine the quadrant of the return value. (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/atanh.md b/content/flux/v0/stdlib/math/atanh.md index dcc28dee6..53d3e2ab6 100644 --- a/content/flux/v0/stdlib/math/atanh.md +++ b/content/flux/v0/stdlib/math/atanh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/cbrt.md b/content/flux/v0/stdlib/math/cbrt.md index ae6e384e6..350bf7af4 100644 --- a/content/flux/v0/stdlib/math/cbrt.md +++ b/content/flux/v0/stdlib/math/cbrt.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/ceil.md b/content/flux/v0/stdlib/math/ceil.md index 9f4c85a96..52a46cd0d 100644 --- a/content/flux/v0/stdlib/math/ceil.md +++ b/content/flux/v0/stdlib/math/ceil.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/copysign.md b/content/flux/v0/stdlib/math/copysign.md index 83dd6714e..4bcc7c668 100644 --- a/content/flux/v0/stdlib/math/copysign.md +++ b/content/flux/v0/stdlib/math/copysign.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/cos.md b/content/flux/v0/stdlib/math/cos.md index ff5b8367c..d06057ce8 100644 --- a/content/flux/v0/stdlib/math/cos.md +++ b/content/flux/v0/stdlib/math/cos.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/cosh.md b/content/flux/v0/stdlib/math/cosh.md index e9072be80..a33eff458 100644 --- a/content/flux/v0/stdlib/math/cosh.md +++ b/content/flux/v0/stdlib/math/cosh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/dim.md b/content/flux/v0/stdlib/math/dim.md index 09b6d4bf5..b4c8a68e0 100644 --- a/content/flux/v0/stdlib/math/dim.md +++ b/content/flux/v0/stdlib/math/dim.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/erf.md b/content/flux/v0/stdlib/math/erf.md index a1cb49888..3686c3dea 100644 --- a/content/flux/v0/stdlib/math/erf.md +++ b/content/flux/v0/stdlib/math/erf.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/erfc.md b/content/flux/v0/stdlib/math/erfc.md index 547453ba8..3ce7ee3ae 100644 --- a/content/flux/v0/stdlib/math/erfc.md +++ b/content/flux/v0/stdlib/math/erfc.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/erfcinv.md b/content/flux/v0/stdlib/math/erfcinv.md index 3651e21ef..85f06be59 100644 --- a/content/flux/v0/stdlib/math/erfcinv.md +++ b/content/flux/v0/stdlib/math/erfcinv.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/erfinv.md b/content/flux/v0/stdlib/math/erfinv.md index fd7ae8d53..4a8999e3a 100644 --- a/content/flux/v0/stdlib/math/erfinv.md +++ b/content/flux/v0/stdlib/math/erfinv.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/exp.md b/content/flux/v0/stdlib/math/exp.md index b0542428c..308fbeb34 100644 --- a/content/flux/v0/stdlib/math/exp.md +++ b/content/flux/v0/stdlib/math/exp.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/exp2.md b/content/flux/v0/stdlib/math/exp2.md index e5053aec1..9a88f2e2c 100644 --- a/content/flux/v0/stdlib/math/exp2.md +++ b/content/flux/v0/stdlib/math/exp2.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/expm1.md b/content/flux/v0/stdlib/math/expm1.md index 779e154d9..155263d96 100644 --- a/content/flux/v0/stdlib/math/expm1.md +++ b/content/flux/v0/stdlib/math/expm1.md @@ -38,7 +38,9 @@ It is more accurate than `math.exp(x:x) - 1` when `x` is near zero. (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/float64bits.md b/content/flux/v0/stdlib/math/float64bits.md index 4736e01e5..4ea1ef336 100644 --- a/content/flux/v0/stdlib/math/float64bits.md +++ b/content/flux/v0/stdlib/math/float64bits.md @@ -38,7 +38,9 @@ with the sign bit of `f` and the result in the same bit position. (f: float) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/float64frombits.md b/content/flux/v0/stdlib/math/float64frombits.md index c9db6a57e..6b6cd89ee 100644 --- a/content/flux/v0/stdlib/math/float64frombits.md +++ b/content/flux/v0/stdlib/math/float64frombits.md @@ -40,7 +40,9 @@ same bit position. (b: uint) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/floor.md b/content/flux/v0/stdlib/math/floor.md index d5cd90415..be146d8c2 100644 --- a/content/flux/v0/stdlib/math/floor.md +++ b/content/flux/v0/stdlib/math/floor.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/frexp.md b/content/flux/v0/stdlib/math/frexp.md index 0d18f5fc7..c2ef1ebe3 100644 --- a/content/flux/v0/stdlib/math/frexp.md +++ b/content/flux/v0/stdlib/math/frexp.md @@ -37,7 +37,9 @@ with the absolute value of **frac** in the interval [1/2, 1). (f: float) => {frac: float, exp: int} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/gamma.md b/content/flux/v0/stdlib/math/gamma.md index 1244eb7f1..dc45a6caa 100644 --- a/content/flux/v0/stdlib/math/gamma.md +++ b/content/flux/v0/stdlib/math/gamma.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/hypot.md b/content/flux/v0/stdlib/math/hypot.md index 192048478..dac5f7c2a 100644 --- a/content/flux/v0/stdlib/math/hypot.md +++ b/content/flux/v0/stdlib/math/hypot.md @@ -38,7 +38,9 @@ and underflow. (p: float, q: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/ilogb.md b/content/flux/v0/stdlib/math/ilogb.md index 81191d6a6..fbed5c677 100644 --- a/content/flux/v0/stdlib/math/ilogb.md +++ b/content/flux/v0/stdlib/math/ilogb.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/isinf.md b/content/flux/v0/stdlib/math/isinf.md index 85334ea5d..3d174842b 100644 --- a/content/flux/v0/stdlib/math/isinf.md +++ b/content/flux/v0/stdlib/math/isinf.md @@ -38,7 +38,9 @@ If `sign == 0`, math.isInf reports whether `f` is either infinity. (f: float, sign: int) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/isnan.md b/content/flux/v0/stdlib/math/isnan.md index c3df36135..e3eaf23e6 100644 --- a/content/flux/v0/stdlib/math/isnan.md +++ b/content/flux/v0/stdlib/math/isnan.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (f: float) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/j0.md b/content/flux/v0/stdlib/math/j0.md index 68e05f7b6..9a00dfa21 100644 --- a/content/flux/v0/stdlib/math/j0.md +++ b/content/flux/v0/stdlib/math/j0.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/j1.md b/content/flux/v0/stdlib/math/j1.md index f6896f9e0..3e82815c2 100644 --- a/content/flux/v0/stdlib/math/j1.md +++ b/content/flux/v0/stdlib/math/j1.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/jn.md b/content/flux/v0/stdlib/math/jn.md index 5184580ab..7052729b6 100644 --- a/content/flux/v0/stdlib/math/jn.md +++ b/content/flux/v0/stdlib/math/jn.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (n: int, x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/ldexp.md b/content/flux/v0/stdlib/math/ldexp.md index 4673ddb78..26df133d4 100644 --- a/content/flux/v0/stdlib/math/ldexp.md +++ b/content/flux/v0/stdlib/math/ldexp.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (exp: int, frac: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/lgamma.md b/content/flux/v0/stdlib/math/lgamma.md index 37f5b27e3..a8d022f10 100644 --- a/content/flux/v0/stdlib/math/lgamma.md +++ b/content/flux/v0/stdlib/math/lgamma.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => {sign: int, lgamma: float} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/log.md b/content/flux/v0/stdlib/math/log.md index f1b5fd507..ac57697e7 100644 --- a/content/flux/v0/stdlib/math/log.md +++ b/content/flux/v0/stdlib/math/log.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/log10.md b/content/flux/v0/stdlib/math/log10.md index d13686590..53c77d2d8 100644 --- a/content/flux/v0/stdlib/math/log10.md +++ b/content/flux/v0/stdlib/math/log10.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/log1p.md b/content/flux/v0/stdlib/math/log1p.md index 798c5d814..fa960a8e4 100644 --- a/content/flux/v0/stdlib/math/log1p.md +++ b/content/flux/v0/stdlib/math/log1p.md @@ -40,7 +40,9 @@ near zero. (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/log2.md b/content/flux/v0/stdlib/math/log2.md index 9c5bcb4bd..a7d830fbe 100644 --- a/content/flux/v0/stdlib/math/log2.md +++ b/content/flux/v0/stdlib/math/log2.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/logb.md b/content/flux/v0/stdlib/math/logb.md index 4565960ef..6f117da64 100644 --- a/content/flux/v0/stdlib/math/logb.md +++ b/content/flux/v0/stdlib/math/logb.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/minf.md b/content/flux/v0/stdlib/math/minf.md index 83157dcc1..00da610ca 100644 --- a/content/flux/v0/stdlib/math/minf.md +++ b/content/flux/v0/stdlib/math/minf.md @@ -38,7 +38,9 @@ if `sign < 0`. (sign: int) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/mmax.md b/content/flux/v0/stdlib/math/mmax.md index c995266af..190cd18d0 100644 --- a/content/flux/v0/stdlib/math/mmax.md +++ b/content/flux/v0/stdlib/math/mmax.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/mmin.md b/content/flux/v0/stdlib/math/mmin.md index 038d64eef..db4739eb1 100644 --- a/content/flux/v0/stdlib/math/mmin.md +++ b/content/flux/v0/stdlib/math/mmin.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/mod.md b/content/flux/v0/stdlib/math/mod.md index 4a2c7f7d7..0a335e242 100644 --- a/content/flux/v0/stdlib/math/mod.md +++ b/content/flux/v0/stdlib/math/mod.md @@ -40,7 +40,9 @@ For example: `4.56 % 1.23` (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/modf.md b/content/flux/v0/stdlib/math/modf.md index b122a6b3f..971792a3b 100644 --- a/content/flux/v0/stdlib/math/modf.md +++ b/content/flux/v0/stdlib/math/modf.md @@ -36,7 +36,9 @@ Both values have the same sign as `f`. (f: float) => {int: float, frac: float} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/nan.md b/content/flux/v0/stdlib/math/nan.md index a9d6503ea..acd3cd0db 100644 --- a/content/flux/v0/stdlib/math/nan.md +++ b/content/flux/v0/stdlib/math/nan.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md () => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/math/nextafter.md b/content/flux/v0/stdlib/math/nextafter.md index 2fb0f23bc..e48c397ff 100644 --- a/content/flux/v0/stdlib/math/nextafter.md +++ b/content/flux/v0/stdlib/math/nextafter.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/pow.md b/content/flux/v0/stdlib/math/pow.md index 547c837cb..cb976422b 100644 --- a/content/flux/v0/stdlib/math/pow.md +++ b/content/flux/v0/stdlib/math/pow.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/pow10.md b/content/flux/v0/stdlib/math/pow10.md index de0891494..6c2f7a886 100644 --- a/content/flux/v0/stdlib/math/pow10.md +++ b/content/flux/v0/stdlib/math/pow10.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (n: int) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/remainder.md b/content/flux/v0/stdlib/math/remainder.md index 6b3b4bf1f..b81fdf25c 100644 --- a/content/flux/v0/stdlib/math/remainder.md +++ b/content/flux/v0/stdlib/math/remainder.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float, y: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/round.md b/content/flux/v0/stdlib/math/round.md index 93ed9417d..7a114ec39 100644 --- a/content/flux/v0/stdlib/math/round.md +++ b/content/flux/v0/stdlib/math/round.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/roundtoeven.md b/content/flux/v0/stdlib/math/roundtoeven.md index 4a0f1188d..4b303e8f7 100644 --- a/content/flux/v0/stdlib/math/roundtoeven.md +++ b/content/flux/v0/stdlib/math/roundtoeven.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/signbit.md b/content/flux/v0/stdlib/math/signbit.md index c35402509..591ccf743 100644 --- a/content/flux/v0/stdlib/math/signbit.md +++ b/content/flux/v0/stdlib/math/signbit.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/sin.md b/content/flux/v0/stdlib/math/sin.md index 592590028..4cb953d41 100644 --- a/content/flux/v0/stdlib/math/sin.md +++ b/content/flux/v0/stdlib/math/sin.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/sincos.md b/content/flux/v0/stdlib/math/sincos.md index b47472ba7..e1808ecc9 100644 --- a/content/flux/v0/stdlib/math/sincos.md +++ b/content/flux/v0/stdlib/math/sincos.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => {sin: float, cos: float} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/sinh.md b/content/flux/v0/stdlib/math/sinh.md index 78a409582..02015be64 100644 --- a/content/flux/v0/stdlib/math/sinh.md +++ b/content/flux/v0/stdlib/math/sinh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/sqrt.md b/content/flux/v0/stdlib/math/sqrt.md index 84c288a4b..71e68b4e7 100644 --- a/content/flux/v0/stdlib/math/sqrt.md +++ b/content/flux/v0/stdlib/math/sqrt.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/tan.md b/content/flux/v0/stdlib/math/tan.md index 863cb7bf1..ca7a0f69a 100644 --- a/content/flux/v0/stdlib/math/tan.md +++ b/content/flux/v0/stdlib/math/tan.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/tanh.md b/content/flux/v0/stdlib/math/tanh.md index e78b68f6f..e624c00e4 100644 --- a/content/flux/v0/stdlib/math/tanh.md +++ b/content/flux/v0/stdlib/math/tanh.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/trunc.md b/content/flux/v0/stdlib/math/trunc.md index 813568eb1..03e5bad39 100644 --- a/content/flux/v0/stdlib/math/trunc.md +++ b/content/flux/v0/stdlib/math/trunc.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/y0.md b/content/flux/v0/stdlib/math/y0.md index 46ce9a1c9..0be836505 100644 --- a/content/flux/v0/stdlib/math/y0.md +++ b/content/flux/v0/stdlib/math/y0.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/y1.md b/content/flux/v0/stdlib/math/y1.md index cc5e58b59..2ab3f5896 100644 --- a/content/flux/v0/stdlib/math/y1.md +++ b/content/flux/v0/stdlib/math/y1.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/math/yn.md b/content/flux/v0/stdlib/math/yn.md index a360fc45a..f5632faf2 100644 --- a/content/flux/v0/stdlib/math/yn.md +++ b/content/flux/v0/stdlib/math/yn.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (n: int, x: float) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/actionfromlevel.md b/content/flux/v0/stdlib/pagerduty/actionfromlevel.md index 84b94d9cc..aa864a59e 100644 --- a/content/flux/v0/stdlib/pagerduty/actionfromlevel.md +++ b/content/flux/v0/stdlib/pagerduty/actionfromlevel.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (level: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/actionfromseverity.md b/content/flux/v0/stdlib/pagerduty/actionfromseverity.md index 250ad9d02..412d9c983 100644 --- a/content/flux/v0/stdlib/pagerduty/actionfromseverity.md +++ b/content/flux/v0/stdlib/pagerduty/actionfromseverity.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (severity: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/dedupkey.md b/content/flux/v0/stdlib/pagerduty/dedupkey.md index 5d8093273..0a2091dad 100644 --- a/content/flux/v0/stdlib/pagerduty/dedupkey.md +++ b/content/flux/v0/stdlib/pagerduty/dedupkey.md @@ -42,7 +42,9 @@ group key to create a unique deduplication key for each input table. (<-tables: stream[A], ?exclude: [string]) => stream[{A with _pagerdutyDedupKey: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/endpoint.md b/content/flux/v0/stdlib/pagerduty/endpoint.md index 60d00b1bd..a8adbef57 100644 --- a/content/flux/v0/stdlib/pagerduty/endpoint.md +++ b/content/flux/v0/stdlib/pagerduty/endpoint.md @@ -77,7 +77,9 @@ following properties: ) => (<-tables: stream[A]) => stream[{A with _status: string, _sent: string, _pagerdutyDedupKey: string, _body: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/sendevent.md b/content/flux/v0/stdlib/pagerduty/sendevent.md index aba1014e7..f8c7d639b 100644 --- a/content/flux/v0/stdlib/pagerduty/sendevent.md +++ b/content/flux/v0/stdlib/pagerduty/sendevent.md @@ -52,7 +52,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => int where L: Equatable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pagerduty/severityfromlevel.md b/content/flux/v0/stdlib/pagerduty/severityfromlevel.md index a7c1e8752..c43888cfc 100644 --- a/content/flux/v0/stdlib/pagerduty/severityfromlevel.md +++ b/content/flux/v0/stdlib/pagerduty/severityfromlevel.md @@ -41,7 +41,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (level: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pushbullet/endpoint.md b/content/flux/v0/stdlib/pushbullet/endpoint.md index 0b0edf55e..c28fea807 100644 --- a/content/flux/v0/stdlib/pushbullet/endpoint.md +++ b/content/flux/v0/stdlib/pushbullet/endpoint.md @@ -52,7 +52,9 @@ following properties (as defined in `pushbullet.pushNote()`): ) => (mapFn: (r: B) => {C with title: E, text: D}) => (<-tables: stream[B]) => stream[{B with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pushbullet/pushdata.md b/content/flux/v0/stdlib/pushbullet/pushdata.md index 145aa17fc..f30dad681 100644 --- a/content/flux/v0/stdlib/pushbullet/pushdata.md +++ b/content/flux/v0/stdlib/pushbullet/pushdata.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (data: A, ?token: B, ?url: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/pushbullet/pushnote.md b/content/flux/v0/stdlib/pushbullet/pushnote.md index d5bc1f4b1..96d16cd35 100644 --- a/content/flux/v0/stdlib/pushbullet/pushnote.md +++ b/content/flux/v0/stdlib/pushbullet/pushnote.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (text: A, title: B, ?token: C, ?url: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/compile.md b/content/flux/v0/stdlib/regexp/compile.md index 5c7038841..9f044268e 100644 --- a/content/flux/v0/stdlib/regexp/compile.md +++ b/content/flux/v0/stdlib/regexp/compile.md @@ -39,7 +39,9 @@ that can be used to match against strings. (v: string) => regexp ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/findstring.md b/content/flux/v0/stdlib/regexp/findstring.md index ef95427bb..a71b3d88d 100644 --- a/content/flux/v0/stdlib/regexp/findstring.md +++ b/content/flux/v0/stdlib/regexp/findstring.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (r: regexp, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/findstringindex.md b/content/flux/v0/stdlib/regexp/findstringindex.md index 5d19b1459..656d0529d 100644 --- a/content/flux/v0/stdlib/regexp/findstringindex.md +++ b/content/flux/v0/stdlib/regexp/findstringindex.md @@ -38,7 +38,9 @@ beginning and ending indexes of the first regular expression match in a string. (r: regexp, v: string) => [int] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/getstring.md b/content/flux/v0/stdlib/regexp/getstring.md index dba3b118e..95fcb9ade 100644 --- a/content/flux/v0/stdlib/regexp/getstring.md +++ b/content/flux/v0/stdlib/regexp/getstring.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (r: regexp) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/matchregexpstring.md b/content/flux/v0/stdlib/regexp/matchregexpstring.md index 997eb0b51..d9d428abe 100644 --- a/content/flux/v0/stdlib/regexp/matchregexpstring.md +++ b/content/flux/v0/stdlib/regexp/matchregexpstring.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (r: regexp, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/quotemeta.md b/content/flux/v0/stdlib/regexp/quotemeta.md index 238bb75af..c1792473c 100644 --- a/content/flux/v0/stdlib/regexp/quotemeta.md +++ b/content/flux/v0/stdlib/regexp/quotemeta.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/replaceallstring.md b/content/flux/v0/stdlib/regexp/replaceallstring.md index 439cc9233..1604a9114 100644 --- a/content/flux/v0/stdlib/regexp/replaceallstring.md +++ b/content/flux/v0/stdlib/regexp/replaceallstring.md @@ -38,7 +38,9 @@ specified replacement. (r: regexp, t: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/regexp/splitregexp.md b/content/flux/v0/stdlib/regexp/splitregexp.md index f653c947c..752b7fa8e 100644 --- a/content/flux/v0/stdlib/regexp/splitregexp.md +++ b/content/flux/v0/stdlib/regexp/splitregexp.md @@ -38,7 +38,9 @@ matches and returns an array of `i` substrings between matches. (i: int, r: regexp, v: string) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/runtime/version.md b/content/flux/v0/stdlib/runtime/version.md index 795d214d7..4ace6b517 100644 --- a/content/flux/v0/stdlib/runtime/version.md +++ b/content/flux/v0/stdlib/runtime/version.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md () => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/sampledata/bool.md b/content/flux/v0/stdlib/sampledata/bool.md index 9ea63c2e1..95924f397 100644 --- a/content/flux/v0/stdlib/sampledata/bool.md +++ b/content/flux/v0/stdlib/sampledata/bool.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sampledata/float.md b/content/flux/v0/stdlib/sampledata/float.md index a724399f4..82c1d001f 100644 --- a/content/flux/v0/stdlib/sampledata/float.md +++ b/content/flux/v0/stdlib/sampledata/float.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sampledata/int.md b/content/flux/v0/stdlib/sampledata/int.md index 29f39581b..1ad9c4b75 100644 --- a/content/flux/v0/stdlib/sampledata/int.md +++ b/content/flux/v0/stdlib/sampledata/int.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[{A with _value: B, _value: int}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sampledata/numericbool.md b/content/flux/v0/stdlib/sampledata/numericbool.md index 57dca43cb..2c52c39f1 100644 --- a/content/flux/v0/stdlib/sampledata/numericbool.md +++ b/content/flux/v0/stdlib/sampledata/numericbool.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[{A with _value: B, _value: int}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sampledata/string.md b/content/flux/v0/stdlib/sampledata/string.md index 4a272453f..74d4131a2 100644 --- a/content/flux/v0/stdlib/sampledata/string.md +++ b/content/flux/v0/stdlib/sampledata/string.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sampledata/uint.md b/content/flux/v0/stdlib/sampledata/uint.md index b02212e0c..81c5b263a 100644 --- a/content/flux/v0/stdlib/sampledata/uint.md +++ b/content/flux/v0/stdlib/sampledata/uint.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (?includeNull: bool) => stream[{A with _value: B, _value: uint}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/slack/endpoint.md b/content/flux/v0/stdlib/slack/endpoint.md index 767bcc88a..e86a6ba35 100644 --- a/content/flux/v0/stdlib/slack/endpoint.md +++ b/content/flux/v0/stdlib/slack/endpoint.md @@ -57,7 +57,9 @@ following properties: ) => (<-tables: stream[A]) => stream[{A with _sent: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/slack/message.md b/content/flux/v0/stdlib/slack/message.md index 490c2545d..f2f96bf35 100644 --- a/content/flux/v0/stdlib/slack/message.md +++ b/content/flux/v0/stdlib/slack/message.md @@ -45,7 +45,9 @@ The function works with either with the `chat.postMessage` API or with a Slack w ) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/slack/validatecolorstring.md b/content/flux/v0/stdlib/slack/validatecolorstring.md index 79684cce4..5acb7cc8d 100644 --- a/content/flux/v0/stdlib/slack/validatecolorstring.md +++ b/content/flux/v0/stdlib/slack/validatecolorstring.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (color: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/socket/from.md b/content/flux/v0/stdlib/socket/from.md index 8fdedba72..ba4f5cfd6 100644 --- a/content/flux/v0/stdlib/socket/from.md +++ b/content/flux/v0/stdlib/socket/from.md @@ -40,7 +40,9 @@ start to the end of the connection. (url: string, ?decoder: string) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sql/from.md b/content/flux/v0/stdlib/sql/from.md index 92d1feda7..8cda3c1ed 100644 --- a/content/flux/v0/stdlib/sql/from.md +++ b/content/flux/v0/stdlib/sql/from.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (dataSourceName: string, driverName: string, query: string) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/sql/to.md b/content/flux/v0/stdlib/sql/to.md index 401c27bd3..79d856581 100644 --- a/content/flux/v0/stdlib/sql/to.md +++ b/content/flux/v0/stdlib/sql/to.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/compare.md b/content/flux/v0/stdlib/strings/compare.md index cd480f2d9..85f53f806 100644 --- a/content/flux/v0/stdlib/strings/compare.md +++ b/content/flux/v0/stdlib/strings/compare.md @@ -41,7 +41,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/containsany.md b/content/flux/v0/stdlib/strings/containsany.md index 1ca1f12ba..0e61f5972 100644 --- a/content/flux/v0/stdlib/strings/containsany.md +++ b/content/flux/v0/stdlib/strings/containsany.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (chars: string, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/containsstr.md b/content/flux/v0/stdlib/strings/containsstr.md index 22b0c839a..cb66915bd 100644 --- a/content/flux/v0/stdlib/strings/containsstr.md +++ b/content/flux/v0/stdlib/strings/containsstr.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (substr: string, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/countstr.md b/content/flux/v0/stdlib/strings/countstr.md index ff3f5d678..dce7498ff 100644 --- a/content/flux/v0/stdlib/strings/countstr.md +++ b/content/flux/v0/stdlib/strings/countstr.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (substr: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/equalfold.md b/content/flux/v0/stdlib/strings/equalfold.md index af303fc1d..abb313ab1 100644 --- a/content/flux/v0/stdlib/strings/equalfold.md +++ b/content/flux/v0/stdlib/strings/equalfold.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: string, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/hasprefix.md b/content/flux/v0/stdlib/strings/hasprefix.md index 0283c7e9d..3710a7380 100644 --- a/content/flux/v0/stdlib/strings/hasprefix.md +++ b/content/flux/v0/stdlib/strings/hasprefix.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (prefix: string, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/hassuffix.md b/content/flux/v0/stdlib/strings/hassuffix.md index e2526340f..610d8029a 100644 --- a/content/flux/v0/stdlib/strings/hassuffix.md +++ b/content/flux/v0/stdlib/strings/hassuffix.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (suffix: string, v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/index-fn.md b/content/flux/v0/stdlib/strings/index-fn.md index 20cef5841..b84506687 100644 --- a/content/flux/v0/stdlib/strings/index-fn.md +++ b/content/flux/v0/stdlib/strings/index-fn.md @@ -38,7 +38,9 @@ If the substring is not present, it returns `-1`. (substr: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/indexany.md b/content/flux/v0/stdlib/strings/indexany.md index 5084c236c..d559c6b52 100644 --- a/content/flux/v0/stdlib/strings/indexany.md +++ b/content/flux/v0/stdlib/strings/indexany.md @@ -38,7 +38,9 @@ If none of the specified characters are present, it returns `-1`. (chars: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/isdigit.md b/content/flux/v0/stdlib/strings/isdigit.md index 9b0f59f48..fd3c19a12 100644 --- a/content/flux/v0/stdlib/strings/isdigit.md +++ b/content/flux/v0/stdlib/strings/isdigit.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/isletter.md b/content/flux/v0/stdlib/strings/isletter.md index 03fbdc73d..564f18ab0 100644 --- a/content/flux/v0/stdlib/strings/isletter.md +++ b/content/flux/v0/stdlib/strings/isletter.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/islower.md b/content/flux/v0/stdlib/strings/islower.md index 02d9a3e2f..68308022c 100644 --- a/content/flux/v0/stdlib/strings/islower.md +++ b/content/flux/v0/stdlib/strings/islower.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/isupper.md b/content/flux/v0/stdlib/strings/isupper.md index 242ba8514..3615b7e80 100644 --- a/content/flux/v0/stdlib/strings/isupper.md +++ b/content/flux/v0/stdlib/strings/isupper.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/joinstr.md b/content/flux/v0/stdlib/strings/joinstr.md index 8761abc93..42febe4a5 100644 --- a/content/flux/v0/stdlib/strings/joinstr.md +++ b/content/flux/v0/stdlib/strings/joinstr.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (arr: [string], v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/lastindex.md b/content/flux/v0/stdlib/strings/lastindex.md index 4412a99aa..13451f5fe 100644 --- a/content/flux/v0/stdlib/strings/lastindex.md +++ b/content/flux/v0/stdlib/strings/lastindex.md @@ -38,7 +38,9 @@ If the substring is not present, the function returns -1. (substr: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/lastindexany.md b/content/flux/v0/stdlib/strings/lastindexany.md index 9eb898e20..672b6f69a 100644 --- a/content/flux/v0/stdlib/strings/lastindexany.md +++ b/content/flux/v0/stdlib/strings/lastindexany.md @@ -40,7 +40,9 @@ If none of the specified characters are present, the function returns `-1`. (chars: string, v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/repeat.md b/content/flux/v0/stdlib/strings/repeat.md index 9a1c5fe1c..33dffc32f 100644 --- a/content/flux/v0/stdlib/strings/repeat.md +++ b/content/flux/v0/stdlib/strings/repeat.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (i: int, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/replace.md b/content/flux/v0/stdlib/strings/replace.md index 08a882452..7d05f5931 100644 --- a/content/flux/v0/stdlib/strings/replace.md +++ b/content/flux/v0/stdlib/strings/replace.md @@ -38,7 +38,9 @@ a specified replacement. (i: int, t: string, u: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/replaceall.md b/content/flux/v0/stdlib/strings/replaceall.md index 59f3308ea..737c42a3d 100644 --- a/content/flux/v0/stdlib/strings/replaceall.md +++ b/content/flux/v0/stdlib/strings/replaceall.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: string, u: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/split.md b/content/flux/v0/stdlib/strings/split.md index 83adac372..520fb130f 100644 --- a/content/flux/v0/stdlib/strings/split.md +++ b/content/flux/v0/stdlib/strings/split.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (t: string, v: string) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/splitafter.md b/content/flux/v0/stdlib/strings/splitafter.md index e8e69769b..f52b824c5 100644 --- a/content/flux/v0/stdlib/strings/splitafter.md +++ b/content/flux/v0/stdlib/strings/splitafter.md @@ -38,7 +38,9 @@ Split substrings include the separator, `t`. (t: string, v: string) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/splitaftern.md b/content/flux/v0/stdlib/strings/splitaftern.md index f97f88f3b..544d7fd49 100644 --- a/content/flux/v0/stdlib/strings/splitaftern.md +++ b/content/flux/v0/stdlib/strings/splitaftern.md @@ -38,7 +38,9 @@ Split substrings include the separator, `t`. (i: int, t: string, v: string) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/splitn.md b/content/flux/v0/stdlib/strings/splitn.md index 90e3968fd..637ee16f0 100644 --- a/content/flux/v0/stdlib/strings/splitn.md +++ b/content/flux/v0/stdlib/strings/splitn.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (i: int, t: string, v: string) => [string] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/strlen.md b/content/flux/v0/stdlib/strings/strlen.md index 67ce942af..b156517c0 100644 --- a/content/flux/v0/stdlib/strings/strlen.md +++ b/content/flux/v0/stdlib/strings/strlen.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/substring.md b/content/flux/v0/stdlib/strings/substring.md index 7c4d98abc..738dc8675 100644 --- a/content/flux/v0/stdlib/strings/substring.md +++ b/content/flux/v0/stdlib/strings/substring.md @@ -39,7 +39,9 @@ is assumed. When end is less than or equal to start an empty string is returned. (end: int, start: int, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/title.md b/content/flux/v0/stdlib/strings/title.md index 4e3a0e232..1e16bf890 100644 --- a/content/flux/v0/stdlib/strings/title.md +++ b/content/flux/v0/stdlib/strings/title.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/tolower.md b/content/flux/v0/stdlib/strings/tolower.md index ca33b5745..2214ea762 100644 --- a/content/flux/v0/stdlib/strings/tolower.md +++ b/content/flux/v0/stdlib/strings/tolower.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/totitle.md b/content/flux/v0/stdlib/strings/totitle.md index e857746b8..d612c2670 100644 --- a/content/flux/v0/stdlib/strings/totitle.md +++ b/content/flux/v0/stdlib/strings/totitle.md @@ -45,7 +45,9 @@ strings.toUpper(v: str) // Returns DZ (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/toupper.md b/content/flux/v0/stdlib/strings/toupper.md index 1b52f903f..97c15432d 100644 --- a/content/flux/v0/stdlib/strings/toupper.md +++ b/content/flux/v0/stdlib/strings/toupper.md @@ -45,7 +45,9 @@ strings.toTitle(v: str) // Returns Dz (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trim.md b/content/flux/v0/stdlib/strings/trim.md index 367ecf9dd..1eccb94b8 100644 --- a/content/flux/v0/stdlib/strings/trim.md +++ b/content/flux/v0/stdlib/strings/trim.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (cutset: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trimleft.md b/content/flux/v0/stdlib/strings/trimleft.md index ec56a6ee7..b8e2cd722 100644 --- a/content/flux/v0/stdlib/strings/trimleft.md +++ b/content/flux/v0/stdlib/strings/trimleft.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (cutset: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trimprefix.md b/content/flux/v0/stdlib/strings/trimprefix.md index 78b766733..9cafd5c0a 100644 --- a/content/flux/v0/stdlib/strings/trimprefix.md +++ b/content/flux/v0/stdlib/strings/trimprefix.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (prefix: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trimright.md b/content/flux/v0/stdlib/strings/trimright.md index 19da4fd4d..a0834e90d 100644 --- a/content/flux/v0/stdlib/strings/trimright.md +++ b/content/flux/v0/stdlib/strings/trimright.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (cutset: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trimspace.md b/content/flux/v0/stdlib/strings/trimspace.md index e477d73e2..ecd6da1ec 100644 --- a/content/flux/v0/stdlib/strings/trimspace.md +++ b/content/flux/v0/stdlib/strings/trimspace.md @@ -36,7 +36,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/strings/trimsuffix.md b/content/flux/v0/stdlib/strings/trimsuffix.md index 6776c2585..94fc40e63 100644 --- a/content/flux/v0/stdlib/strings/trimsuffix.md +++ b/content/flux/v0/stdlib/strings/trimsuffix.md @@ -36,7 +36,9 @@ Strings that do not end with the suffix are returned unchanged. (suffix: string, v: string) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/system/time.md b/content/flux/v0/stdlib/system/time.md index 5512466e4..d8ef3a185 100644 --- a/content/flux/v0/stdlib/system/time.md +++ b/content/flux/v0/stdlib/system/time.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md () => time ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/testing/assertempty.md b/content/flux/v0/stdlib/testing/assertempty.md index 9cda97a53..2f801f4a0 100644 --- a/content/flux/v0/stdlib/testing/assertempty.md +++ b/content/flux/v0/stdlib/testing/assertempty.md @@ -38,7 +38,9 @@ assertEmpty can be used to perform in-line tests in a query. (<-tables: stream[A]) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/assertequals.md b/content/flux/v0/stdlib/testing/assertequals.md index b45622488..65c406c05 100644 --- a/content/flux/v0/stdlib/testing/assertequals.md +++ b/content/flux/v0/stdlib/testing/assertequals.md @@ -40,7 +40,9 @@ assertEquals can be used to perform in-line tests in a query. (<-got: stream[A], name: string, want: stream[A]) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/assertequalvalues.md b/content/flux/v0/stdlib/testing/assertequalvalues.md index da450ea4a..5173ae13f 100644 --- a/content/flux/v0/stdlib/testing/assertequalvalues.md +++ b/content/flux/v0/stdlib/testing/assertequalvalues.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (got: A, want: A) => stream[{v: A, _diff: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/diff.md b/content/flux/v0/stdlib/testing/diff.md index ac8171302..4c9a4426a 100644 --- a/content/flux/v0/stdlib/testing/diff.md +++ b/content/flux/v0/stdlib/testing/diff.md @@ -54,7 +54,9 @@ The exact diff produced may change. ) => stream[{A with _diff: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/expect/planner.md b/content/flux/v0/stdlib/testing/expect/planner.md index 08e7e88be..2b8ea7a96 100644 --- a/content/flux/v0/stdlib/testing/expect/planner.md +++ b/content/flux/v0/stdlib/testing/expect/planner.md @@ -40,7 +40,9 @@ The key is the name of the planner rule. (rules: [string:int]) => {} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/load.md b/content/flux/v0/stdlib/testing/load.md index 3d8f58d30..ba8cf3130 100644 --- a/content/flux/v0/stdlib/testing/load.md +++ b/content/flux/v0/stdlib/testing/load.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: A) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/testing/shoulderror.md b/content/flux/v0/stdlib/testing/shoulderror.md index 68ad3418c..e59897fec 100644 --- a/content/flux/v0/stdlib/testing/shoulderror.md +++ b/content/flux/v0/stdlib/testing/shoulderror.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (fn: () => A, want: regexp) => stream[{v: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/timezone/fixed.md b/content/flux/v0/stdlib/timezone/fixed.md index 5f6da5147..458420782 100644 --- a/content/flux/v0/stdlib/timezone/fixed.md +++ b/content/flux/v0/stdlib/timezone/fixed.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (offset: A) => {zone: string, offset: A} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/timezone/location.md b/content/flux/v0/stdlib/timezone/location.md index c08c89560..4fcaf06e4 100644 --- a/content/flux/v0/stdlib/timezone/location.md +++ b/content/flux/v0/stdlib/timezone/location.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (name: string) => {zone: string, offset: duration} ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/types/isnumeric.md b/content/flux/v0/stdlib/types/isnumeric.md index 1571c90a2..cb815c5b2 100644 --- a/content/flux/v0/stdlib/types/isnumeric.md +++ b/content/flux/v0/stdlib/types/isnumeric.md @@ -39,7 +39,9 @@ arithmetic operations or aggregations. (v: A) => bool where A: Basic ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/types/istype.md b/content/flux/v0/stdlib/types/istype.md index c8c116449..152386fdd 100644 --- a/content/flux/v0/stdlib/types/istype.md +++ b/content/flux/v0/stdlib/types/istype.md @@ -37,7 +37,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (type: string, v: A) => bool where A: Basic ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/aggregatewindow.md b/content/flux/v0/stdlib/universe/aggregatewindow.md index 4d2cfa50f..7cb313619 100644 --- a/content/flux/v0/stdlib/universe/aggregatewindow.md +++ b/content/flux/v0/stdlib/universe/aggregatewindow.md @@ -68,7 +68,9 @@ calculated weeks begin on Thursday. ) => stream[E] where B: Record, C: Record, D: Record, E: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/bool.md b/content/flux/v0/stdlib/universe/bool.md index 745de0d9f..8ace06844 100644 --- a/content/flux/v0/stdlib/universe/bool.md +++ b/content/flux/v0/stdlib/universe/bool.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => bool ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/bottom.md b/content/flux/v0/stdlib/universe/bottom.md index f760e2555..b5e39ff05 100644 --- a/content/flux/v0/stdlib/universe/bottom.md +++ b/content/flux/v0/stdlib/universe/bottom.md @@ -40,7 +40,9 @@ records in each table. (<-tables: stream[A], n: int, ?columns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/bytes.md b/content/flux/v0/stdlib/universe/bytes.md index 73c47043a..5877eb59f 100644 --- a/content/flux/v0/stdlib/universe/bytes.md +++ b/content/flux/v0/stdlib/universe/bytes.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => bytes ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/chandemomentumoscillator.md b/content/flux/v0/stdlib/universe/chandemomentumoscillator.md index e82552c7d..598dd3fa8 100644 --- a/content/flux/v0/stdlib/universe/chandemomentumoscillator.md +++ b/content/flux/v0/stdlib/universe/chandemomentumoscillator.md @@ -51,7 +51,9 @@ table with `x - n` rows. (<-tables: stream[A], n: int, ?columns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/columns.md b/content/flux/v0/stdlib/universe/columns.md index 166b62078..92f79751b 100644 --- a/content/flux/v0/stdlib/universe/columns.md +++ b/content/flux/v0/stdlib/universe/columns.md @@ -43,7 +43,9 @@ input table. (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/contains.md b/content/flux/v0/stdlib/universe/contains.md index 85fbf15af..724259478 100644 --- a/content/flux/v0/stdlib/universe/contains.md +++ b/content/flux/v0/stdlib/universe/contains.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (set: [A], value: A) => bool where A: Nullable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/count.md b/content/flux/v0/stdlib/universe/count.md index db0c682f8..922731075 100644 --- a/content/flux/v0/stdlib/universe/count.md +++ b/content/flux/v0/stdlib/universe/count.md @@ -49,7 +49,9 @@ following functions: (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/cov.md b/content/flux/v0/stdlib/universe/cov.md index d73c850d9..fffbf51a7 100644 --- a/content/flux/v0/stdlib/universe/cov.md +++ b/content/flux/v0/stdlib/universe/cov.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (on: [string], x: A, y: B, ?pearsonr: bool) => stream[C] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/covariance.md b/content/flux/v0/stdlib/universe/covariance.md index 835f15a28..bfc931ac2 100644 --- a/content/flux/v0/stdlib/universe/covariance.md +++ b/content/flux/v0/stdlib/universe/covariance.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], columns: [string], ?pearsonr: bool, ?valueDst: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/cumulativesum.md b/content/flux/v0/stdlib/universe/cumulativesum.md index 76f6d5d0d..615a721f0 100644 --- a/content/flux/v0/stdlib/universe/cumulativesum.md +++ b/content/flux/v0/stdlib/universe/cumulativesum.md @@ -38,7 +38,9 @@ The output table schema will be the same as the input table. (<-tables: stream[A], ?columns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/derivative.md b/content/flux/v0/stdlib/universe/derivative.md index e34deefae..9d7b21ac3 100644 --- a/content/flux/v0/stdlib/universe/derivative.md +++ b/content/flux/v0/stdlib/universe/derivative.md @@ -52,7 +52,9 @@ For each input table with `n` rows, `derivative()` outputs a table with ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/die.md b/content/flux/v0/stdlib/universe/die.md index 96492f42c..35edf0849 100644 --- a/content/flux/v0/stdlib/universe/die.md +++ b/content/flux/v0/stdlib/universe/die.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (msg: string) => A ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/difference.md b/content/flux/v0/stdlib/universe/difference.md index 0b15ff80a..a729e022f 100644 --- a/content/flux/v0/stdlib/universe/difference.md +++ b/content/flux/v0/stdlib/universe/difference.md @@ -56,7 +56,9 @@ For each input table with `n` rows, `difference()` outputs a table with ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/display.md b/content/flux/v0/stdlib/universe/display.md index f8ed929b6..2056a4371 100644 --- a/content/flux/v0/stdlib/universe/display.md +++ b/content/flux/v0/stdlib/universe/display.md @@ -49,7 +49,9 @@ composite types to strings. `string()` does not operate on composite types. (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/distinct.md b/content/flux/v0/stdlib/universe/distinct.md index fc9f740dc..1824d8303 100644 --- a/content/flux/v0/stdlib/universe/distinct.md +++ b/content/flux/v0/stdlib/universe/distinct.md @@ -39,7 +39,9 @@ The `_value` of each output record is set to a distinct value in the specified c (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/doubleema.md b/content/flux/v0/stdlib/universe/doubleema.md index ff82b94e2..e33c1d2c0 100644 --- a/content/flux/v0/stdlib/universe/doubleema.md +++ b/content/flux/v0/stdlib/universe/doubleema.md @@ -48,7 +48,9 @@ recent data. (<-tables: stream[{A with _value: B}], n: int) => stream[C] where B: Numeric, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/drop.md b/content/flux/v0/stdlib/universe/drop.md index b629e2528..7e1980687 100644 --- a/content/flux/v0/stdlib/universe/drop.md +++ b/content/flux/v0/stdlib/universe/drop.md @@ -40,7 +40,9 @@ If a specified column is not present in a table, the function returns an error. (<-tables: stream[A], ?columns: [string], ?fn: (column: string) => bool) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/duplicate.md b/content/flux/v0/stdlib/universe/duplicate.md index 2c6aae511..c247f7a43 100644 --- a/content/flux/v0/stdlib/universe/duplicate.md +++ b/content/flux/v0/stdlib/universe/duplicate.md @@ -39,7 +39,9 @@ the duplicate column will not be part of the output’s group key. (<-tables: stream[A], as: string, column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/duration.md b/content/flux/v0/stdlib/universe/duration.md index 9f5d59ff6..87e0c4459 100644 --- a/content/flux/v0/stdlib/universe/duration.md +++ b/content/flux/v0/stdlib/universe/duration.md @@ -40,7 +40,9 @@ duration literal representation. (v: A) => duration ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/elapsed.md b/content/flux/v0/stdlib/universe/elapsed.md index 329a2b4fa..1ddb2bb14 100644 --- a/content/flux/v0/stdlib/universe/elapsed.md +++ b/content/flux/v0/stdlib/universe/elapsed.md @@ -40,7 +40,9 @@ additional column containing the elapsed time. (<-tables: stream[A], ?columnName: string, ?timeColumn: string, ?unit: duration) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/exponentialmovingaverage.md b/content/flux/v0/stdlib/universe/exponentialmovingaverage.md index d618bb000..9747ab9fa 100644 --- a/content/flux/v0/stdlib/universe/exponentialmovingaverage.md +++ b/content/flux/v0/stdlib/universe/exponentialmovingaverage.md @@ -48,7 +48,9 @@ number of values in the `_value` column giving more weight to more recent data. (<-tables: stream[{A with _value: B}], n: int) => stream[{A with _value: B}] where B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/fill.md b/content/flux/v0/stdlib/universe/fill.md index 67fa29c3b..463b8f805 100644 --- a/content/flux/v0/stdlib/universe/fill.md +++ b/content/flux/v0/stdlib/universe/fill.md @@ -39,7 +39,9 @@ in the specified column. (<-tables: stream[B], ?column: string, ?usePrevious: bool, ?value: A) => stream[C] where B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/filter.md b/content/flux/v0/stdlib/universe/filter.md index f96137b07..82fb38505 100644 --- a/content/flux/v0/stdlib/universe/filter.md +++ b/content/flux/v0/stdlib/universe/filter.md @@ -38,7 +38,9 @@ Output tables have the same schema as the corresponding input tables. (<-tables: stream[A], fn: (r: A) => bool, ?onEmpty: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/findcolumn.md b/content/flux/v0/stdlib/universe/findcolumn.md index 1ab266ffd..7a39ec95d 100644 --- a/content/flux/v0/stdlib/universe/findcolumn.md +++ b/content/flux/v0/stdlib/universe/findcolumn.md @@ -41,7 +41,9 @@ label is not present in the set of columns. (<-tables: stream[B], column: string, fn: (key: A) => bool) => [C] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/findrecord.md b/content/flux/v0/stdlib/universe/findrecord.md index b4b3255d1..cfeac5480 100644 --- a/content/flux/v0/stdlib/universe/findrecord.md +++ b/content/flux/v0/stdlib/universe/findrecord.md @@ -41,7 +41,9 @@ out of bounds. (<-tables: stream[B], fn: (key: A) => bool, idx: int) => B where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/first.md b/content/flux/v0/stdlib/universe/first.md index e1e31af3c..d43067c88 100644 --- a/content/flux/v0/stdlib/universe/first.md +++ b/content/flux/v0/stdlib/universe/first.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?column: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/float.md b/content/flux/v0/stdlib/universe/float.md index 98ffb8c1b..5104cb3dc 100644 --- a/content/flux/v0/stdlib/universe/float.md +++ b/content/flux/v0/stdlib/universe/float.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => float ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/getcolumn.md b/content/flux/v0/stdlib/universe/getcolumn.md index 21319230a..80479bb50 100644 --- a/content/flux/v0/stdlib/universe/getcolumn.md +++ b/content/flux/v0/stdlib/universe/getcolumn.md @@ -38,7 +38,9 @@ If the specified column is not present in the table, the function returns an err (<-table: stream[A], column: string) => [B] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/getrecord.md b/content/flux/v0/stdlib/universe/getrecord.md index 2ec1147ba..ee560c69e 100644 --- a/content/flux/v0/stdlib/universe/getrecord.md +++ b/content/flux/v0/stdlib/universe/getrecord.md @@ -38,7 +38,9 @@ If the specified index is out of bounds, the function returns an error. (<-table: stream[A], idx: int) => A where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/group.md b/content/flux/v0/stdlib/universe/group.md index cf80f8e88..034ee58e8 100644 --- a/content/flux/v0/stdlib/universe/group.md +++ b/content/flux/v0/stdlib/universe/group.md @@ -39,7 +39,9 @@ To ensure data is sorted correctly, use `sort()` after `group()`. (<-tables: stream[A], ?columns: [string], ?mode: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/highestaverage.md b/content/flux/v0/stdlib/universe/highestaverage.md index e9a626abf..39af2f011 100644 --- a/content/flux/v0/stdlib/universe/highestaverage.md +++ b/content/flux/v0/stdlib/universe/highestaverage.md @@ -40,7 +40,9 @@ highest `n` averages. (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/highestcurrent.md b/content/flux/v0/stdlib/universe/highestcurrent.md index c2b21751b..03412e7e9 100644 --- a/content/flux/v0/stdlib/universe/highestcurrent.md +++ b/content/flux/v0/stdlib/universe/highestcurrent.md @@ -40,7 +40,9 @@ highest `n` records. (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/highestmax.md b/content/flux/v0/stdlib/universe/highestmax.md index ca59b1d9e..f64373f53 100644 --- a/content/flux/v0/stdlib/universe/highestmax.md +++ b/content/flux/v0/stdlib/universe/highestmax.md @@ -40,7 +40,9 @@ from each input table and returns the highest `n` records. (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/histogram.md b/content/flux/v0/stdlib/universe/histogram.md index e89b112d2..ca8f741ff 100644 --- a/content/flux/v0/stdlib/universe/histogram.md +++ b/content/flux/v0/stdlib/universe/histogram.md @@ -53,7 +53,9 @@ Output tables include additional columns for the upper bound and count of bins. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/histogramquantile.md b/content/flux/v0/stdlib/universe/histogramquantile.md index 43628af22..5bcea433c 100644 --- a/content/flux/v0/stdlib/universe/histogramquantile.md +++ b/content/flux/v0/stdlib/universe/histogramquantile.md @@ -64,7 +64,9 @@ The value column represents the value of the desired quantile from the histogram ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/holtwinters.md b/content/flux/v0/stdlib/universe/holtwinters.md index ab67c7266..1bd3e2eb6 100644 --- a/content/flux/v0/stdlib/universe/holtwinters.md +++ b/content/flux/v0/stdlib/universe/holtwinters.md @@ -84,7 +84,9 @@ in the Holt-Winters calculation. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/hourselection.md b/content/flux/v0/stdlib/universe/hourselection.md index f80582e5e..1b06d4839 100644 --- a/content/flux/v0/stdlib/universe/hourselection.md +++ b/content/flux/v0/stdlib/universe/hourselection.md @@ -44,7 +44,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/increase.md b/content/flux/v0/stdlib/universe/increase.md index a154bbbf7..e5a81db9f 100644 --- a/content/flux/v0/stdlib/universe/increase.md +++ b/content/flux/v0/stdlib/universe/increase.md @@ -41,7 +41,9 @@ points is at least their non-negative difference. (<-tables: stream[A], ?columns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/int.md b/content/flux/v0/stdlib/universe/int.md index db7888b71..2c5fc61a9 100644 --- a/content/flux/v0/stdlib/universe/int.md +++ b/content/flux/v0/stdlib/universe/int.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/integral.md b/content/flux/v0/stdlib/universe/integral.md index c4b258083..922a33e47 100644 --- a/content/flux/v0/stdlib/universe/integral.md +++ b/content/flux/v0/stdlib/universe/integral.md @@ -45,7 +45,9 @@ The curve is defined using `_time` as the domain and record values as the range. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/join.md b/content/flux/v0/stdlib/universe/join.md index 12fa4e5aa..3b3163054 100644 --- a/content/flux/v0/stdlib/universe/join.md +++ b/content/flux/v0/stdlib/universe/join.md @@ -63,7 +63,9 @@ into a single stream of tables and groups rows of data based on existing group k (<-tables: A, ?method: string, ?on: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/kaufmansama.md b/content/flux/v0/stdlib/universe/kaufmansama.md index fb0ba29e0..fb7757b28 100644 --- a/content/flux/v0/stdlib/universe/kaufmansama.md +++ b/content/flux/v0/stdlib/universe/kaufmansama.md @@ -41,7 +41,9 @@ account for market noise or volatility. (<-tables: stream[A], n: int, ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/kaufmanser.md b/content/flux/v0/stdlib/universe/kaufmanser.md index 096648e08..6059c8e06 100644 --- a/content/flux/v0/stdlib/universe/kaufmanser.md +++ b/content/flux/v0/stdlib/universe/kaufmanser.md @@ -42,7 +42,9 @@ Higher values represent a more efficient or trending market. (<-tables: stream[A], n: int) => stream[{B with _value: float, _value: float}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/keep.md b/content/flux/v0/stdlib/universe/keep.md index 97fefe62d..b48d139e3 100644 --- a/content/flux/v0/stdlib/universe/keep.md +++ b/content/flux/v0/stdlib/universe/keep.md @@ -40,7 +40,9 @@ from output tables. `keep()` is the inverse of `drop()`. (<-tables: stream[A], ?columns: [string], ?fn: (column: string) => bool) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/keys.md b/content/flux/v0/stdlib/universe/keys.md index 424a7393c..d86458287 100644 --- a/content/flux/v0/stdlib/universe/keys.md +++ b/content/flux/v0/stdlib/universe/keys.md @@ -40,7 +40,9 @@ All columns not in the group key are dropped. (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/keyvalues.md b/content/flux/v0/stdlib/universe/keyvalues.md index 72dadd3e3..0fc688483 100644 --- a/content/flux/v0/stdlib/universe/keyvalues.md +++ b/content/flux/v0/stdlib/universe/keyvalues.md @@ -42,7 +42,9 @@ pairs for each input table. (<-tables: stream[A], ?keyColumns: [string]) => stream[{B with _value: C, _key: string}] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/last.md b/content/flux/v0/stdlib/universe/last.md index 118b2e619..5fa0a8d63 100644 --- a/content/flux/v0/stdlib/universe/last.md +++ b/content/flux/v0/stdlib/universe/last.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?column: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/length.md b/content/flux/v0/stdlib/universe/length.md index e8ae07e8f..a143a049d 100644 --- a/content/flux/v0/stdlib/universe/length.md +++ b/content/flux/v0/stdlib/universe/length.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-arr: [A]) => int ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/limit.md b/content/flux/v0/stdlib/universe/limit.md index ecd4ffb93..c9bc4bdf9 100644 --- a/content/flux/v0/stdlib/universe/limit.md +++ b/content/flux/v0/stdlib/universe/limit.md @@ -39,7 +39,9 @@ after the offset. (<-tables: stream[A], n: int, ?offset: int) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/linearbins.md b/content/flux/v0/stdlib/universe/linearbins.md index 06c521e6d..46e764330 100644 --- a/content/flux/v0/stdlib/universe/linearbins.md +++ b/content/flux/v0/stdlib/universe/linearbins.md @@ -38,7 +38,9 @@ Use `linearBins()` to generate bin bounds for `histogram()`. (count: int, start: float, width: float, ?infinity: bool) => [float] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/logarithmicbins.md b/content/flux/v0/stdlib/universe/logarithmicbins.md index 969cbab53..d488abdfb 100644 --- a/content/flux/v0/stdlib/universe/logarithmicbins.md +++ b/content/flux/v0/stdlib/universe/logarithmicbins.md @@ -38,7 +38,9 @@ Use `linearBins()` to generate bin bounds for `histogram()`. (count: int, factor: float, start: float, ?infinity: bool) => [float] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/lowestaverage.md b/content/flux/v0/stdlib/universe/lowestaverage.md index 3397b4be4..0c9b31451 100644 --- a/content/flux/v0/stdlib/universe/lowestaverage.md +++ b/content/flux/v0/stdlib/universe/lowestaverage.md @@ -40,7 +40,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/lowestcurrent.md b/content/flux/v0/stdlib/universe/lowestcurrent.md index ac28888cc..409381d11 100644 --- a/content/flux/v0/stdlib/universe/lowestcurrent.md +++ b/content/flux/v0/stdlib/universe/lowestcurrent.md @@ -40,7 +40,9 @@ lowest `n` records. (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/lowestmin.md b/content/flux/v0/stdlib/universe/lowestmin.md index 3acd6c467..244552716 100644 --- a/content/flux/v0/stdlib/universe/lowestmin.md +++ b/content/flux/v0/stdlib/universe/lowestmin.md @@ -40,7 +40,9 @@ from each input table and returns the bottom `n` records. (<-tables: stream[A], n: int, ?column: string, ?groupColumns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/map.md b/content/flux/v0/stdlib/universe/map.md index 66325cdb1..c632e632c 100644 --- a/content/flux/v0/stdlib/universe/map.md +++ b/content/flux/v0/stdlib/universe/map.md @@ -68,7 +68,9 @@ data (<-tables: stream[A], fn: (r: A) => B, ?mergeKey: bool) => stream[B] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/max.md b/content/flux/v0/stdlib/universe/max.md index 722e559c0..470e96455 100644 --- a/content/flux/v0/stdlib/universe/max.md +++ b/content/flux/v0/stdlib/universe/max.md @@ -40,7 +40,9 @@ input table. (<-tables: stream[A], ?column: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/mean.md b/content/flux/v0/stdlib/universe/mean.md index ae26f699e..7ab746237 100644 --- a/content/flux/v0/stdlib/universe/mean.md +++ b/content/flux/v0/stdlib/universe/mean.md @@ -40,7 +40,9 @@ input table. (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/median.md b/content/flux/v0/stdlib/universe/median.md index a5d6bcbeb..975836ba3 100644 --- a/content/flux/v0/stdlib/universe/median.md +++ b/content/flux/v0/stdlib/universe/median.md @@ -49,7 +49,9 @@ specified `method`. (<-tables: stream[A], ?column: string, ?compression: float, ?method: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/min.md b/content/flux/v0/stdlib/universe/min.md index 5700157b3..ab5297fb5 100644 --- a/content/flux/v0/stdlib/universe/min.md +++ b/content/flux/v0/stdlib/universe/min.md @@ -40,7 +40,9 @@ input table. (<-tables: stream[A], ?column: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/mode.md b/content/flux/v0/stdlib/universe/mode.md index afa1c1417..60316f7dc 100644 --- a/content/flux/v0/stdlib/universe/mode.md +++ b/content/flux/v0/stdlib/universe/mode.md @@ -43,7 +43,9 @@ If there is no mode, `mode()` returns `null`. (<-tables: stream[A], ?column: string) => stream[{B with _value: C}] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/movingaverage.md b/content/flux/v0/stdlib/universe/movingaverage.md index 092658128..7ab709aaf 100644 --- a/content/flux/v0/stdlib/universe/movingaverage.md +++ b/content/flux/v0/stdlib/universe/movingaverage.md @@ -45,7 +45,9 @@ and `n - 1` previous values in the `_values` column. (<-tables: stream[{A with _value: B}], n: int) => stream[{A with _value: float}] where B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/now.md b/content/flux/v0/stdlib/universe/now.md index a1e2518eb..85570f510 100644 --- a/content/flux/v0/stdlib/universe/now.md +++ b/content/flux/v0/stdlib/universe/now.md @@ -42,7 +42,9 @@ Each instance of `system.time()` in a Flux script returns a unique value. () => time ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/universe/pearsonr.md b/content/flux/v0/stdlib/universe/pearsonr.md index 8724fa889..d8740ee75 100644 --- a/content/flux/v0/stdlib/universe/pearsonr.md +++ b/content/flux/v0/stdlib/universe/pearsonr.md @@ -40,7 +40,9 @@ Pearson R coefficient. (on: [string], x: A, y: B) => stream[C] where C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/pivot.md b/content/flux/v0/stdlib/universe/pivot.md index a94d519ca..52c9db48f 100644 --- a/content/flux/v0/stdlib/universe/pivot.md +++ b/content/flux/v0/stdlib/universe/pivot.md @@ -67,7 +67,9 @@ The output is constructed as follows: (<-tables: stream[A], columnKey: [string], rowKey: [string], valueColumn: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/quantile.md b/content/flux/v0/stdlib/universe/quantile.md index 80202ff44..0360662e8 100644 --- a/content/flux/v0/stdlib/universe/quantile.md +++ b/content/flux/v0/stdlib/universe/quantile.md @@ -59,7 +59,9 @@ specified `method`. ) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/range.md b/content/flux/v0/stdlib/universe/range.md index a4191df5c..4e78f1a07 100644 --- a/content/flux/v0/stdlib/universe/range.md +++ b/content/flux/v0/stdlib/universe/range.md @@ -44,7 +44,9 @@ Tables with all rows outside the time bounds are filtered entirely. (<-tables: stream[{C with _time: time}], start: A, ?stop: B) => stream[{C with _time: time, _stop: time, _start: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/reduce.md b/content/flux/v0/stdlib/universe/reduce.md index b903074d1..87af3f794 100644 --- a/content/flux/v0/stdlib/universe/reduce.md +++ b/content/flux/v0/stdlib/universe/reduce.md @@ -49,7 +49,9 @@ function returns an error. (<-tables: stream[B], fn: (accumulator: A, r: B) => A, identity: A) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/relativestrengthindex.md b/content/flux/v0/stdlib/universe/relativestrengthindex.md index 822830f44..7d1bfb1de 100644 --- a/content/flux/v0/stdlib/universe/relativestrengthindex.md +++ b/content/flux/v0/stdlib/universe/relativestrengthindex.md @@ -49,7 +49,9 @@ with `x - n` rows. (<-tables: stream[A], n: int, ?columns: [string]) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/rename.md b/content/flux/v0/stdlib/universe/rename.md index 273e3db26..e4d862bda 100644 --- a/content/flux/v0/stdlib/universe/rename.md +++ b/content/flux/v0/stdlib/universe/rename.md @@ -38,7 +38,9 @@ If a column in the group key is renamed, the column name in the group key is upd (<-tables: stream[B], ?columns: A, ?fn: (column: string) => string) => stream[C] where A: Record, B: Record, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/sample.md b/content/flux/v0/stdlib/universe/sample.md index 5b1087325..b79dfaa71 100644 --- a/content/flux/v0/stdlib/universe/sample.md +++ b/content/flux/v0/stdlib/universe/sample.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], n: int, ?column: string, ?pos: int) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/set.md b/content/flux/v0/stdlib/universe/set.md index 8e9d06e69..3043090d7 100644 --- a/content/flux/v0/stdlib/universe/set.md +++ b/content/flux/v0/stdlib/universe/set.md @@ -40,7 +40,9 @@ If the modified column is part of the group key, output tables are regrouped as (<-tables: stream[A], key: string, value: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/skew.md b/content/flux/v0/stdlib/universe/skew.md index c801c3a19..32ee7d33c 100644 --- a/content/flux/v0/stdlib/universe/skew.md +++ b/content/flux/v0/stdlib/universe/skew.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/sort.md b/content/flux/v0/stdlib/universe/sort.md index ee6438de4..5d72063f7 100644 --- a/content/flux/v0/stdlib/universe/sort.md +++ b/content/flux/v0/stdlib/universe/sort.md @@ -44,7 +44,9 @@ When `desc: true`, null values are first in the sort order. (<-tables: stream[A], ?columns: [string], ?desc: bool) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/spread.md b/content/flux/v0/stdlib/universe/spread.md index 5a70161d4..53cb83d1c 100644 --- a/content/flux/v0/stdlib/universe/spread.md +++ b/content/flux/v0/stdlib/universe/spread.md @@ -40,7 +40,9 @@ specified column. (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/statecount.md b/content/flux/v0/stdlib/universe/statecount.md index 4aefe1137..7e2519455 100644 --- a/content/flux/v0/stdlib/universe/statecount.md +++ b/content/flux/v0/stdlib/universe/statecount.md @@ -43,7 +43,9 @@ The state count is added as an additional column to each record. (<-tables: stream[A], fn: (r: A) => bool, ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/stateduration.md b/content/flux/v0/stdlib/universe/stateduration.md index 6931ed66a..8068e8992 100644 --- a/content/flux/v0/stdlib/universe/stateduration.md +++ b/content/flux/v0/stdlib/universe/stateduration.md @@ -55,7 +55,9 @@ state duration will be 0. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/statetracking.md b/content/flux/v0/stdlib/universe/statetracking.md index 8cc31e823..4aa46fe44 100644 --- a/content/flux/v0/stdlib/universe/statetracking.md +++ b/content/flux/v0/stdlib/universe/statetracking.md @@ -52,7 +52,9 @@ and duration columns. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/stddev.md b/content/flux/v0/stdlib/universe/stddev.md index 83c27770b..176584c90 100644 --- a/content/flux/v0/stdlib/universe/stddev.md +++ b/content/flux/v0/stdlib/universe/stddev.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?column: string, ?mode: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/string.md b/content/flux/v0/stdlib/universe/string.md index 0c9693f3d..bd342e30c 100644 --- a/content/flux/v0/stdlib/universe/string.md +++ b/content/flux/v0/stdlib/universe/string.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => string ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/sum.md b/content/flux/v0/stdlib/universe/sum.md index 01218289b..c2349a670 100644 --- a/content/flux/v0/stdlib/universe/sum.md +++ b/content/flux/v0/stdlib/universe/sum.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tablefind.md b/content/flux/v0/stdlib/universe/tablefind.md index 585c08965..95b22f256 100644 --- a/content/flux/v0/stdlib/universe/tablefind.md +++ b/content/flux/v0/stdlib/universe/tablefind.md @@ -40,7 +40,9 @@ match a specified predicate. (<-tables: stream[B], fn: (key: A) => bool) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tail.md b/content/flux/v0/stdlib/universe/tail.md index 3b47765d9..1ba8456ae 100644 --- a/content/flux/v0/stdlib/universe/tail.md +++ b/content/flux/v0/stdlib/universe/tail.md @@ -41,7 +41,9 @@ records before the `offset`. (<-tables: stream[A], n: int, ?offset: int) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/time.md b/content/flux/v0/stdlib/universe/time.md index b6faa3415..e8a1c4b8b 100644 --- a/content/flux/v0/stdlib/universe/time.md +++ b/content/flux/v0/stdlib/universe/time.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => time ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/timedmovingaverage.md b/content/flux/v0/stdlib/universe/timedmovingaverage.md index d695dd948..424d8a87a 100644 --- a/content/flux/v0/stdlib/universe/timedmovingaverage.md +++ b/content/flux/v0/stdlib/universe/timedmovingaverage.md @@ -51,7 +51,9 @@ calculated weeks begin on Thursday. (<-tables: stream[A], every: duration, period: duration, ?column: string) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/timeshift.md b/content/flux/v0/stdlib/universe/timeshift.md index c81edf665..1624cf435 100644 --- a/content/flux/v0/stdlib/universe/timeshift.md +++ b/content/flux/v0/stdlib/universe/timeshift.md @@ -39,7 +39,9 @@ The output table schema is the same as the input table schema. (<-tables: stream[A], duration: duration, ?columns: [string]) => stream[A] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/timeweightedavg.md b/content/flux/v0/stdlib/universe/timeweightedavg.md index dc07adebd..6f48b81f5 100644 --- a/content/flux/v0/stdlib/universe/timeweightedavg.md +++ b/content/flux/v0/stdlib/universe/timeweightedavg.md @@ -40,7 +40,9 @@ Time is weighted using the linearly interpolated integral of values in the table (<-tables: stream[A], unit: duration) => stream[{B with _value: float, _value: float, _stop: D, _start: C}] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tobool.md b/content/flux/v0/stdlib/universe/tobool.md index f842d17cc..67ac02328 100644 --- a/content/flux/v0/stdlib/universe/tobool.md +++ b/content/flux/v0/stdlib/universe/tobool.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: bool}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/today.md b/content/flux/v0/stdlib/universe/today.md index cbad53588..9d57449a5 100644 --- a/content/flux/v0/stdlib/universe/today.md +++ b/content/flux/v0/stdlib/universe/today.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md () => time ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Examples diff --git a/content/flux/v0/stdlib/universe/tofloat.md b/content/flux/v0/stdlib/universe/tofloat.md index 3ca419154..3f95c9768 100644 --- a/content/flux/v0/stdlib/universe/tofloat.md +++ b/content/flux/v0/stdlib/universe/tofloat.md @@ -42,7 +42,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: float}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/toint.md b/content/flux/v0/stdlib/universe/toint.md index 1b9b7ec21..ed0f247e1 100644 --- a/content/flux/v0/stdlib/universe/toint.md +++ b/content/flux/v0/stdlib/universe/toint.md @@ -48,7 +48,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: int}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/top.md b/content/flux/v0/stdlib/universe/top.md index 8212fd149..5b6b5cbb7 100644 --- a/content/flux/v0/stdlib/universe/top.md +++ b/content/flux/v0/stdlib/universe/top.md @@ -40,7 +40,9 @@ in each table. (<-tables: stream[A], n: int, ?columns: [string]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tostring.md b/content/flux/v0/stdlib/universe/tostring.md index 5f9a5bea6..63e4e2d9e 100644 --- a/content/flux/v0/stdlib/universe/tostring.md +++ b/content/flux/v0/stdlib/universe/tostring.md @@ -38,7 +38,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: string}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/totime.md b/content/flux/v0/stdlib/universe/totime.md index 50178c831..9ccf24947 100644 --- a/content/flux/v0/stdlib/universe/totime.md +++ b/content/flux/v0/stdlib/universe/totime.md @@ -43,7 +43,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: time}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/touint.md b/content/flux/v0/stdlib/universe/touint.md index 06edd82a8..20c48c57e 100644 --- a/content/flux/v0/stdlib/universe/touint.md +++ b/content/flux/v0/stdlib/universe/touint.md @@ -48,7 +48,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (<-tables: stream[{A with _value: B}]) => stream[{A with _value: B, _value: uint}] ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tripleema.md b/content/flux/v0/stdlib/universe/tripleema.md index 8b66011e6..8ed068d60 100644 --- a/content/flux/v0/stdlib/universe/tripleema.md +++ b/content/flux/v0/stdlib/universe/tripleema.md @@ -52,7 +52,9 @@ weight to recent data with less lag than `exponentialMovingAverage()` and (<-tables: stream[{A with _value: B}], n: int) => stream[C] where B: Numeric, C: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/tripleexponentialderivative.md b/content/flux/v0/stdlib/universe/tripleexponentialderivative.md index dab0b69e8..94010d447 100644 --- a/content/flux/v0/stdlib/universe/tripleexponentialderivative.md +++ b/content/flux/v0/stdlib/universe/tripleexponentialderivative.md @@ -63,7 +63,9 @@ a negative value indicates decreasing momentum. (<-tables: stream[{A with _value: B}], n: int) => stream[{A with _value: float}] where A: Record, B: Numeric ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/truncatetimecolumn.md b/content/flux/v0/stdlib/universe/truncatetimecolumn.md index 4763b1472..14fbff347 100644 --- a/content/flux/v0/stdlib/universe/truncatetimecolumn.md +++ b/content/flux/v0/stdlib/universe/truncatetimecolumn.md @@ -43,7 +43,9 @@ so all calculated weeks begin on Thursday. (<-tables: stream[{B with _time: C}], unit: duration, ?timeColumn: A) => stream[{B with _time: C, _time: time}] where C: Timeable ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/uint.md b/content/flux/v0/stdlib/universe/uint.md index 46235d085..9299ee8c2 100644 --- a/content/flux/v0/stdlib/universe/uint.md +++ b/content/flux/v0/stdlib/universe/uint.md @@ -47,7 +47,9 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md (v: A) => uint ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/union.md b/content/flux/v0/stdlib/universe/union.md index e1d2c9399..37ed0bf52 100644 --- a/content/flux/v0/stdlib/universe/union.md +++ b/content/flux/v0/stdlib/universe/union.md @@ -46,7 +46,9 @@ Output rows also contain the differing values from each of the joined streams. (tables: [stream[A]]) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/unique.md b/content/flux/v0/stdlib/universe/unique.md index 36b2e100a..e991f7434 100644 --- a/content/flux/v0/stdlib/universe/unique.md +++ b/content/flux/v0/stdlib/universe/unique.md @@ -39,7 +39,9 @@ Group keys, columns, and values are not modified. (<-tables: stream[A], ?column: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/window.md b/content/flux/v0/stdlib/universe/window.md index 1ea64d300..0e18516d8 100644 --- a/content/flux/v0/stdlib/universe/window.md +++ b/content/flux/v0/stdlib/universe/window.md @@ -65,7 +65,9 @@ calculated weeks begin on Thursday. ) => stream[B] where A: Record, B: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/flux/v0/stdlib/universe/yield.md b/content/flux/v0/stdlib/universe/yield.md index 29f4f8006..48aa989cf 100644 --- a/content/flux/v0/stdlib/universe/yield.md +++ b/content/flux/v0/stdlib/universe/yield.md @@ -42,7 +42,9 @@ tables and is only necessary when yielding multiple results from a query. (<-tables: stream[A], ?name: string) => stream[A] where A: Record ``` -{{% caption %}}For more information, see [Function type signatures](/flux/v0/function-type-signatures/).{{% /caption %}} +{{% caption %}} +For more information, see [Function type signatures](/flux/v0/function-type-signatures/). +{{% /caption %}} ## Parameters diff --git a/content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md b/content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md new file mode 100644 index 000000000..e8aeed0ed --- /dev/null +++ b/content/influxdb/cloud-dedicated/admin/monitor-your-cluster.md @@ -0,0 +1,390 @@ +--- +title: Monitor your cluster +seotitle: Monitor your InfluxDB Cloud Dedicated cluster +description: > + Use the Grafana dashboard provided by InfluxData to monitor your + InfluxDB Cloud Dedicated cluster. +menu: + influxdb_cloud_dedicated: + parent: Administer InfluxDB Cloud +weight: 104 +--- + +Use the Grafana dashboard provided by InfluxData to monitor your +{{< product-name >}} cluster. + +{{% note %}} +#### Not available for all clusters + +{{< product-name >}} monitoring dashboards are not available for all clusters. +For questions about availability, [contact InfluxData support](https://support.influxdata.com). +{{% /note %}} + +- [Access your monitoring dashboard](#access-your-monitoring-dashboard) +- [Dashboard sections and cells](#dashboard-sections-and-cells) + +{{< img-hd src="/img/influxdb/clustered-admin-monitoring-dashboard.png" alt="InfluxDB Cloud Dedicated monitoring dashboard" />}} + +## Access your monitoring dashboard + +To access your {{< product-name >}} monitoring dashboard, visit the +`/observability` endpoint of your {{< product-name >}} cluster in your browser: + +
+https://{{< influxdb/host >}}/observability
+
+ +Use the credentials provided by InfluxData to log into your cluster monitoring dashboard. +If you do not have login credentials, [contact InfluxData support](https://support.influxdata.com). + +## Dashboard sections and cells + +The dashboard is divided into the following sections that visualize metrics +related to the health of components in your {{< product-name >}} cluster: + +- [Query Tier Cpu/Mem](#query-tier-cpumem) +- [Query Tier](#query-tier) +- [Ingest Tier Cpu/Mem](#ingest-tier-cpumem) +- [Ingest Tier](#ingest-tier) +- [Compaction Tier Cpu/Mem](#compaction-tier-cpumem) +- [Compactor](#compactor) +- [Ingestor Catalog Operations](#ingestor-catalog-operations) +- [Catalog Operations Overview](#catalog-operations-overview) + +### Query Tier Cpu/Mem + +The **Query Tier Cpu/Mem** section displays the CPU and memory usage of query +pods as reported by Kubernetes. +[Queriers](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) +handle query requests and returns query results for requests. + +- [CPU Utilization (k8s)](#cpu-utilization-k8s) +- [Memory Usage (k8s)](#memory-usage-k8s) + +#### CPU Utilization (k8s) + +The CPU utilization of query pods as reported by the Kubernetes container usage. +Usage is reported by the number of CPU cores used by pods, including +fractional cores. +The CPU limit is represented by the top line in the visualization. + +#### Memory Usage (k8s) + +The memory usage of the query pod containers per cgroup as reported by Kubernetes. +Usage is reported in a magnitude of bytes. +The memory limit is represented by the top line in the visualization. + +--- + +### Query Tier + +The **Query Tier** section displays metrics reported from the InfluxDB gRPC +query API. +[Queriers](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) +handle query requests and returns query results for requests. + +- [gRPC Requests (ok)](#grpc-requests-ok) +- [gRPC Requests (not ok)](#grpc-requests-not-ok) +- [Request Duration (flight DoGet) (ok + !ok)](#request-duration-flight-doget-ok--ok) +- [Successful Request Duration (flight DoGet)](#successful-request-duration-flight-doget) +- [Acquire Duration](#acquire-duration) + +#### gRPC Requests (ok) + +The rate of gRPC requests for different endpoints that returned the `OK` status code, +summed across all queriers. +Request rate is reported in requests per second. + +#### gRPC Requests (not ok) + +The rate of gRPC requests for all endpoints that returned a status code other +than `OK`, summed across all queriers. +Request rate is reported in requests per second. + +#### Request Duration (flight DoGet) (ok + !ok) + +A gRPC request duration heatmap for all requests to the `DoGet` endpoint +regardless of request status. + +The heatmap shows how many requests occurred in each duration "bucket" per time +interval and provides insight into how long a typical query request takes. +It also shows, at a glance, the predominate latency range as well as the +minimum and maximum durations of all query requests. + +The color scheme is a indicator of the value of each cell relative to the +_currently displayed data_. + +#### Successful Request Duration (flight DoGet) + +A gRPC request duration heatmap for successful requests to the `DoGet` endpoint. + +The heatmap shows how many requests occurred in each duration "bucket" per time +interval and provides insight into how long a typical successful query request takes. +It also shows, at a glance, the predominate latency range as well as the +minimum and maximum durations of successful query requests. + +The color scheme is a indicator of the value of each cell relative to the +_currently displayed data_. + +#### Acquire Duration + +A heatmap of how long a query waits to pass the query _semaphore_--a mechanism +that limits the number of concurrent query requests that can be processed and +protects against Out of Memory (OOM) errors that can be caused by unaccounted-for +data structures that may occur during query planning and execution. +This cell only provides information about the queries waiting for the semaphore, +not the time holding it. + +This cell can be used to gauge how much query latency is added due to a high +cluster load. + +--- + +### Ingest Tier Cpu/Mem + +The **Query Tier Cpu/Mem** section displays the CPU and memory usage of Ingester +pods as reported by Kubernetes. +[Ingesters](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) +process line protocol submitted in write requests and persist time series data +to the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). + +- [CPU Utilization Ingesters (k8s)](#cpu-utilization-ingesters-k8s) +- [Memory Usage Ingesters (k8s)](#memory-usage-ingesters-k8s) +- [CPU Utilization Routers (k8s)](#cpu-utilization-routers-k8s) +- [Memory Usage Routers (k8s)](#memory-usage-routers-k8s) + +#### CPU Utilization Ingesters (k8s) + +CPU Utilization of Ingester pods as reported by the Kubernetes container usage. +Usage is reported by the number of CPU cores used by pods, including +fractional cores. +The CPU limit is represented by the top line in the visualization. + +#### Memory Usage Ingesters (k8s) + +Memory usage of the Ingester pod containers per cgroup as reported by Kubernetes. +Usage is reported in a magnitude of bytes. +The memory limit is represented by the top line in the visualization. + +#### CPU Utilization Routers (k8s) + +CPU utilization of Ingester router pods as reported by the Kubernetes container usage. +Usage is reported by the number of CPU cores used by pods, including +fractional cores. + +#### Memory Usage Routers (k8s) + +Memory usage of the Ingester router pod containers per cgroup as reported by Kubernetes. +Usage is reported in a magnitude of bytes. + +--- + +### Ingest Tier + +The **Ingest Tier** section displays metrics reported from the InfluxDB gRPC +and HTTP write APIs. +[Ingesters](/influxdb/cloud-dedicated/reference/internals/storage-engine/#ingester) +process line protocol submitted in write requests and persist time series data +to the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). + +- [Write Requests (at router)](#write-requests-at-router) +- [LP Ingest (at router)](#lp-ingest-at-router-lines) + (lines) +- [LP Ingest (at router)](#lp-ingest-at-router-bytes) + (bytes) +- [HTTP request error rate (server's POV at Router)](#http-request-error-rate-server's-pov-at-router) +- [Healthy Upstream Ingesters per Router](#healthy-upstream-ingesters-per-router) +- [Persist Queue Depth](#persist-queue-depth) +- [Persist Task Queue Duration](#persist-task-queue-duration) +- [Ingester Disk Data Directory Usage](#ingester-disk-data-directory-usage) +- [Ingest Blocked Time (24h)](#ingest-blocked-time-24h) +- [Max Persist Queue Depth](#max-persist-queue-depth) +- [Write Logs (10 examples)](#write-logs-10-examples) + +#### Write Requests (at router) + +Number of write operations completed across all Ingester routers. +Requests are grouped by state (success or error). +Request rate is reported in requests per second. + +#### LP Ingest (at router) {#lp-ingest-at-router-lines metadata="lines"} + +Rate of lines of line protocol being received by each router and across all +Ingester routers. +Request rate is reported in lines per second. + +#### LP Ingest (at router) {#lp-ingest-at-router-bytes metadata="bytes"} + +Rate of bytes of line protocol being received by each router and across all +Ingester routers. +Request rate is reported in bytes per second. + +#### HTTP request error rate (server's POV at Router) + +HTTP request error rate reported by the InfluxDB v3 HTTP request handler. +Error rate is represented the percentage in total requests that return a non-2xx +response code. + +#### Healthy Upstream Ingesters per Router + +The number of healthy upstream Ingesters each router detects. +This reflects the router's RPC request balancer or circuit breaker state. + +This can indicate when routers can't connect to Ingesters becaåuse of because of +issues in the ingest pipeline such as network issues or Ingester availability. + +The Persist Queue is the queue for persisting, or saving to s3, new parquey files. + +#### Persist Queue Depth + +The number of queued persist jobs that have not started. +Each persist jobs consists of taking data from the Write Ahead Log (WAL), +storing it in a Parquet file, and saving the Parquet file to the +[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). + +If the persist queue is growing it means Ingesters are not keeping up with the +incoming write load and may result in Ingester failure. + +#### Persist Task Queue Duration + +A heatmap that shows the time persist jobs spend in the queue before being executed. + +Longer queue times indicate slower persist job execution times which may be due +to network or internal resource constraints, or an increasing +[queue depth](#persist-queue-depth). + +#### Ingester Disk Data Directory Usage + +The per-pod disk usage as a percentage of the Ingesters' data directory. +The WAL is stored on a disk attached to the Ingesters. +As the WAL grows, more disk space is used. +If Ingesters run out of disk, the WAL stops functioning. + +#### Ingest Blocked Time (24h) + +The amount of time the ingest pipeline has been marked as saturated and +rejected write requests. + +#### Max Persist Queue Depth + +The queue depth as a percentage of the configured maximum queue depth. +This shows the saturation level of the most saturated Ingester. +Once the maximum queue depth is reached, writes are rejected. + +#### Write Logs (10 examples) + +A sample of 10 write logs from the displayed time period. +_These do not represent the most recent logs._ + +--- + +### Compaction Tier Cpu/Mem + +The **Compaction Tier Cpu/Mem** section displays the CPU and memory usage of +Compactor pods as reported by Kubernetes. +[Compactors](/influxdb/cloud-dedicated/reference/internals/storage-engine/#compactor) +process and compress parquet files in the +[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store) +to continually optimize storage. + +- [CPU Utilization (k8s)](#compaction-cpu-utilization) +- [Memory Usage (k8s)](#compaction-memory-usage) + +#### CPU Utilization (k8s) {#compaction-cpu-utilization} + +The CPU utilization of compactor pods as reported by the Kubernetes container usage. +Usage is reported by the number of CPU cores used by pods, including +fractional cores. +The CPU limit is represented by the top line in the visualization. + +#### Memory Usage (k8s) {#compaction-memory-usage} + +The memory usage of compactor pod containers per cgroup as reported by Kubernetes. +Usage is reported in a magnitude of bytes. +The memory limit is represented by the top line in the visualization. + +--- + +### Compactor + +The **Compactor** section displays metrics related to the compaction of Parquet +files in the [Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). +[Compactors](/influxdb/cloud-dedicated/reference/internals/storage-engine/#compactor) +process and compress Parquet files to continually optimize storage. + +- [Compactor: L0 File Counts (5m bucket width)](#compactor-l0-file-counts-5m-bucket-width) + +#### Compactor: L0 File Counts (5m bucket width) + +A histogram of the quantity of L0-compacted files at time of compaction. + +Ingesters create Parquet files using L0 (level zero) compaction. +As Compactors process and compact Parquet files over time, they do so in the +following levels: + +- **L0**: Uncompacted +- **L1**: 4 L0 files compacted together +- **L2**: 4 L1 files compacted together +- **L3**: 4 L2 files compacted together + +Parquet files store data partitioned by time and optionally tags +_(see [Manage data partition](https://docs.influxdata.com/influxdb/cloud-dedicated/admin/custom-partitions/))_. +After four L0 files accumulate for a partition, they are are eligible for compaction. +If the compactor is keeping up with the incoming write load, all compaction +events will have exactly four files. If the number of L0 files compacted begins to +to increase, it indicates the compactor is not keeping up. + +This histogram helps to determine if the Compactor is starting compactions as +soon as it can. + +--- + +### Ingestor Catalog Operations + +The **Ingestor Catalog Operations** section displays metrics related to +Catalog operations requested by Ingesters. +The [Catalog](/influxdb/cloud-dedicated/reference/internals/storage-engine/#catalog) +is a relational database that stores metadata related to your time series data +including schema information and physical locations of partitions in the +[Object store](/influxdb/cloud-dedicated/reference/internals/storage-engine/#object-store). + +- [Catalog Ops - success](#catalog-ops---success) +- [Catalog Ops - error](#catalog-ops---error) +- [Catalog Op Latency (P90)](#catalog-op-latency-p90) + +#### Catalog Ops - success + +The rate of successful Catalog operations per second requested by Ingesters. +Higher rates of successful Catalog operations requested by Ingesters indicate +a high write load. + +#### Catalog Ops - error + +The rate of erred catalog operations per second requested by Ingesters. +Higher rates of erred Catalog operations requested by Ingesters indicate +that the Catalog may be overloaded or unresponsive. + +#### Catalog Op Latency (P90) + +The 90th percentile (P90) of query latency against the catalog service per operation. +A high P90 value indicates that the Catalog may be overloaded. + +--- + +### Catalog Operations Overview + +The **Catalog Operations Overview** section displays metrics related to +Catalog operations requested by all components of your {{< product-name >}} cluster. + +- [Requests per Operation - success](#requests-per-operation---success) +- [Requests per Operation - error](#requests-per-operation---error) + +#### Requests per Operation - success + +The rate of successful Catalog requests per second by operation. + +#### Requests per Operation - error + +The rate of erred Catalog requests per second by operation. +Higher rates of erred Catalog operations indicate that the Catalog may be +overloaded or unresponsive. diff --git a/content/influxdb/cloud-dedicated/admin/query-system-data.md b/content/influxdb/cloud-dedicated/admin/query-system-data.md new file mode 100644 index 000000000..c2c0ca514 --- /dev/null +++ b/content/influxdb/cloud-dedicated/admin/query-system-data.md @@ -0,0 +1,400 @@ +--- +title: Query system data +description: > + Query system tables in your InfluxDB Cloud Dedicated cluster to see data related + to queries, tables, partitions, and compaction in your cluster. +menu: + influxdb_cloud_dedicated: + parent: Administer InfluxDB Cloud + name: Query system data +weight: 105 +related: + - /influxdb/cloud-dedicated/reference/cli/influxctl/query/ +--- + +{{< product-name >}} stores data related to queries, tables, partitions, and +compaction in system tables in your cluster. +Query data in your cluster's system tables for information about your cluster. + +- [Query system tables](#query-system-tables) +- [System tables](#system-tables) +- [System query examples](#system-query-examples) + +{{% warn %}} +#### May impact overall cluster performance + +Querying InfluxDB v3 system tables may impact the overall write and query +performance of your {{< product-name omit=" Clustered" >}} cluster. + + + +#### System tables are subject to change + +System tables are not part of InfluxDB's stable API and may change with new releases. +The provided schema information and query examples are valid as of **April 11, 2024**. +If you detect a schema change or a non-functioning query example, please +[submit an issue](https://github.com/influxdata/docs-v2/issues/new/choose). + + +{{% /warn %}} + +## Query system tables + +{{% warn %}} +_Querying system tables [may impact overall cluster performance](#may-impact-overall-cluster-performance)._ +{{% /warn %}} + +{{% note %}} +Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**. +{{% /note %}} + +Use the [`influxctl query` command](/influxdb/cloud-dedicated/reference/cli/influxctl/query/) +and SQL to query system tables. Provide the following: + +- **Enable system tables** with the `--enable-system-tables` command flag. +- **Database token**: A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + with read permissions on the specified database. Uses the `token` setting from + the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + or the `--token` command flag. +- **Database name**: The name of the database to query information about. + Uses the `database` setting from the + [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) + or the `--database` command flag. +- **SQL query**: The SQL query to execute. + Pass the query in one of the following ways: + + - a string on the command line + - a path to a file that contains the query + - a single dash (`-`) to read the query from stdin + +{{% code-placeholders "DATABASE_(TOKEN|NAME)|SQL_QUERY" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --enable-system-tables \ + --database DATABASE_NAME \ + --token DATABASE_TOKEN \ + "SQL_QUERY" +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --enable-system-tables \ + --database DATABASE_NAME \ + --token DATABASE_TOKEN \ + /path/to/query.sql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.sql | influxctl query \ + --enable-system-tables \ + --database DATABASE_NAME \ + --token DATABASE_TOKEN \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +Replace the following: + +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: + A database token with read access to the specified database +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + The name of the database to query information about. +- {{% code-placeholder-key %}}`SQL_QUERY`{{% /code-placeholder-key %}}: + The SQL query to execute. For examples, see [Query examples](#query-examples). + +When prompted, enter `y` to acknowledge the potential impact querying system +tables may have on your cluster. + +## System tables + +{{% warn %}} +_System tables are [subject to change](#system-tables-are-subject-to-change)._ +{{% /warn %}} + +- [system.queries](#systemqueries) +- [system.tables](#systemtables) +- [system.partitions](#systempartitions) +- [system.compactor](#systemcompactor) + +### system.queries + +The `system.queries` table contains an unpersisted log of queries run against +the current [InfluxDB Querier](/influxdb/cloud-dedicated/reference/internals/storage-engine/#querier) +to which your query is routed. +The query log is specific to the current Querier and is not shared across Queriers +in your cluster. +Logs are scoped to the specified database. + +{{< expand-wrapper >}} +{{% expand "View `system.queries` schema" %}} + +The `system.queries` table contains the following columns: + +- id +- phase +- issue_time +- query_type +- query_text +- partitions +- parquet_files +- plan_duration +- permit_duration +- execute_duration +- end2end_duration +- compute_duration +- max_memory +- success +- running +- cancelled +- trace_id + +{{% /expand %}} +{{< /expand-wrapper >}} + +### system.tables + +The `system.tables` table contains information about tables in the specified database. + +{{< expand-wrapper >}} +{{% expand "View `system.tables` schema" %}} + +The `system.tables` table contains the following columns: + +- table_name +- partition_template + +{{% /expand %}} +{{< /expand-wrapper >}} + +### system.partitions + +The `system.partitions` table contains information about partitions associated +with the specified database. + +{{< expand-wrapper >}} +{{% expand "View `system.partitions` schema" %}} + +The `system.partitions` table contains the following columns: + +- partition_id +- table_name +- partition_key +- last_new_file_created_at +- num_files +- total_size_mb + +{{% /expand %}} +{{< /expand-wrapper >}} + +### system.compactor + +The `system.compaction` table contains information about compacted partition Parquet +files associated with the specified database. + +{{< expand-wrapper >}} +{{% expand "View `system.compactor` schema" %}} + +The `system.compactor` table contains the following columns: + +- partition_id +- table_name +- partition_key +- total_l0_files +- total_l1_files +- total_l2_files +- total_l0_bytes +- total_l1_bytes +- total_l2_bytes +- skipped_reason + +{{% /expand %}} +{{< /expand-wrapper >}} + +## System query examples + +- [Query logs](#query-logs) + - [View all stored query logs](#view-all-stored-query-logs) + - [View query logs for queries with end-to-end durations above a threshold](#view-query-logs-for-queries-with-end-to-end-durations-above-a-threshold) +- [Partitions](#partitions) + - [View partition templates of all tables](#view-partition-templates-of-all-tables) + - [View the partition template of a specific table](#view-the-partition-template-of-a-specific-table) + - [View all partitions for a table](#view-all-partitions-for-a-table) + - [View the number of partitions per table](#view-the-number-of-partitions-per-table) + - [View the number of partitions for a specific table](#view-the-number-of-partitions-for-a-specific-table) +- [Storage usage](#storage-usage) + - [View the size of tables in megabytes](#view-the-size-of-tables-in-megabytes) + - [View the size of a specific table in megabytes](#view-the-size-of-a-specific-table-in-megabytes) + - [View the total size of all compacted partitions per table in bytes](#view-the-total-size-of-all-compacted-partitions-per-table-in-bytes) + - [View the total size of all compacted partitions in bytes](#view-the-total-size-of-all-compacted-partitions-in-bytes) +- [Compaction](#compaction) + - [View overall compaction totals for each table](#view-overall-compaction-totals-for-each-table) + - [View overall compaction totals for a specific table](#view-overall-compaction-totals-for-a-specific-table) + +In the examples below, replace {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}} +with the name of the table you want to query information about. + +--- + +{{% code-placeholders "TABLE_NAME" %}} + +### Query logs + +#### View all stored query logs + +```sql +SELECT * FROM system.queries +``` + +#### View query logs for queries with end-to-end durations above a threshold + +The following returns query logs for queries with an end-to-end duration greater +than 50 milliseconds. + +```sql +SELECT * FROM system.queries WHERE end2end_duration::BIGINT > (50 * 1000000) +``` + +--- + +### Partitions + +#### View partition templates of all tables + +```sql +SELECT * FROM system.tables +``` + +#### View the partition template of a specific table + +```sql +SELECT * FROM system.tables WHERE table_name = 'TABLE_NAME' +``` + +#### View all partitions for a table + +```sql +SELECT * FROM system.partitions WHERE table_name = 'TABLE_NAME' +``` + +#### View the number of partitions per table + +```sql +SELECT + table_name, + COUNT(*) AS partition_count +FROM + system.partitions +GROUP BY + table_name +``` + +#### View the number of partitions for a specific table + +```sql +SELECT + COUNT(*) AS partition_count +FROM + system.partitions +WHERE + table_name = 'TABLE_NAME' +``` + +--- + +### Storage usage + +#### View the size of tables in megabytes + +```sql +SELECT + table_name, + SUM(total_size_mb) AS total_size_mb +FROM + system.partitions +GROUP BY + table_name +``` + +#### View the size of a specific table in megabytes + +```sql +SELECT + SUM(total_size_mb) AS total_size_mb +FROM + system.partitions +WHERE + table_name = 'TABLE_NAME' +``` + +#### View the total size of all compacted partitions per table in bytes + +```sql +SELECT + table_name, + SUM(total_l0_bytes) + SUM(total_l1_bytes) + SUM(total_l2_bytes) AS total_bytes +FROM + system.compactor +GROUP BY + table_name +``` + +#### View the total size of all compacted partitions in bytes + +```sql +SELECT + SUM(total_l0_bytes) + SUM(total_l1_bytes) + SUM(total_l2_bytes) AS total_bytes +FROM + system.compactor +``` + +--- + +### Compaction + +#### View overall compaction totals for each table + +```sql +SELECT + table_name, + SUM(total_l0_files) AS total_l0_files, + SUM(total_l1_files) AS total_l1_files, + SUM(total_l2_files) AS total_l2_files, + SUM(total_l0_bytes) AS total_l0_bytes, + SUM(total_l1_bytes) AS total_l1_bytes, + SUM(total_l2_bytes) AS total_l2_bytes +FROM + system.compactor +GROUP BY + table_name +``` + +#### View overall compaction totals for a specific table + +```sql +SELECT + SUM(total_l0_files) AS total_l0_files, + SUM(total_l1_files) AS total_l1_files, + SUM(total_l2_files) AS total_l2_files, + SUM(total_l0_bytes) AS total_l0_bytes, + SUM(total_l1_bytes) AS total_l1_bytes, + SUM(total_l2_bytes) AS total_l2_bytes +FROM + system.compactor +WHERE + table_name = 'TABLE_NAME' +``` + +{{% /code-placeholders %}} diff --git a/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md b/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md index 36e24d077..e4756ccf4 100644 --- a/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md +++ b/content/influxdb/cloud-dedicated/process-data/visualize/grafana.md @@ -207,6 +207,8 @@ To learn more, see [Query Data](/influxdb/cloud-dedicated/query-data/sql/). {{% /tab-content %}} {{< /tabs-wrapper >}} +{{< youtube "rSsouoNsNDs" >}} + To learn about query management and inspection in Grafana, see the [Grafana Explore documentation](https://grafana.com/docs/grafana/latest/explore/). diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md b/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md index ba895af5b..54a58a494 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md +++ b/content/influxdb/cloud-dedicated/query-data/execute-queries/_index.md @@ -2,7 +2,7 @@ title: Execute queries description: > Use tools and libraries to query data stored in InfluxDB Cloud Dedicated. -weight: 201 +weight: 101 menu: influxdb_cloud_dedicated: name: Execute queries diff --git a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md b/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md index 0c2fe86c9..401c28f90 100644 --- a/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md +++ b/content/influxdb/cloud-dedicated/query-data/execute-queries/influxctl-cli.md @@ -9,38 +9,40 @@ menu: influxdb_cloud_dedicated: parent: Execute queries name: Use the influxctl CLI -influxdb/cloud-dedicated/tags: [query, sql, influxctl, CLI] -metadata: [SQL] +influxdb/cloud-dedicated/tags: [query, sql, influxql, influxctl, CLI] related: - /influxdb/cloud-dedicated/reference/cli/influxctl/query/ - /influxdb/cloud-dedicated/get-started/query/#execute-an-sql-query, Get started querying data - /influxdb/cloud-dedicated/reference/sql/ + - /influxdb/cloud-dedicated/reference/influxql/ list_code_example: | ```sh influxctl query \ --token DATABASE_TOKEN \ --database DATABASE_NAME \ - "q=SELECT * FROM home" + "SELECT * FROM home" ``` --- Use the [`influxctl query` command](/influxdb/cloud-dedicated/reference/cli/influxctl/query/) -to query data in {{< product-name >}} with SQL. - -{{% note %}} -The `influxctl query` command only supports SQL queries; not InfluxQL. -{{% /note %}} +to query data in {{< product-name >}} with SQL or InfluxQL. Provide the following with your command: -- **Database token**: [Database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) - with read permissions on the queried database. Uses the `token` setting from - the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) +- **Database token**: A [database token](/influxdb/cloud-dedicated/admin/tokens/#database-tokens) + with read permissions on the queried database. By default, this uses + the `database` setting from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--token` command flag. -- **Database name**: Name of the database to query. Uses the `database` setting - from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) +- **Database name**: The name of the database to query. By default, this uses + the `database` setting from the [`influxctl` connection profile](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) or the `--database` command flag. -- **SQL query**: SQL query to execute. +- **Query language** (Optional): The query language of the query. + Use the `--language` flag to specify one of the following query languages: + + - `sql` _(default)_ + - `influxql` + +- **Query**: SQL or InfluxQL query to execute. Pass the query in one of the following ways: - a string on the command line @@ -49,6 +51,14 @@ Provide the following with your command: {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} +{{< tabs-wrapper >}} +{{% tabs %}} +[SQL](#) +[InfluxQL](#) +{{% /tabs %}} + +{{% tab-content %}} + {{< code-tabs-wrapper >}} {{% code-tabs %}} [string](#) @@ -81,6 +91,48 @@ cat ./query.sql | influxctl query \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} +{{% /tab-content %}} + +{{% tab-content %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + "SELECT * FROM home" +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + /path/to/query.influxql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.influxql | influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /tab-content %}} +{{< /tabs-wrapper >}} + {{% /code-placeholders %}} Replace the following: diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md b/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md index 489af8885..1b6a1b779 100644 --- a/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md +++ b/content/influxdb/cloud-dedicated/query-data/influxql/basic-query.md @@ -120,6 +120,7 @@ SELECT * FROM home WHERE time >= now() - 30d ``` ##### Query one day of data data from a week ago + ```sql SELECT * FROM home @@ -213,5 +214,3 @@ SELECT temp AS temperature, hum AS "humidity (%)" FROM home When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb/cloud-dedicated/reference/influxql/#identifiers). When [aliasing columns in **SQL**](/influxdb/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags), you can use the `AS` clause to define the alias, but it isn't necessary. {{% /note %}} - - diff --git a/content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md b/content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md new file mode 100644 index 000000000..3769e1e3a --- /dev/null +++ b/content/influxdb/cloud-dedicated/query-data/influxql/parameterized-queries.md @@ -0,0 +1,354 @@ +--- +title: Use parameterized queries with InfluxQL +description: > + Use parameterized queries to prevent injection attacks and make queries more reusable. +weight: 404 +menu: + influxdb_cloud_dedicated: + name: Parameterized queries + parent: Query with InfluxQL + identifier: parameterized-queries-influxql +influxdb/cloud-dedicated/tags: [query, security, influxql] +list_code_example: | + ##### Using Go and the influxdb3-go client + + ```go + // Use the $parameter syntax to reference parameters in a query. + // The following InfluxQL query contains $room and $min_time parameters. + query := ` + SELECT * FROM home + WHERE time >= $min_time + AND temp >= $min_temp + AND room = $room` + + // Assign parameter names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + "min_time": "2024-03-18 00:00:00.00", + } + + // Call the client's function to query InfluxDB with parameters and the + // the InfluxQL QueryType. + iterator, err := client.QueryWithParameters(context.Background(), + query, + parameters, + influxdb3.WithQueryType(influxdb3.InfluxQL)) + ``` +--- + +Parameterized queries in {{% product-name %}} let you dynamically and safely change values in a query. +If your application code allows user input to customize values or expressions in a query, use a parameterized query to make sure untrusted input is processed strictly as data and not executed as code. + +Parameterized queries: + +- help prevent injection attacks, which can occur if input is executed as code +- help make queries more reusable + +{{% note %}} +#### Prevent injection attacks + +For more information on security and query parameterization, +see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). +{{% /note %}} + +In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. + +- [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) +- [Parameter data types](#parameter-data-types) + - [Data type examples](#data-type-examples) + - [Time expressions](#time-expressions) + - [Not compatible with parameters](#not-compatible-with-parameters) +- [Parameterize an SQL query](#parameterize-an-sql-query) +- [Execute parameterized InfluxQL queries](#execute-parameterized-influxql-queries) + - [Use InfluxDB Flight RPC clients](#use-influxdb-flight-rpc-clients) +- [Client support for parameterized queries](#client-support-for-parameterized-queries) +- [Not supported](#not-supported) + +{{% note %}} + +#### Parameters only supported in `WHERE` expressions + +InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +Parameter values must be one of the [allowed parameter data types](#parameter-data-types). + +If you use parameters in other expressions or clauses, +such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect. + +{{% /note %}} + +## Use parameters in `WHERE` expressions + +You can use parameters in `WHERE` clause **predicate expressions**-–for example, the following query contains a `$temp` parameter: + +```sql +SELECT * FROM measurement WHERE temp > $temp +``` + +When executing a query, you specify parameter name-value pairs. +The value that you assign to a parameter must be one of the [parameter data types](#parameter-data-types). + +```go +{"temp": 22.0} +``` + +The InfluxDB Querier parses the query text with the parameter placeholders, and then generates query plans that replace the placeholders with the values that you provide. +This separation of query structure from input data ensures that input is treated as one of the allowed [data types](#parameter-data-types) and not as executable code. + +## Parameter data types + +A parameter value can be one of the following data types: + +- Null +- Boolean +- Unsigned integer (`u_int64`) +- Integer (`int64`) +- Double (`float64`) +- String + +### Data type examples + +```js +{ + "string": "Living Room", + "double": 3.14, + "unsigned_integer": 1234, + "integer": -1234, + "boolean": false, + "null": Null, +} +``` + +### Time expressions + +To parameterize time bounds, substitute a parameter for a timestamp literal--for example: + +```sql +SELECT * +FROM home +WHERE time >= $min_time +``` + +For the parameter value, specify the timestamp literal as a string--for example: + +{{% influxdb/custom-timestamps %}} + +```go +// Assign a timestamp string literal to the min_time parameter. +parameters := influxdb3.QueryParameters{ + "min_time": "2022-01-01 00:00:00.00", +} +``` + +{{% /influxdb/custom-timestamps %}} + +InfluxDB executes the query as the following: + +{{% influxdb/custom-timestamps %}} + +```sql +SELECT * +FROM home +WHERE time >= '2022-01-01 00:00:00.00' +``` + +{{% /influxdb/custom-timestamps %}} + +### Not compatible with parameters + +If you use parameters for the following, your query might not work as you expect: + +- In clauses other than `WHERE`, such as `SELECT` or `GROUP BY` +- As function arguments, such as `avg($temp)` +- In place of identifiers, such as column or table names +- In place of duration literals, such as `time > now() - $min_duration` + +## Parameterize an SQL query + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +To use a parameterized query, do the following: + +1. In your query text, use the `$parameter` syntax to reference a parameter name--for example, +the following query contains `$room` and `$min_temp` parameter placeholders: + + ```sql + SELECT * + FROM home + WHERE time > now() - 7d + AND temp >= $min_temp + AND room = $room + ``` + +2. Provide a value for each parameter name. + If you don't assign a value for a parameter, InfluxDB returns an error. + The syntax for providing parameter values depends on the client you use--for example: + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - 7d +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized InfluxQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized InfluxQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters, + options influxdb3.QueryOptions) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_DATABASE") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query, parameters, and the InfluxQL QueryType option. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters, influxdb3.WithQueryType(options.QueryType)) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following InfluxQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - 7d + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + + Query(query, parameters, influxdb3.QueryOptions{ + QueryType: influxdb3.InfluxQL, + }) +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md b/content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md new file mode 100644 index 000000000..b149ea65f --- /dev/null +++ b/content/influxdb/cloud-dedicated/query-data/sql/parameterized-queries.md @@ -0,0 +1,346 @@ +--- +title: Use parameterized queries with SQL +description: > + Use parameterized queries to prevent injection attacks and make queries more reusable. +weight: 404 +menu: + influxdb_cloud_dedicated: + name: Parameterized queries + parent: Query with SQL + identifier: parameterized-queries-sql +influxdb/cloud-dedicated/tags: [query, security, sql] +list_code_example: | + ##### Using Go and the influxdb3-go client + + ```go + // Use the $parameter syntax to reference parameters in a query. + // The following SQL query contains $room and $min_temp placeholders. + query := ` + SELECT * FROM home + WHERE time >= $min_time + AND temp >= $min_temp + AND room = $room` + + // Assign parameter names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + "min_time": "2024-03-18 00:00:00.00", + + } + + // Call the client's function to query InfluxDB with parameters. + iterator, err := client.QueryWithParameters(context.Background(), query, parameters) + ``` +--- + +Parameterized queries in {{% product-name %}} let you dynamically and safely change values in a query. +If your application code allows user input to customize values or expressions in a query, use a parameterized query to make sure untrusted input is processed strictly as data and not executed as code. + +Parameterized queries: + +- help prevent injection attacks, which can occur if input is executed as code +- help make queries more reusable + +{{% note %}} +#### Prevent injection attacks + +For more information on security and query parameterization, +see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). +{{% /note %}} + +In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. + +- [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) +- [Parameter data types](#parameter-data-types) + - [Data type examples](#data-type-examples) + - [Time expressions](#time-expressions) + - [Not compatible with parameters](#not-compatible-with-parameters) +- [Parameterize an SQL query](#parameterize-an-sql-query) +- [Execute parameterized SQL queries](#execute-parameterized-sql-queries) + - [Use InfluxDB Flight RPC clients](#use-influxdb-flight-rpc-clients) +- [Client support for parameterized queries](#client-support-for-parameterized-queries) +- [Not supported](#not-supported) + +{{% note %}} + +#### Parameters only supported in `WHERE` expressions + +InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +Parameter values must be one of the [allowed parameter data types](#parameter-data-types). + +If you use parameters in other expressions or clauses, +such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect. + +{{% /note %}} + +## Use parameters in `WHERE` expressions + +You can use parameters in `WHERE` clause **predicate expressions**-–for example, the following query contains a `$temp` parameter: + +```sql +SELECT * FROM measurement WHERE temp > $temp +``` + +When executing a query, you specify parameter name-value pairs. +The value that you assign to a parameter must be one of the [parameter data types](#parameter-data-types). + +```go +{"temp": 22.0} +``` + +The InfluxDB Querier parses the query text with the parameter placeholders, and then generates query plans that replace the placeholders with the values that you provide. +This separation of query structure from input data ensures that input is treated as one of the allowed [data types](#parameter-data-types) and not as executable code. + +## Parameter data types + +A parameter value can be one of the following data types: + +- Null +- Boolean +- Unsigned integer (`u_int64`) +- Integer (`int64`) +- Double (`float64`) +- String + +### Data type examples + +```js +{ + "string": "Living Room", + "double": 3.14, + "unsigned_integer": 1234, + "integer": -1234, + "boolean": false, + "null": Null, +} +``` + +### Time expressions + +To parameterize time bounds, substitute a parameter for a timestamp literal--for example: + +```sql +SELECT * +FROM home +WHERE time >= $min_time +``` + +For the parameter value, specify the timestamp literal as a string--for example: + +{{% influxdb/custom-timestamps %}} + +```go +// Assign a timestamp string literal to the min_time parameter. +parameters := influxdb3.QueryParameters{ + "min_time": "2022-01-01 00:00:00.00", +} +``` + +{{% /influxdb/custom-timestamps %}} + +InfluxDB executes the query as the following: + +{{% influxdb/custom-timestamps %}} + +```sql +SELECT * +FROM home +WHERE time >= '2022-01-01 00:00:00.00' +``` + +{{% /influxdb/custom-timestamps %}} + +### Not compatible with parameters + +If you use parameters for the following, your query might not work as you expect: + +- In clauses other than `WHERE`, such as `SELECT` or `GROUP BY` +- As function arguments, such as `avg($temp)` +- In place of identifiers, such as column or table names +- In place of duration literals, such as `INTERVAL $minutes` + +## Parameterize an SQL query + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +To use a parameterized query, do the following: + +1. In your query text, use the `$parameter` syntax to reference a parameter name--for example, +the following query contains `$room` and `$min_temp` parameter placeholders: + + ```sql + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room + ``` + +2. Provide a value for each parameter name. + If you don't assign a value for a parameter, InfluxDB returns an error. + The syntax for providing parameter values depends on the client you use--for example: + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - INTERVAL '7 days' +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized SQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized SQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_DATABASE") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query and parameters. The default QueryType is SQL. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following SQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-dedicated/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md index 5d33c28fd..583c11985 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md @@ -335,6 +335,7 @@ If stored at a non-default location, include the `--config` flag with each ## By default, the system certificates are used. If a custom certificate ## for connecting to InfluxDB is required, define it below. # [profile.tls] + # insecure = false # cert = "" # key = "" # ca = "" diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/query.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/query.md index 61b885bd8..c35aecaee 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/query.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/query.md @@ -2,7 +2,7 @@ title: influxctl query description: > The `influxctl query` command queries data from InfluxDB Cloud Dedicated - using SQL and prints results as a table or JSON. + using SQL or InfluxQL and prints results as a table or JSON. menu: influxdb_cloud_dedicated: parent: influxctl @@ -10,13 +10,15 @@ weight: 201 metadata: [influxctl 2.4.0+] related: - /influxdb/cloud-dedicated/reference/sql/ + - /influxdb/cloud-dedicated/reference/influxql/ - /influxdb/cloud-dedicated/query-data/ + - /influxdb/cloud-dedicated/admin/query-system-data/ --- The `influxctl query` command queries data from {{< product-name >}} using SQL -and prints results as a table or JSON. +or InfluxQL and prints results as a table or JSON. -Provide the SQL query in one of the following ways: +Provide the query in one of the following ways: - a string on the command line - a path to a file that contains the query @@ -26,7 +28,6 @@ Provide the SQL query in one of the following ways: #### Important to note - This command supports only one query per execution. -- This command supports only SQL queries; not InfluxQL. - This command is not meant to be a full, feature-rich query tool. It's meant for debug, triage, and basic data exploration. {{% /note %}} @@ -56,18 +57,20 @@ influxctl query [flags] ## Arguments -| Argument | Description | -| :-------- | :---------------------------------------------------------------------------------- | -| **QUERY** | SQL query to execute (command line string, path to file, or `-` to read from stdin) | +| Argument | Description | +| :-------- | :------------------------------------------------------------------------------ | +| **QUERY** | Query to execute (command line string, path to file, or `-` to read from stdin) | ## Flags -| Flag | | Description | -| :--- | :----------- | :----------------------------------------------------------- | -| | `--database` | Database to query | -| | `--format` | Output format (`table` _(default)_ or `json`) | -| | `--token` | Database token with read permissions on the queried database | -| `-h` | `--help` | Output command help | +| Flag | | Description | +| :--- | :----------------------- | :----------------------------------------------------------- | +| | `--database` | Database to query | +| | `--enable-system-tables` | Enable ability to query system tables | +| | `--format` | Output format (`table` _(default)_ or `json`) | +| | `--language` | Query language (`sql` _(default)_ or `influxql`) | +| | `--token` | Database token with read permissions on the queried database | +| `-h` | `--help` | Output command help | {{% caption %}} _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ @@ -75,9 +78,12 @@ _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/inf ## Examples +- [Query InfluxDB v3 with SQL](#query-influxdb-v3-with-sql) +- [Query InfluxDB v3 with InfluxQL](#query-influxdb-v3-with-influxql) - [Query InfluxDB v3 and return results in table format](#query-influxdb-v3-and-return-results-in-table-format) - [Query InfluxDB v3 and return results in JSON format](#query-influxdb-v3-and-return-results-in-json-format) - [Query InfluxDB v3 using credentials from the connection profile](#query-influxdb-v3-using-credentials-from-the-connection-profile) +- [Query data from InfluxDB v3 system tables](#query-data-from-influxdb-v3-system-tables) In the examples below, replace the following: @@ -86,6 +92,89 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to query +### Query InfluxDB v3 with SQL + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + /path/to/query.sql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.sql | influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +### Query InfluxDB v3 with InfluxQL + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + /path/to/query.influxql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.influxql | influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + ### Query InfluxDB v3 and return results in table format {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -242,6 +331,70 @@ The following example uses the `database` and `token` defined in the `default` {{% influxdb/custom-timestamps %}} ```sh -influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z' LIMIT 5" +influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" ``` {{% /influxdb/custom-timestamps %}} + +### Query data from InfluxDB v3 system tables + +{{% note %}} +You must use **SQL** to query InfluxDB v3 system tables. +{{% /note %}} + +{{% warn %}} +Querying system tables can impact the overall performance of your +{{< product-name omit=" Clustered" >}} cluster. System tables are not part of +InfluxDB's stable API and are subject to change. +{{% /warn %}} + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + "SELECT * FROM system.tables" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + /path/to/query.sql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.sql | influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +{{% expand "View command updates" %}} + +#### v2.8.0 {date="2024-04-11"} + +- Add InfluxQL support and introduce the `--language` flag to specify the query + language. +- Add `--enable-system-tables` flag to enable the ability to query InfluxDB v3 + system tables. + +{{% /expand %}} diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md index 140aeda39..df266a247 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/write.md @@ -219,6 +219,53 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} +### Write line protocol to InfluxDB v3 with a custom client timeout + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 +" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + /path/to/metrics.lp +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./metrics.lp | influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + ### Write line protocol to InfluxDB v3 using credentials from the connection profile The following example uses the `database` and `token` defined in the `default` @@ -233,3 +280,11 @@ home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600000000000 " ``` {{% /influxdb/custom-timestamps %}} + +{{% expand "View command updates" %}} + +#### v2.8.0 {date="2024-04-11"} + +- Add `--timeout` flag to specify a custom client timeout. + +{{% /expand %}} diff --git a/content/influxdb/cloud-dedicated/reference/influxql/_index.md b/content/influxdb/cloud-dedicated/reference/influxql/_index.md index e99d7b0e6..db2e55397 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/_index.md +++ b/content/influxdb/cloud-dedicated/reference/influxql/_index.md @@ -1,5 +1,5 @@ --- -title: InfluxQL reference +title: InfluxQL reference documentation list_title: InfluxQL description: InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: diff --git a/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md b/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md index 0cb9d0fb9..090382024 100644 --- a/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md +++ b/content/influxdb/cloud-dedicated/reference/influxql/time-and-timezone.md @@ -27,6 +27,7 @@ You can review the following ways to work with time and timestamps in your Influ - [Notable behaviors](#notable-behaviors) - [Cannot query multiple time ranges](#cannot-query-multiple-time-ranges) - [Querying future data with a `GROUP BY time()` clause](#querying-future-data-with-a-group-by-time-clause) + - [Cannot use parameters for durations](#cannot-use-parameters-for-durations) ## Time syntax @@ -81,7 +82,7 @@ InfluxQL requires a whitespace between the `+` operators `-` and the duration li ## Query time range -To specify the time range of a query, use conditional expressions in the +To specify the time range of a query, use conditional expressions in the [`WHERE` clause](/inflxudb/cloud-dedicated/reference/influxql/where/) that compare the value of the `time` column to an absolute timestamp or a relative timestamp. @@ -151,7 +152,7 @@ WHERE AND time <= '2022-01-01T12:00:00Z' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home {{% /influxql/table-meta %}} @@ -178,9 +179,9 @@ WHERE AND time <= '2022-01-01 12:00:00' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -206,9 +207,9 @@ WHERE AND time <= 1641038400000000000 ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -233,9 +234,9 @@ WHERE AND time <= 1641038400s ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -255,9 +256,9 @@ name: home SELECT * FROM home WHERE time >= '2022-01-01T20:00:00Z' - 2h ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :---------- | ---: | @@ -285,10 +286,10 @@ SELECT * FROM home WHERE time >= now() - 2h {{% warn %}} InfluxQL in {{< product-name >}} does not currently support the time zone clause, which applies a time zone offset to UTC timestamps in query results. - -**Tracking issue**: [influxdb_iox#6933](https://github.com/influxdata/influxdb_iox/issues/6933) {{% /warn %}} + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - 7d +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized InfluxQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} bucket before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized InfluxQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters, + options influxdb3.QueryOptions) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_BUCKET") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query, parameters, and the InfluxQL QueryType option. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters, influxdb3.WithQueryType(options.QueryType)) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following InfluxQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - 7d + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + + Query(query, parameters, influxdb3.QueryOptions{ + QueryType: influxdb3.InfluxQL, + }) +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md b/content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md new file mode 100644 index 000000000..094485874 --- /dev/null +++ b/content/influxdb/cloud-serverless/query-data/sql/parameterized-queries.md @@ -0,0 +1,346 @@ +--- +title: Use parameterized queries with SQL +description: > + Use parameterized queries to prevent injection attacks and make queries more reusable. +weight: 404 +menu: + influxdb_cloud_serverless: + name: Parameterized queries + parent: Query with SQL + identifier: parameterized-queries-sql +influxdb/cloud-serverless/tags: [query, security, sql] +list_code_example: | + ##### Using Go and the influxdb3-go client + + ```go + // Use the $parameter syntax to reference parameters in a query. + // The following SQL query contains $room and $min_temp placeholders. + query := ` + SELECT * FROM home + WHERE time >= $min_time + AND temp >= $min_temp + AND room = $room` + + // Assign parameter names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + "min_time": "2024-03-18 00:00:00.00", + + } + + // Call the client's function to query InfluxDB with parameters. + iterator, err := client.QueryWithParameters(context.Background(), query, parameters) + ``` +--- + +Parameterized queries in {{% product-name %}} let you dynamically and safely change values in a query. +If your application code allows user input to customize values or expressions in a query, use a parameterized query to make sure untrusted input is processed strictly as data and not executed as code. + +Parameterized queries: + +- help prevent injection attacks, which can occur if input is executed as code +- help make queries more reusable + +{{% note %}} +#### Prevent injection attacks + +For more information on security and query parameterization, +see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). +{{% /note %}} + +In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. + +- [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) +- [Parameter data types](#parameter-data-types) + - [Data type examples](#data-type-examples) + - [Time expressions](#time-expressions) + - [Not compatible with parameters](#not-compatible-with-parameters) +- [Parameterize an SQL query](#parameterize-an-sql-query) +- [Execute parameterized SQL queries](#execute-parameterized-sql-queries) + - [Use InfluxDB Flight RPC clients](#use-influxdb-flight-rpc-clients) +- [Client support for parameterized queries](#client-support-for-parameterized-queries) +- [Not supported](#not-supported) + +{{% note %}} + +#### Parameters only supported in `WHERE` expressions + +InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +Parameter values must be one of the [allowed parameter data types](#parameter-data-types). + +If you use parameters in other expressions or clauses, +such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect. + +{{% /note %}} + +## Use parameters in `WHERE` expressions + +You can use parameters in `WHERE` clause **predicate expressions**-–for example, the following query contains a `$temp` parameter: + +```sql +SELECT * FROM measurement WHERE temp > $temp +``` + +When executing a query, you specify parameter name-value pairs. +The value that you assign to a parameter must be one of the [parameter data types](#parameter-data-types). + +```go +{"temp": 22.0} +``` + +The InfluxDB Querier parses the query text with the parameter placeholders, and then generates query plans that replace the placeholders with the values that you provide. +This separation of query structure from input data ensures that input is treated as one of the allowed [data types](#parameter-data-types) and not as executable code. + +## Parameter data types + +A parameter value can be one of the following data types: + +- Null +- Boolean +- Unsigned integer (`u_int64`) +- Integer (`int64`) +- Double (`float64`) +- String + +### Data type examples + +```js +{ + "string": "Living Room", + "double": 3.14, + "unsigned_integer": 1234, + "integer": -1234, + "boolean": false, + "null": Null, +} +``` + +### Time expressions + +To parameterize time bounds, substitute a parameter for a timestamp literal--for example: + +```sql +SELECT * +FROM home +WHERE time >= $min_time +``` + +For the parameter value, specify the timestamp literal as a string--for example: + +{{% influxdb/custom-timestamps %}} + +```go +// Assign a timestamp string literal to the min_time parameter. +parameters := influxdb3.QueryParameters{ + "min_time": "2022-01-01 00:00:00.00", +} +``` + +{{% /influxdb/custom-timestamps %}} + +InfluxDB executes the query as the following: + +{{% influxdb/custom-timestamps %}} + +```sql +SELECT * +FROM home +WHERE time >= '2022-01-01 00:00:00.00' +``` + +{{% /influxdb/custom-timestamps %}} + +### Not compatible with parameters + +If you use parameters for the following, your query might not work as you expect: + +- In clauses other than `WHERE`, such as `SELECT` or `GROUP BY` +- As function arguments, such as `avg($temp)` +- In place of identifiers, such as column or table names +- In place of duration literals, such as `INTERVAL $minutes` + +## Parameterize an SQL query + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} bucket before running the example queries. +{{% /note %}} + +To use a parameterized query, do the following: + +1. In your query text, use the `$parameter` syntax to reference a parameter name--for example, +the following query contains `$room` and `$min_temp` parameter placeholders: + + ```sql + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room + ``` + +2. Provide a value for each parameter name. + If you don't assign a value for a parameter, InfluxDB returns an error. + The syntax for providing parameter values depends on the client you use--for example: + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - INTERVAL '7 days' +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized SQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} bucket before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized SQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_BUCKET") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query and parameters. The default QueryType is SQL. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following SQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/cloud-serverless/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md b/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md index 5f5f04965..a6e904c0b 100644 --- a/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md +++ b/content/influxdb/cloud-serverless/reference/cli/influx/delete/_index.md @@ -15,4 +15,12 @@ metadata: [influx CLI 2.0.3+] updated_in: CLI v2.2.0 --- +{{% warn %}} +#### InfluxDB Cloud Serverless does not support data deletion + +InfluxDB Cloud Serverless does not currently support deleting data. +This command is only supported when used with **InfluxDB OSS v2** and +**InfluxDB Cloud (TSM)**. +{{% /warn %}} + {{< duplicate-oss >}} diff --git a/content/influxdb/cloud-serverless/reference/influxql/_index.md b/content/influxdb/cloud-serverless/reference/influxql/_index.md index faa8b2baa..a49de51af 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/_index.md +++ b/content/influxdb/cloud-serverless/reference/influxql/_index.md @@ -1,5 +1,5 @@ --- -title: InfluxQL reference +title: InfluxQL reference documentation list_title: InfluxQL description: InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: diff --git a/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md b/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md index 7aeacf6d5..8d2df3f29 100644 --- a/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md +++ b/content/influxdb/cloud-serverless/reference/influxql/time-and-timezone.md @@ -27,6 +27,7 @@ You can review the following ways to work with time and timestamps in your Influ - [Notable behaviors](#notable-behaviors) - [Cannot query multiple time ranges](#cannot-query-multiple-time-ranges) - [Querying future data with a `GROUP BY time()` clause](#querying-future-data-with-a-group-by-time-clause) + - [Cannot use parameters for durations](#cannot-use-parameters-for-durations) ## Time syntax @@ -81,7 +82,7 @@ InfluxQL requires a whitespace between the `+` operators `-` and the duration li ## Query time range -To specify the time range of a query, use conditional expressions in the +To specify the time range of a query, use conditional expressions in the [`WHERE` clause](/inflxudb/cloud-serverless/reference/influxql/where/) that compare the value of the `time` column to an absolute timestamp or a relative timestamp. @@ -151,7 +152,7 @@ WHERE AND time <= '2022-01-01T12:00:00Z' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home {{% /influxql/table-meta %}} @@ -178,9 +179,9 @@ WHERE AND time <= '2022-01-01 12:00:00' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -206,9 +207,9 @@ WHERE AND time <= 1641038400000000000 ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -233,9 +234,9 @@ WHERE AND time <= 1641038400s ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -255,9 +256,9 @@ name: home SELECT * FROM home WHERE time >= '2022-01-01T20:00:00Z' - 2h ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :---------- | ---: | @@ -285,10 +286,10 @@ SELECT * FROM home WHERE time >= now() - 2h {{% warn %}} InfluxQL in {{< product-name >}} does not currently support the time zone clause, which applies a time zone offset to UTC timestamps in query results. - -**Tracking issue**: [influxdb_iox#6933](https://github.com/influxdata/influxdb_iox/issues/6933) {{% /warn %}} + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - 7d +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized InfluxQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized InfluxQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters, + options influxdb3.QueryOptions) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_DATABASE") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query, parameters, and the InfluxQL QueryType option. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters, influxdb3.WithQueryType(options.QueryType)) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following InfluxQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - 7d + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + + Query(query, parameters, influxdb3.QueryOptions{ + QueryType: influxdb3.InfluxQL, + }) +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/clustered/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/clustered/query-data/sql/parameterized-queries.md b/content/influxdb/clustered/query-data/sql/parameterized-queries.md new file mode 100644 index 000000000..bceca9d89 --- /dev/null +++ b/content/influxdb/clustered/query-data/sql/parameterized-queries.md @@ -0,0 +1,346 @@ +--- +title: Use parameterized queries with SQL +description: > + Use parameterized queries to prevent injection attacks and make queries more reusable. +weight: 404 +menu: + influxdb_clustered: + name: Parameterized queries + parent: Query with SQL + identifier: parameterized-queries-sql +influxdb/clustered/tags: [query, security, sql] +list_code_example: | + ##### Using Go and the influxdb3-go client + + ```go + // Use the $parameter syntax to reference parameters in a query. + // The following SQL query contains $room and $min_temp placeholders. + query := ` + SELECT * FROM home + WHERE time >= $min_time + AND temp >= $min_temp + AND room = $room` + + // Assign parameter names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + "min_time": "2024-03-18 00:00:00.00", + + } + + // Call the client's function to query InfluxDB with parameters. + iterator, err := client.QueryWithParameters(context.Background(), query, parameters) + ``` +--- + +Parameterized queries in {{% product-name %}} let you dynamically and safely change values in a query. +If your application code allows user input to customize values or expressions in a query, use a parameterized query to make sure untrusted input is processed strictly as data and not executed as code. + +Parameterized queries: + +- help prevent injection attacks, which can occur if input is executed as code +- help make queries more reusable + +{{% note %}} +#### Prevent injection attacks + +For more information on security and query parameterization, +see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries). +{{% /note %}} + +In InfluxDB v3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data. + +- [Use parameters in `WHERE` expressions](#use-parameters-in-where-expressions) +- [Parameter data types](#parameter-data-types) + - [Data type examples](#data-type-examples) + - [Time expressions](#time-expressions) + - [Not compatible with parameters](#not-compatible-with-parameters) +- [Parameterize an SQL query](#parameterize-an-sql-query) +- [Execute parameterized SQL queries](#execute-parameterized-sql-queries) + - [Use InfluxDB Flight RPC clients](#use-influxdb-flight-rpc-clients) +- [Client support for parameterized queries](#client-support-for-parameterized-queries) +- [Not supported](#not-supported) + +{{% note %}} + +#### Parameters only supported in `WHERE` expressions + +InfluxDB v3 supports parameters in `WHERE` clause **predicate expressions**. +Parameter values must be one of the [allowed parameter data types](#parameter-data-types). + +If you use parameters in other expressions or clauses, +such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect. + +{{% /note %}} + +## Use parameters in `WHERE` expressions + +You can use parameters in `WHERE` clause **predicate expressions**-–for example, the following query contains a `$temp` parameter: + +```sql +SELECT * FROM measurement WHERE temp > $temp +``` + +When executing a query, you specify parameter name-value pairs. +The value that you assign to a parameter must be one of the [parameter data types](#parameter-data-types). + +```go +{"temp": 22.0} +``` + +The InfluxDB Querier parses the query text with the parameter placeholders, and then generates query plans that replace the placeholders with the values that you provide. +This separation of query structure from input data ensures that input is treated as one of the allowed [data types](#parameter-data-types) and not as executable code. + +## Parameter data types + +A parameter value can be one of the following data types: + +- Null +- Boolean +- Unsigned integer (`u_int64`) +- Integer (`int64`) +- Double (`float64`) +- String + +### Data type examples + +```js +{ + "string": "Living Room", + "double": 3.14, + "unsigned_integer": 1234, + "integer": -1234, + "boolean": false, + "null": Null, +} +``` + +### Time expressions + +To parameterize time bounds, substitute a parameter for a timestamp literal--for example: + +```sql +SELECT * +FROM home +WHERE time >= $min_time +``` + +For the parameter value, specify the timestamp literal as a string--for example: + +{{% influxdb/custom-timestamps %}} + +```go +// Assign a timestamp string literal to the min_time parameter. +parameters := influxdb3.QueryParameters{ + "min_time": "2022-01-01 00:00:00.00", +} +``` + +{{% /influxdb/custom-timestamps %}} + +InfluxDB executes the query as the following: + +{{% influxdb/custom-timestamps %}} + +```sql +SELECT * +FROM home +WHERE time >= '2022-01-01 00:00:00.00' +``` + +{{% /influxdb/custom-timestamps %}} + +### Not compatible with parameters + +If you use parameters for the following, your query might not work as you expect: + +- In clauses other than `WHERE`, such as `SELECT` or `GROUP BY` +- As function arguments, such as `avg($temp)` +- In place of identifiers, such as column or table names +- In place of duration literals, such as `INTERVAL $minutes` + +## Parameterize an SQL query + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +To use a parameterized query, do the following: + +1. In your query text, use the `$parameter` syntax to reference a parameter name--for example, +the following query contains `$room` and `$min_temp` parameter placeholders: + + ```sql + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room + ``` + +2. Provide a value for each parameter name. + If you don't assign a value for a parameter, InfluxDB returns an error. + The syntax for providing parameter values depends on the client you use--for example: + + + + {{< code-tabs-wrapper >}} + {{% code-tabs %}} + [Go](#) + {{% /code-tabs %}} + {{% code-tab-content %}} + + ```go + // Define a QueryParameters struct--a map of parameters to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } + ``` + + {{% /code-tab-content %}} + {{< /code-tabs-wrapper >}} + +After InfluxDB receives your request and parses the query, it executes the query as + +```sql +SELECT * +FROM home +WHERE time > now() - INTERVAL '7 days' +AND temp >= 20.0 +AND room = 'Kitchen' +``` + +## Execute parameterized SQL queries + +{{% note %}} +#### Sample data + +The following examples use the +[Get started home sensor data](/influxdb/clustered/reference/sample-data/#get-started-home-sensor-data). +To run the example queries and return results, +[write the sample data](/influxdb/clustered/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +to your {{% product-name %}} database before running the example queries. +{{% /note %}} + +### Use InfluxDB Flight RPC clients + +Using the InfluxDB v3 native Flight RPC protocol and supported clients, you can send a parameterized query and a list of parameter name-value pairs. +InfluxDB Flight clients that support parameterized queries pass the parameter name-value pairs in a Flight ticket `params` field. + +The following examples show how to use client libraries to execute parameterized SQL queries: + + + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[Go](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} + +```go +import ( + "context" + "fmt" + "io" + "os" + "text/tabwriter" + "time" + "github.com/apache/arrow/go/v14/arrow" + "github.com/InfluxCommunity/influxdb3-go/influxdb3" +) + +func Query(query string, parameters influxdb3.QueryParameters) error { + url := os.Getenv("INFLUX_HOST") + token := os.Getenv("INFLUX_TOKEN") + database := os.Getenv("INFLUX_DATABASE") + + // Instantiate the influxdb3 client. + client, err := influxdb3.New(influxdb3.ClientConfig{ + Host: url, + Token: token, + Database: database, + }) + + if err != nil { + panic(err) + } + + // Ensure the client is closed after the Query function finishes. + defer func(client *influxdb3.Client) { + err := client.Close() + if err != nil { + panic(err) + } + }(client) + + // Call the client's QueryWithParameters function. + // Provide the query and parameters. The default QueryType is SQL. + iterator, err := client.QueryWithParameters(context.Background(), query, + parameters) + + // Create a buffer for storing rows as you process them. + w := tabwriter.NewWriter(io.Discard, 4, 4, 1, ' ', 0) + w.Init(os.Stdout, 0, 8, 0, '\t', 0) + + fmt.Fprintf(w, "time\troom\tco\thum\ttemp\n") + + // Format and write each row to the buffer. + // Process each row as key-value pairs. + for iterator.Next() { + row := iterator.Value() + // Use Go arrow and time packages to format unix timestamp + // as a time with timezone layout (RFC3339 format) + time := (row["time"].(arrow.Timestamp)). + ToTime(arrow.Nanosecond).Format(time.RFC3339) + + fmt.Fprintf(w, "%s\t%s\t%d\t%.1f\t%.1f\n", + time, row["room"], row["co"], row["hum"], row["temp"]) + } + w.Flush() + + return nil +} + +func main() { + // Use the $placeholder syntax in a query to reference parameter placeholders + // for input data. + // The following SQL query contains the placeholders $room and $min_temp. + query := ` + SELECT * + FROM home + WHERE time > now() - INTERVAL '7 days' + AND temp >= $min_temp + AND room = $room` + + // Define a QueryParameters struct--a map of placeholder names to input values. + parameters := influxdb3.QueryParameters{ + "room": "Kitchen", + "min_temp": 20.0, + } +} +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +## Client support for parameterized queries + +- Not all [InfluxDB v3 Flight clients](/influxdb/clustered/reference/client-libraries/v3/) support parameterized queries. +- InfluxDB doesn't currently support parameterized queries or DataFusion prepared statements for Flight SQL or Flight SQL clients. +- InfluxDB v3 SQL and InfluxQL parameterized queries aren’t supported in InfluxDB v1 and v2 clients. + +## Not supported + +Currently, parameterized queries in {{% product-name %}} don't provide the following: + +- support for DataFusion prepared statements +- query caching, optimization, or performance benefits diff --git a/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md new file mode 100644 index 000000000..4d6ccf441 --- /dev/null +++ b/content/influxdb/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md @@ -0,0 +1,312 @@ +--- +title: Report query performance issues +description: > + A comprehensive guide on ensuring a quick turnaround when troubleshooting query performance. +menu: + influxdb_clustered: + name: Report query performance issues + parent: Troubleshoot and optimize queries +weight: 402 +--- + +These guidelines are intended to faciliate collaboration between InfluxData +engineers and you. They allow engineers to conduct timely analyses of any performance +issues that you have not been able to resolve following our [guide on +troubleshooting and optimizing +queries](/influxdb/clustered/query-data//troubleshoot-and-optimize). + +1. [Send InfluxData output artifacts](#send-influxdata-output-artifacts) +2. [Document your test process](#document-your-test-process) +3. [Document your environment](#document-your-environment) +4. [Document your data schema](#document-your-data-schema) +5. [Establish query performance degradation conditions](#establish-query-performance-degradation-conditions) +6. [Reduce query noise](#reduce-query-noise) +7. [Establish baseline single-query performance](#establish-baseline-single-query-performance) +8. [Run queries at multiple load scales](#run-queries-at-multiple-load-scales) +9. [Gather debug info](#gather-debug-info) + 1. [Kubernetes-specific information](#kubernetes-specific-information) + 2. [Clustered-specific information](#clustered-specific-information) + 3. [Query analysis](#query-analysis) + 1. [EXPLAIN](#explain) + 2. [EXPLAIN VERBOSE](#explain-verbose) + 3. [EXPLAIN ANALYZE](#explain-analyze) + +{{% note %}} +Please note that this document may change from one support engagement to the +next as our process and tooling improves. +{{% /note %}} + +### Send InfluxData output artifacts + +As you follow these guidelines, package all produced output artifacts in the following form: + +**Outputs:** + +- `test-artifact-name.tar.gz` + +Send InfluxData engineers all produced artifacts for analysis. + +### Document your test process + +There currently is no standardized performance test suite that you can run in +your environment, so please document your process so it can be replicated. +Include the following: + +- The steps you take when performance testing. +- Timestamps of the tests you perform so they can be correlated with associated logs. + +### Document your environment + +Provide as much detail about your environment as your organization allows, +including the following: + +- Your kubernetes cluster +- The cloud provider where it runs or indicate that it's "on-prem" +- The hardware it runs on +- The type and size of disk in use--for example: hard disk, SSD, NVMe, etc. +- CPU and memory resources set on each type of InfluxDB pod +- The number of pods in each InfluxDB StatefulSet and Deployment +- The type of object store used and how it is hosted +- How the Catalog (PostgreSQL-compatible database) is hosted +- Indicate if either the Object store or the Catalog is shared by more than one InfluxDB + Clustered product + - If so, describe the network-level topology of your setup + +{{% note %}} +#### If possible, provide a synthetic dataset + +If you can reproduce the performance issue with a synthetic dataset and your +process and environment are well-documented, InfluxData engineers _may_ +be able to reproduce the issue, shorten the feedback cycle, and resolve the +issue sooner. +{{% /note %}} + +### Document your data schema + +Document your the data schema to help InfluxData engineers better understand the +conditions that reproduce your issue. + +### Establish query performance degradation conditions + +The most effective way to investigate query performance is to have a good understanding of +the conditions in which you don't see the expected performance. Things to think about +and provide: + +- Does this always happen, or only sometimes? + - If only sometimes, is it at a consistent time of day or over a consistent period? +- Will a single query execution reproduce the issue, or does it only appear with multiple queries + are running at the same time? +- How are you executing the queries? For example: + - `influxctl` + - Client libraries + - Other environments or tools + +### Reduce query noise + +To get a sense of the baseline performance of your system without the +noise of additional queries, test in an environment that doesn't have periodic +or intermittent queries running concurrently. + +Additionally, when running multiple tests with different queries, let the system +recover between tests by waiting at least a minute after receiving a query result +before executing the next query. + +### Establish baseline single-query performance + +To get a sense of the baseline performance of your system without the +noise of additional queries, perform at least some of your testing with +single queries in isolation from one another. + +This is may be useful for the purposes of analysis by InfluxData engineers even if a +single query in isolation isn't enough to reproduce the issue you are having. + +### Run queries at multiple load scales + +Once you've established baseline performance with a single query and your +performance issue can't be replicated with a single query, use a systematic +approach to identify the scale at which it does become a problem. +This involves systematic incremental increases to your query +concurrency until you identify a threshold at which the issue can be +reproduced. + +This, along with information about your Kubernetes environment, can provide +insight necessary to recommend changes to your configuration to improve +query performance characteristis as your usage scales. + +As an example, consider the following test plan outline: + +1. Turn off intermittent or periodic InfluxDB queries and allow the cluster to recover. +2. Run Query A and allow the cluster to recover for 1 minute. +3. Run 5 concurrent instances of Query A and allow the cluster to recover for 1 minute. +4. Run 10 concurrent instances of Query A and allow the cluster to recover for 1 minute. +5. Run 20 concurrent instances of Query A and allow the cluster to recover for 1 minute. +6. Run 40 concurrent instances of Query A and allow the cluster to recover for 1 minute. +7. Provide InfluxData the debug information [described below](#gather-debug-info). + +{{% note %}} +This is just an example. You don't have to go beyond the scale where queries get slower +but you may also need to go further than what's outlined here. +{{% /note %}} + +### Gather debug info + +The following debug information should be collected shortly _after_ a + problematic query has been tried against your InfluxDB cluster. + +#### Kubernetes-specific information + +**Outputs:** + +- `${DATETIME}-cluster-info.tar.gz` + +``` +DATETIME="$(date -Iminutes)" +kubectl cluster-info dump --namespace influxdb --output-directory "${DATETIME}-cluster-info/" +tar -czf "${DATETIME}-cluster-info.tar.gz" "${DATETIME}-cluster-info/" +``` + +#### Clustered-Specific Info + +**Outputs:** + +- `app-instance.yml`: Provide a copy of your `AppInstance` manifest. + +#### Query analysis + +**Outputs (InfluxQl):** + +- `explain.csv` +- `explain-verbose.csv` +- `explain-analyze.csv` + +**Outputs (SQL):** + +- `explain.txt` +- `explain-verbose.txt` +- `explain-analyze.txt` + +For any known long-running queries, it may be helpful to execute variations of +the `EXPLAIN` command on them. + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + The name of the database to query +- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: + A database token with read permissions on the queried database +- {{% code-placeholder-key %}}`YOUR_QUERY`{{% /code-placeholder-key %}}: + Your long-running query (formatted as a single line with escaped double quotes (`\"`)) + +##### EXPLAIN + +{{% code-placeholders "DATABASE_(NAME|TOKEN)|YOUR_QUERY" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[SQL](#) +[InfluxQL](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +``` +influxctl \ + --config config.toml \ + query \ + --database DATABASE_NAME \ + --format table \ + --token DATABASE_TOKEN \ + "EXPLAIN YOUR_QUERY;" > explain.txt +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +``` +curl --get "https://{{< influxdb/host >}}/query" \ + --output "./explain.csv" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Accept: application/csv" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=EXPLAIN YOUR_QUERY" +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +##### EXPLAIN VERBOSE + +{{% code-placeholders "DATABASE_(NAME|TOKEN)|YOUR_QUERY" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[SQL](#) +[InfluxQL](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +``` +influxctl \ + --config config.toml \ + query \ + --database DATABASE_NAME \ + --format table \ + --token DATABASE_TOKEN \ + "EXPLAIN VERBOSE YOUR_QUERY;" > explain-verbose.txt +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +``` +curl --get "https://{{< influxdb/host >}}/query" \ + --output "./explain-verbose.csv" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Accept: application/csv" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=EXPLAIN VERBOSE YOUR_QUERY" +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +##### EXPLAIN ANALYZE + +{{% code-placeholders "DATABASE_(NAME|TOKEN)|YOUR_QUERY" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[SQL](#) +[InfluxQL](#) +{{% /code-tabs %}} +{{% code-tab-content %}} + +``` +influxctl \ + --config config.toml \ + query \ + --database DATABASE_NAME \ + --format table \ + --token DATABASE_TOKEN \ + "EXPLAIN ANALYZE YOUR_QUERY;" > explain-analyze.txt +``` + +{{% /code-tab-content %}} +{{% code-tab-content %}} + +``` +curl --get "https://{{< influxdb/host >}}/query" \ + --output "./explain-analyze.csv" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Accept: application/csv" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=EXPLAIN ANALYZE YOUR_QUERY" +``` + +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/_index.md b/content/influxdb/clustered/reference/cli/influxctl/_index.md index 21adf2481..a03017bc0 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/_index.md +++ b/content/influxdb/clustered/reference/cli/influxctl/_index.md @@ -336,6 +336,7 @@ If stored at a non-default location, include the `--config` flag with each ## By default, the system certificates are used. If a custom certificate ## for connecting to InfluxDB is required, define it below. # [profile.tls] + # insecure = false # cert = "" # key = "" # ca = "" diff --git a/content/influxdb/clustered/reference/cli/influxctl/query.md b/content/influxdb/clustered/reference/cli/influxctl/query.md index 0b4ca04e3..a0e262330 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/query.md +++ b/content/influxdb/clustered/reference/cli/influxctl/query.md @@ -14,19 +14,18 @@ related: --- The `influxctl query` command queries data from {{< product-name >}} using SQL -and prints results as a table or JSON. +or InfluxQL and prints results as a table or JSON. -Provide the SQL query in one of the following ways: +Provide the query in one of the following ways: - a string on the command line - a path to a file that contains the query -- a single dash (`-`) to read the query from stdin +- as a single dash (`-`) to read the query from stdin {{% note %}} #### Important to note - This command supports only one query per execution. -- This command supports only SQL queries; not InfluxQL. - This command is not meant to be a full, feature-rich query tool. It's meant for debug, triage, and basic data exploration. {{% /note %}} @@ -34,9 +33,9 @@ Provide the SQL query in one of the following ways: ### InfluxDB connection configuration Your {{< product-name omit=" Clustered" >}} cluster host and port are -configured in your in your `influxctl` +configured in your `influxctl` [connection profile](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles). -Default is TLS and port 443. +Default uses TLS and port 443. You can set a default database and token to use for the `query` and `write` commands in your connection profile or pass them with the command using the `--database` and `--token` flags. @@ -56,18 +55,20 @@ influxctl query [flags] ## Arguments -| Argument | Description | -| :-------- | :---------------------------------------------------------------------------------- | -| **QUERY** | SQL query to execute (command line string, path to file, or `-` to read from stdin) | +| Argument | Description | +| :-------- | :------------------------------------------------------------------------------ | +| **QUERY** | Query to execute (command line string, path to file, or `-` to read from stdin) | ## Flags -| Flag | | Description | -| :--- | :----------- | :----------------------------------------------------------- | -| | `--database` | Database to query | -| | `--format` | Output format (`table` _(default)_ or `json`) | -| | `--token` | Database token with read permissions on the queried database | -| `-h` | `--help` | Output command help | +| Flag | | Description | +| :--- | :----------------------- | :----------------------------------------------------------- | +| | `--database` | Database to query | +| | `--enable-system-tables` | Enable ability to query system tables | +| | `--format` | Output format (`table` _(default)_ or `json`) | +| | `--language` | Query language (`sql` _(default)_ or `influxql`) | +| | `--token` | Database token with read permissions on the queried database | +| `-h` | `--help` | Output command help | {{% caption %}} _Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._ @@ -75,9 +76,12 @@ _Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl ## Examples +- [Query InfluxDB v3 with SQL](#query-influxdb-v3-with-sql) +- [Query InfluxDB v3 with InfluxQL](#query-influxdb-v3-with-influxql) - [Query InfluxDB v3 and return results in table format](#query-influxdb-v3-and-return-results-in-table-format) - [Query InfluxDB v3 and return results in JSON format](#query-influxdb-v3-and-return-results-in-json-format) - [Query InfluxDB v3 using credentials from the connection profile](#query-influxdb-v3-using-credentials-from-the-connection-profile) +- [Query data from InfluxDB v3 system tables](#query-data-from-influxdb-v3-system-tables) In the examples below, replace the following: @@ -86,6 +90,89 @@ In the examples below, replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to query +### Query InfluxDB v3 with SQL + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + /path/to/query.sql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.sql | influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +### Query InfluxDB v3 with InfluxQL + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + /path/to/query.influxql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.influxql | influxctl query \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --language influxql \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + ### Query InfluxDB v3 and return results in table format {{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} @@ -242,6 +329,70 @@ The following example uses the `database` and `token` defined in the `default` {{% influxdb/custom-timestamps %}} ```sh -influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z' LIMIT 5" +influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'" ``` {{% /influxdb/custom-timestamps %}} + +### Query data from InfluxDB v3 system tables + +{{% note %}} +You must use **SQL** to query InfluxDB v3 system tables. +{{% /note %}} + +{{% warn %}} +Querying system tables can impact the overall performance of your +{{< product-name omit=" Clustered" >}} cluster. System tables are not part of +InfluxDB's stable API and are subject to change. +{{% /warn %}} + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + "SELECT * FROM system.tables" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + /path/to/query.sql +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./query.sql | influxctl query \ + --enable-system-tables \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + +{{% expand "View command updates" %}} + +#### v2.8.0 {date="2024-04-11"} + +- Add InfluxQL support and introduce the `--language` flag to specify the query + language. +- Add `--enable-system-tables` flag to enable the ability to query InfluxDB v3 + system tables. + +{{% /expand %}} diff --git a/content/influxdb/clustered/reference/cli/influxctl/write.md b/content/influxdb/clustered/reference/cli/influxctl/write.md index 91054a109..bc41ef3e1 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/write.md +++ b/content/influxdb/clustered/reference/cli/influxctl/write.md @@ -60,6 +60,7 @@ influxctl write [flags] | | `--batch-size` | Number of metrics to write per batch (default is `10000`) | | | `--database` | Database to write to | | | `--precision` | Precision of data timestamps (`ns` _(default)_, `us`, `ms`, or `s`) | +| | `--timeout` | Client timeout in seconds (default is `10`) | | | `--token` | Database token with write permissions on the target database | | `-h` | `--help` | Output command help | @@ -72,6 +73,7 @@ _Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl - [Write line protocol to InfluxDB v3](#write-line-protocol-to-influxdb-v3) - [Write line protocol to InfluxDB v3 with non-default timestamp precision](#write-line-protocol-to-influxdb-v3-with-non-default-timestamp-precision) - [Write line protocol to InfluxDB v3 with a custom batch size](#write-line-protocol-to-influxdb-v3-with-a-custom-batch-size) +- [Write line protocol to InfluxDB v3 with a custom client timeout](#write-line-protocol-to-influxdb-v3-with-a-custom-client-timeout) - [Write line protocol to InfluxDB v3 using credentials from the connection profile](#write-line-protocol-to-influxdb-v3-using-credentials-from-the-connection-profile) In the examples below, replace the following: @@ -219,6 +221,53 @@ cat ./metrics.lp | influxctl write \ {{% /code-placeholders %}} +### Write line protocol to InfluxDB v3 with a custom client timeout + +{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}} + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[string](#) +[file](#) +[stdin](#) +{{% /code-tabs %}} +{{% code-tab-content %}} +{{% influxdb/custom-timestamps %}} +```sh +influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000 +home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000 +home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600 +home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600 +" +``` +{{% /influxdb/custom-timestamps %}} +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + /path/to/metrics.lp +``` +{{% /code-tab-content %}} +{{% code-tab-content %}} +```sh +cat ./metrics.lp | influxctl write \ + --token DATABASE_TOKEN \ + --database DATABASE_NAME \ + --timeout 20 \ + - +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +{{% /code-placeholders %}} + ### Write line protocol to InfluxDB v3 using credentials from the connection profile The following example uses the `database` and `token` defined in the `default` @@ -233,3 +282,11 @@ home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600000000000 " ``` {{% /influxdb/custom-timestamps %}} + +{{% expand "View command updates" %}} + +#### v2.8.0 {date="2024-04-11"} + +- Add `--timeout` flag to specify a custom client timeout. + +{{% /expand %}} diff --git a/content/influxdb/clustered/reference/influxql/_index.md b/content/influxdb/clustered/reference/influxql/_index.md index 80b6853c3..b06c14e51 100644 --- a/content/influxdb/clustered/reference/influxql/_index.md +++ b/content/influxdb/clustered/reference/influxql/_index.md @@ -1,5 +1,5 @@ --- -title: InfluxQL reference +title: InfluxQL reference documentation list_title: InfluxQL description: InfluxQL is an SQL-like query language for interacting with data in InfluxDB. menu: diff --git a/content/influxdb/clustered/reference/influxql/time-and-timezone.md b/content/influxdb/clustered/reference/influxql/time-and-timezone.md index a7af6f0e8..34b34e806 100644 --- a/content/influxdb/clustered/reference/influxql/time-and-timezone.md +++ b/content/influxdb/clustered/reference/influxql/time-and-timezone.md @@ -27,6 +27,7 @@ You can review the following ways to work with time and timestamps in your Influ - [Notable behaviors](#notable-behaviors) - [Cannot query multiple time ranges](#cannot-query-multiple-time-ranges) - [Querying future data with a `GROUP BY time()` clause](#querying-future-data-with-a-group-by-time-clause) + - [Cannot use parameters for durations](#cannot-use-parameters-for-durations) ## Time syntax @@ -81,7 +82,7 @@ InfluxQL requires a whitespace between the `+` operators `-` and the duration li ## Query time range -To specify the time range of a query, use conditional expressions in the +To specify the time range of a query, use conditional expressions in the [`WHERE` clause](/inflxudb/clustered/reference/influxql/where/) that compare the value of the `time` column to an absolute timestamp or a relative timestamp. @@ -151,7 +152,7 @@ WHERE AND time <= '2022-01-01T12:00:00Z' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home {{% /influxql/table-meta %}} @@ -178,9 +179,9 @@ WHERE AND time <= '2022-01-01 12:00:00' ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -206,9 +207,9 @@ WHERE AND time <= 1641038400000000000 ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -233,9 +234,9 @@ WHERE AND time <= 1641038400s ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :------ | ---: | @@ -255,9 +256,9 @@ name: home SELECT * FROM home WHERE time >= '2022-01-01T20:00:00Z' - 2h ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------- | --: | ---: | :---------- | ---: | @@ -320,9 +321,9 @@ WHERE tz('America/Chicago') ``` -{{% influxql/table-meta %}} +{{% influxql/table-meta %}} name: home -{{% /influxql/table-meta %}} +{{% /influxql/table-meta %}} | time | co | hum | room | temp | | :------------------------ | --: | ---: | :------ | ---: | @@ -341,6 +342,7 @@ name: home - [Cannot query multiple time ranges](#cannot-query-multiple-time-ranges) - [Querying future data with a `GROUP BY time()` clause](#querying-future-data-with-a-group-by-time-clause) +- [Cannot use parameters for durations](#cannot-use-parameters-for-durations) ### Cannot query multiple time ranges @@ -370,3 +372,8 @@ between `1677-09-21T00:12:43.145224193Z` and To query data with timestamps that occur in the future (after `now()`), provide an explicit upper bound in the `WHERE` clause. + +### Cannot use parameters for durations + +Currently, InfluxDB doesn't support using parameters for durations in +[parameterized queries](/influxdb/clustered/query-data/parameterized-queries/). diff --git a/content/influxdb/clustered/reference/release-notes/influxctl.md b/content/influxdb/clustered/reference/release-notes/influxctl.md index 264ba2763..c47244e99 100644 --- a/content/influxdb/clustered/reference/release-notes/influxctl.md +++ b/content/influxdb/clustered/reference/release-notes/influxctl.md @@ -12,6 +12,65 @@ weight: 202 canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/ --- +## v2.8.0 {date="2024-04-11"} + +`influxctl` 2.8.0 requires InfluxDB Clustered version 20240326-922145 or newer. +A change was made to how database commands were handled internally in InfluxDB +Clustered that required this change. If using an older version of InfluxDB +Clustered, you will observe an unimplemented gRPC error when using functionality +that depends on the updated command handling. If upgrading is not possible, you +can continue to use a version prior to 2.8.0 until you are able to update. + +### Features + +- Introduce the ability to query with InfluxQL. +- Add insecure configuration option to TLS configuration. +- Allow users to query system tables. +- Utilize the database proxy service. + +### Dependency Updates + +- Update Go to v1.22.2. +- Update `github.com/go-git/go-git/v5` from 5.11.0 to 5.12.0. +- Update `github.com/jedib0t/go-pretty/v6` from 6.5.6 to 6.5.8. +- Update `golang.org/x/mod` from 0.16.0 to 0.17.0. +- Update `golang.org/x/oauth2` from 0.18.0 to 0.19.0. +- Update `google.golang.org/grpc` from 1.62.1 to 1.63.2. + +--- + +## v2.7.1 {date="2024-03-27"} + +### Bug Fixes + +- Correctly parse template tag bucket strings. + +--- + +## v2.7.0 {date="2024-03-26"} + +This minor release adds the `--template-tag-bucket` partition template option to +the already existing `--template-time-format` and `--template-tag` options used +to define custom partition templates for databases and tables. +This also fixes a nil pointer issue when listing management tokens. + +### Features + +- Introduce the bucket template method for grouping tag values into buckets and + partitioning by each tag bucket. + +### Bug Fixes + +- Ensure strings are not nil pointers. + +### Dependency Updates + +- Update `github.com/jedib0t/go-pretty/v6` from 6.5.5 to 6.5.6. +- Update `github.com/pelletier/go-toml/v2` from 2.1.1 to 2.2.0. +- Update granite proto. + +--- + ## v2.6.0 {date="2024-03-18"} `influxctl` 2.6.0 introduces the ability to create, list, and revoke diff --git a/content/influxdb/clustered/reference/sql/data-types.md b/content/influxdb/clustered/reference/sql/data-types.md index 51bab2f43..bcd987f17 100644 --- a/content/influxdb/clustered/reference/sql/data-types.md +++ b/content/influxdb/clustered/reference/sql/data-types.md @@ -19,17 +19,18 @@ In InfluxDB's SQL implementation, a **measurement** is structured as a table, and **tags**, **fields** and **timestamps** are exposed as columns. DataFusion uses the [Arrow](https://arrow.apache.org/) type system for query execution. -Data types stored in InfluxDB's storage engine are mapped to SQL data types at query time. +Data types stored in InfluxDB's storage engine are mapped to SQL data types at query time. {{% note %}} -When performing casting operations, cast to the **name** of the data type, not the actual data type. +When performing casting operations, cast to the **name** of the data type, not the actual data type. Names and identifiers in SQL are _case-insensitive_ by default. For example: ```sql SELECT - '99'::BIGINT, + '99'::BIGINT, '2019-09-18T00:00:00Z'::timestamp ``` + {{% /note %}} - [String types](#string-types) @@ -39,9 +40,10 @@ SELECT - [Floats](#floats) - [Date and time data types](#date-and-time-data-types) - [Timestamp](#timestamp) - - [Interval ](#interval-) + - [Interval](#interval) - [Boolean types](#boolean-types) - [Unsupported SQL types](#unsupported-sql-types) +- [Data types compatible with parameters](#data-types-compatible-with-parameters) ## String types @@ -74,7 +76,7 @@ The following numeric types are supported: InfluxDB SQL supports the 64-bit signed integers: -**Minimum signed integer**: `-9223372036854775808` +**Minimum signed integer**: `-9223372036854775808` **Maximum signed integer**: `9223372036854775807` ##### Example integer literals @@ -89,7 +91,7 @@ InfluxDB SQL supports the 64-bit signed integers: InfluxDB SQL supports the 64-bit unsigned integers: -**Minimum unsigned integer**: `0` +**Minimum unsigned integer**: `0` **Maximum unsigned integer**: `18446744073709551615` ##### Example unsigned integer literals @@ -127,14 +129,14 @@ InfluxDB SQL supports the following DATE/TIME data types: ### Timestamp -A time type is a single point in time using nanosecond precision. +A time type is a single point in time using nanosecond precision. The following date and time formats are supported: ```sql -YYYY-MM-DDT00:00:00.000Z -YYYY-MM-DDT00:00:00.000-00:00 -YYYY-MM-DD 00:00:00.000-00:00 +YYYY-MM-DDT00:00:00.000Z +YYYY-MM-DDT00:00:00.000-00:00 +YYYY-MM-DD 00:00:00.000-00:00 YYYY-MM-DDT00:00:00Z YYYY-MM-DD 00:00:00.000 YYYY-MM-DD 00:00:00 @@ -151,9 +153,9 @@ YYYY-MM-DD 00:00:00 '2023-01-02 03:04:06' ``` -### Interval +### Interval -The INTERVAL data type can be used with the following precision: +The INTERVAL data type can be used with the following precision: - nanosecond - microsecond @@ -161,7 +163,7 @@ The INTERVAL data type can be used with the following precision: - second - minute - hour -- day +- day - week - month - year @@ -176,7 +178,7 @@ INTERVAL '2 days 1 hour 31 minutes' ## Boolean types -Booleans store TRUE or FALSE values. +Booleans store TRUE or FALSE values. | Name | Data type | Description | | :------ | :-------- | :------------------- | @@ -208,3 +210,8 @@ The following SQL types are not currently supported: - SET - DATETIME - BYTEA + +## Data types compatible with parameters + +For information about data types that can be substituted by parameters, +see how to [use parameterized queries with SQL](/influxdb/clustered/query-data/sql/parameterized-queries/). diff --git a/content/influxdb/clustered/reference/sql/functions/string.md b/content/influxdb/clustered/reference/sql/functions/string.md index 0dbf40833..bb5639366 100644 --- a/content/influxdb/clustered/reference/sql/functions/string.md +++ b/content/influxdb/clustered/reference/sql/functions/string.md @@ -240,7 +240,7 @@ LIMIT 3 Concatenates multiple strings together with a specified separator. ```sql -concat(separator, str[, ..., str_n]) +concat_ws(separator, str[, ..., str_n]) ``` ##### Arguments @@ -1484,7 +1484,7 @@ uuid() ``` {{< expand-wrapper >}} -{{% expand "View `upper` query example" %}} +{{% expand "View `uuid` query example" %}} _The following example uses the sample data set provided in the [Get started with InfluxDB tutorial](/influxdb/clustered/get-started/write/#construct-line-protocol)._ diff --git a/content/influxdb/clustered/write-data/best-practices/schema-design.md b/content/influxdb/clustered/write-data/best-practices/schema-design.md index 2ccc468e4..b1eeee758 100644 --- a/content/influxdb/clustered/write-data/best-practices/schema-design.md +++ b/content/influxdb/clustered/write-data/best-practices/schema-design.md @@ -105,7 +105,7 @@ the write fails due to a column conflict. A measurement can contain **up to 250 columns**. Each row requires a time column, but the rest represent tags and fields stored in the measurement. -Therefore, a measurement can contain one time column and 199 total field and tag columns. +Therefore, a measurement can contain one time column and 249 total field and tag columns. If you attempt to write to a measurement and exceed the 250 column limit, the write request fails and InfluxDB returns an error. @@ -137,7 +137,7 @@ The InfluxDB v3 storage engine has a [limit of 250 columns per measurement](#measurements-can-contain-up-to-250-columns). To avoid a wide schema, limit the number of tags and fields stored in a measurement. -If you need to store more than 199 total tags and fields, consider segmenting +If you need to store more than 249 total tags and fields, consider segmenting your fields into a separate measurement. #### Avoid too many tags diff --git a/content/influxdb/v1/tools/grafana.md b/content/influxdb/v1/tools/grafana.md index 77f89ebfd..6b3bf8f34 100644 --- a/content/influxdb/v1/tools/grafana.md +++ b/content/influxdb/v1/tools/grafana.md @@ -17,25 +17,30 @@ to visualize data from your **InfluxDB v1.8** instance. {{% note %}} #### Required -- The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**. +- The instructions in this guide require **Grafana Cloud** or **Grafana v10.3+**. For information about using InfluxDB with other versions of Grafana, - see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/). + see the [Grafana documentation](https://grafana.com/docs/grafana/latest/datasources/influxdb/). - To use **Flux**, use **InfluxDB 1.8.1+** and [enable Flux](/influxdb/v1/flux/installation/) in your InfluxDB configuration file. {{% /note %}} -1. [Start InfluxDB](/influxdb/v1/introduction/get-started/). -2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or - [download and install Grafana](https://grafana.com/grafana/download). -3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, - [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit - `http://localhost:3000` in your browser. -4. In the left navigation of the Grafana UI, hover over the gear - icon to expand the **Configuration** section. Click **Data Sources**. -5. Click **Add data source**. -6. Select **InfluxDB** from the list of available data sources. -7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. -8. Under **Query Language**, select one of the following: +1. [Start InfluxDB](/influxdb/v1/introduction/get-started/). +2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or + [download and install Grafana](https://grafana.com/grafana/download). +3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, + [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit + in your browser. +4. In the left navigation of the Grafana UI, expand the **Connections** section + and click **Add new connection**. +5. Select **InfluxDB** from the list of available data sources and click + **Add data source**. +6. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. +7. In the **Query Language** drop-down menu, select one of the query languages + supported by InfluxDB {{< current-version >}} (InfluxQL or Flux): + + {{% note %}} +SQL is only supported in InfluxDB v3. + {{% /note %}} {{< tabs-wrapper >}} {{% tabs %}} @@ -53,9 +58,8 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se - **URL**: Your **InfluxDB URL**. ```sh - http://localhost:8086/ + http://localhost:8086 ``` - - **Access**: Server (default) 2. Under **InfluxDB Details**, enter the following: @@ -68,7 +72,7 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se 3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)** (default is 10s). - {{< img-hd src="/img/influxdb/2-0-tools-grafana-influxql.png" />}} + {{< img-hd src="/img/influxdb/v1-tools-grafana-influxql.png" />}} 4. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns the result of the test. @@ -84,14 +88,16 @@ configure your InfluxDB connection: 1. Ensure [Flux is enabled](/influxdb/v1/flux/installation/) in InfluxDB. -2. Under **Connection**, enter the following: +2. Under **HTTP**, enter the following: - **URL**: Your **InfluxDB URL**. ```sh - http://localhost:8086/ + http://localhost:8086 ``` +3. Under **InfluxDB Details**, enter the following: + - **Organization**: Provide an arbitrary value. - **Token**: If [InfluxDB authentication is enabled](/influxdb/v1/administration/authentication_and_authorization/), provide your InfluxDB username and password using the following syntax: @@ -120,7 +126,7 @@ configure your InfluxDB connection: - **Min time interval**: [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval). - {{< img-hd src="/img/influxdb/1-8-tools-grafana-flux.png" />}} + {{< img-hd src="/img/influxdb/v1-tools-grafana-flux.png" />}} 3. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns the result of the test. diff --git a/content/influxdb/v2/install/_index.md b/content/influxdb/v2/install/_index.md index 08d11852b..f880931c4 100644 --- a/content/influxdb/v2/install/_index.md +++ b/content/influxdb/v2/install/_index.md @@ -483,6 +483,8 @@ The following guide uses [Docker CLI commands](https://docs.docker.com/reference +{{% code-placeholders "ADMIN_(USERNAME|PASSWORD)|ORG_NAME|BUCKET_NAME" %}} + ```sh docker run \ --name influxdb2 \ @@ -490,13 +492,15 @@ The following guide uses [Docker CLI commands](https://docs.docker.com/reference --mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2 \ --mount type=volume,source=influxdb2-config,target=/etc/influxdb2 \ --env DOCKER_INFLUXDB_INIT_MODE=setup \ - --env DOCKER_INFLUXDB_INIT_USERNAME= \ - --env DOCKER_INFLUXDB_INIT_PASSWORD= \ - --env DOCKER_INFLUXDB_INIT_ORG= \ - --env DOCKER_INFLUXDB_INIT_BUCKET= \ + --env DOCKER_INFLUXDB_INIT_USERNAME=ADMIN_USERNAME \ + --env DOCKER_INFLUXDB_INIT_PASSWORD=ADMIN_PASSWORD \ + --env DOCKER_INFLUXDB_INIT_ORG=ORG_NAME \ + --env DOCKER_INFLUXDB_INIT_BUCKET=BUCKET_NAME \ influxdb:2 ``` +{{% /code-placeholders %}} + The command passes the following arguments: - `--publish 8086:8086`: Exposes the InfluxDB [UI](/influxdb/v2/get-started/#influxdb-user-interface-ui) and [HTTP API](/influxdb/v2/reference/api/) on the host's `8086` port. @@ -504,10 +508,11 @@ The following guide uses [Docker CLI commands](https://docs.docker.com/reference - `--mount type=volume,source=influxdb2-config,target=/etc/influxdb2`: Creates a volume named `influxdb2-config` mapped to the [InfluxDB configuration directory](/influxdb/v2/reference/internals/file-system-layout/?t=docker#file-system-layout) to make configurations available outside the container. - `-e DOCKER_INFLUXDB_INIT_MODE=setup`: Environment variable that invokes the automated setup of the initial organization, user, bucket, and token when creating the container. - `-e DOCKER_INFLUXDB_INIT_`: Environment variables for initial setup options--replace the following with your own values: - - ``: The username for the initial [user](/influxdb/v2/admin/users/)--an admin user with an API [Operator token](/influxdb/v2/admin/tokens/#operator-token). - - ``: The password for the initial [user](/influxdb/v2/admin/users/). - - ``: The name for the initial [organization](/influxdb/v2/admin/organizations/). - - ``: The name for the initial [bucket](/influxdb/v2/admin/buckets/). + + - {{% code-placeholder-key %}}`ADMIN_USERNAME`{{% /code-placeholder-key %}}: The username for the initial [user](/influxdb/v2/admin/users/)--an admin user with an API [Operator token](/influxdb/v2/admin/tokens/#operator-token). + - {{% code-placeholder-key %}}`ADMIN_PASSWORD`{{% /code-placeholder-key %}}: The password for the initial [user](/influxdb/v2/admin/users/). + - {{% code-placeholder-key %}}`ORG_NAME`{{% /code-placeholder-key %}}: The name for the initial [organization](/influxdb/v2/admin/organizations/). + - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}}: The name for the initial [bucket](/influxdb/v2/admin/buckets/). For more options, see the [`influxdb` Docker Hub image](https://hub.docker.com/_/influxdb) documentation. _If you don't specify InfluxDB initial setup options, you can [set up manually](#set-up-influxdb) later using the UI or CLI in a running container._ diff --git a/content/influxdb/v2/reference/internals/metrics.md b/content/influxdb/v2/reference/internals/metrics.md index 09b2d1c4b..34d98420f 100644 --- a/content/influxdb/v2/reference/internals/metrics.md +++ b/content/influxdb/v2/reference/internals/metrics.md @@ -24,7 +24,7 @@ The following descriptors precede each metric: #### Example -```sh +```text # HELP go_info Information about the Go environment. # TYPE go_info gauge go_info{version="go1.17"} 1 @@ -55,7 +55,7 @@ Total number of boltdb reads. #### Example -```sh +```text # HELP boltdb_reads_total Total number of boltdb reads # TYPE boltdb_reads_total counter boltdb_reads_total 75129 @@ -66,7 +66,7 @@ Total number of boltdb writes. #### Example -```sh +```text # HELP boltdb_writes_total Total number of boltdb writes # TYPE boltdb_writes_total counter boltdb_writes_total 201591 @@ -84,7 +84,7 @@ Summary of the pause duration of garbage collection cycles. #### Example -```sh +```text # HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles. # TYPE go_gc_duration_seconds summary go_gc_duration_seconds{quantile="0"} 5.1467e-05 @@ -97,7 +97,7 @@ Number of goroutines that currently exist. #### Example -```sh +```text # HELP go_goroutines Number of goroutines that currently exist. # TYPE go_goroutines gauge go_goroutines 1566 @@ -109,7 +109,7 @@ Information about the Go environment. #### Example -```sh +```text # HELP go_info Information about the Go environment. # TYPE go_info gauge go_info{version="go1.17"} 1 @@ -121,7 +121,7 @@ Number of bytes allocated and still in use. #### Example -```sh +```text # HELP go_memstats_alloc_bytes Number of bytes allocated and still in use. # TYPE go_memstats_alloc_bytes gauge go_memstats_alloc_bytes 2.27988488e+08 @@ -133,7 +133,7 @@ Total number of bytes allocated, even if freed. #### Example -```sh +```text # HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed. # TYPE go_memstats_alloc_bytes_total counter go_memstats_alloc_bytes_total 9.68016566648e+11 @@ -145,7 +145,7 @@ Number of bytes used by the profiling bucket hash table. #### Example -```sh +```text # HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table. # TYPE go_memstats_buck_hash_sys_bytes gauge go_memstats_buck_hash_sys_bytes 1.0067613e+07 @@ -157,7 +157,7 @@ Total number of frees. #### Example -```sh +```text # HELP go_memstats_frees_total Total number of frees. # TYPE go_memstats_frees_total counter go_memstats_frees_total 1.3774541795e+10 @@ -169,7 +169,7 @@ Fraction of this program's available CPU time used by the GC since the program s #### Example -```sh +```text # HELP go_memstats_gc_cpu_fraction The fraction of this program's available CPU time used by the GC since the program started. # TYPE go_memstats_gc_cpu_fraction gauge go_memstats_gc_cpu_fraction 0.011634918451016558 @@ -181,7 +181,7 @@ Number of bytes used for garbage collection system metadata. #### Example -```sh +```text # HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata. # TYPE go_memstats_gc_sys_bytes gauge go_memstats_gc_sys_bytes 4.63048016e+08 @@ -193,7 +193,7 @@ Number of heap bytes allocated and still in use. #### Example -```sh +```text # HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use. # TYPE go_memstats_heap_alloc_bytes gauge go_memstats_heap_alloc_bytes 2.27988488e+08 @@ -205,7 +205,7 @@ Number of heap bytes waiting to be used. #### Example -```sh +```text # HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used. # TYPE go_memstats_heap_idle_bytes gauge go_memstats_heap_idle_bytes 1.0918273024e+10 @@ -217,7 +217,7 @@ Number of heap bytes that are in use. #### Example -```sh +```text # HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use. # TYPE go_memstats_heap_inuse_bytes gauge go_memstats_heap_inuse_bytes 3.5975168e+08 @@ -231,7 +231,7 @@ well as unreachable objects that the garbage collector has not yet freed. #### Example -```sh +```text # HELP go_memstats_heap_objects Number of allocated objects. # TYPE go_memstats_heap_objects gauge go_memstats_heap_objects 2.404017e+06 @@ -243,7 +243,7 @@ Number of heap bytes released to the OS. #### Example -```sh +```text # HELP go_memstats_heap_released_bytes Number of heap bytes released to OS. # TYPE go_memstats_heap_released_bytes gauge go_memstats_heap_released_bytes 2.095038464e+09 @@ -255,7 +255,7 @@ Number of heap bytes obtained from the system. #### Example -```sh +```text # HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system. # TYPE go_memstats_heap_sys_bytes gauge go_memstats_heap_sys_bytes 1.1278024704e+10 @@ -267,7 +267,7 @@ Number of seconds since 1970 of the last garbage collection. #### Example -```sh +```text # HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection. # TYPE go_memstats_last_gc_time_seconds gauge go_memstats_last_gc_time_seconds 1.64217120199452e+09 @@ -279,7 +279,7 @@ Total number of pointer lookups. #### Example -```sh +```text # HELP go_memstats_lookups_total Total number of pointer lookups. # TYPE go_memstats_lookups_total counter go_memstats_lookups_total 0 @@ -291,7 +291,7 @@ Cumulative count of heap objects allocated. #### Example -```sh +```text # HELP go_memstats_mallocs_total Total number of mallocs. # TYPE go_memstats_mallocs_total counter go_memstats_mallocs_total 1.3776945812e+10 @@ -303,7 +303,7 @@ Number of bytes in use by mcache structures. #### Example -```sh +```text # HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures. # TYPE go_memstats_mcache_inuse_bytes gauge go_memstats_mcache_inuse_bytes 9600 @@ -315,7 +315,7 @@ Number of bytes used for mcache structures obtained from system. #### Example -```sh +```text # HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system. # TYPE go_memstats_mcache_sys_bytes gauge go_memstats_mcache_sys_bytes 16384 @@ -327,7 +327,7 @@ Number of bytes of allocated mspan structures. #### Example -```sh +```text # HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures. # TYPE go_memstats_mspan_inuse_bytes gauge go_memstats_mspan_inuse_bytes 4.199e+06 @@ -339,7 +339,7 @@ Bytes of memory obtained from the OS for mspan structures. #### Example -```sh +```text # HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system. # TYPE go_memstats_mspan_sys_bytes gauge go_memstats_mspan_sys_bytes 1.65609472e+08 @@ -351,7 +351,7 @@ Number of heap bytes when next garbage collection will take place. #### Example -```sh +```text # HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place. # TYPE go_memstats_next_gc_bytes gauge go_memstats_next_gc_bytes 4.45628016e+08 @@ -363,7 +363,7 @@ Number of bytes used for other system allocations. #### Example -```sh +```text # HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations. # TYPE go_memstats_other_sys_bytes gauge go_memstats_other_sys_bytes 8.1917722e+07 @@ -375,7 +375,7 @@ Number of bytes in use by the stack allocator. #### Example -```sh +```text # HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator. # TYPE go_memstats_stack_inuse_bytes gauge go_memstats_stack_inuse_bytes 8.84736e+06 @@ -387,7 +387,7 @@ Number of bytes obtained from system for stack allocator. #### Example -```sh +```text # HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator. # TYPE go_memstats_stack_sys_bytes gauge go_memstats_stack_sys_bytes 8.84736e+06 @@ -399,7 +399,7 @@ Number of bytes obtained from system. #### Example -```sh +```text # HELP go_memstats_sys_bytes Number of bytes obtained from system. # TYPE go_memstats_sys_bytes gauge go_memstats_sys_bytes 1.2007531271e+10 @@ -411,7 +411,7 @@ Number of OS threads created. #### Example -```sh +```text # HELP go_threads Number of OS threads created. # TYPE go_threads gauge go_threads 27 @@ -425,7 +425,7 @@ How long InfluxDB took to respond to the HTTP request. #### Example -```sh +```text # HELP http_api_request_duration_seconds Time taken to respond to HTTP request # TYPE http_api_request_duration_seconds histogram http_api_request_duration_seconds_bucket{handler="platform",method="DELETE",path="/api/v2/authorizations/:id",response_code="204",status="2XX",user_agent="Chrome",le="0.005"} 0 @@ -438,7 +438,7 @@ Number of HTTP requests received. #### Example -```sh +```text # HELP http_api_requests_total Number of http requests received # TYPE http_api_requests_total counter http_api_requests_total{handler="platform",method="DELETE",path="/api/v2/authorizations/:id",response_code="204",status="2XX",user_agent="Chrome"} 1 @@ -451,7 +451,7 @@ Count of bytes received. #### Example -```sh +```text # HELP http_query_request_bytes Count of bytes received # TYPE http_query_request_bytes counter http_query_request_bytes{endpoint="/api/v2/query",org_id="48c88459ee424a04",status="200"} 727 @@ -463,7 +463,7 @@ Total number of query requests. #### Example -```sh +```text # HELP http_query_request_count Total number of query requests # TYPE http_query_request_count counter http_query_request_count{endpoint="/api/v2/query",org_id="48c88459ee424a04",status="200"} 2 @@ -475,7 +475,7 @@ Count of bytes returned by the query endpoint. #### Example -```sh +```text # HELP http_query_response_bytes Count of bytes returned # TYPE http_query_response_bytes counter http_query_response_bytes{endpoint="/api/v2/query",org_id="48c88459ee424a04",status="200"} 103 @@ -489,7 +489,7 @@ Total number of buckets on the server. #### Example -```sh +```text # HELP influxdb_buckets_total Number of total buckets on the server # TYPE influxdb_buckets_total counter influxdb_buckets_total 9 @@ -501,7 +501,7 @@ Total number of dashboards on the server. #### Example -```sh +```text # HELP influxdb_dashboards_total Number of total dashboards on the server # TYPE influxdb_dashboards_total counter influxdb_dashboards_total 2 @@ -513,7 +513,7 @@ Information about the InfluxDB environment. #### Example -```sh +```text # HELP influxdb_info Information about the influxdb environment. # TYPE influxdb_info gauge influxdb_info{arch="amd64",build_date="2021-12-28T22:12:40Z",commit="657e1839de",cpus="8",os="darwin",version="v2.1.1"} 1 @@ -525,19 +525,31 @@ Total number of organizations on the server. #### Example -```sh +```text # HELP influxdb_organizations_total Number of total organizations on the server # TYPE influxdb_organizations_total counter influxdb_organizations_total 2 ``` +### Replications total + +Total number of replication configurations on the server + +#### Example + +```text +# HELP influxdb_replications_total Number of total replication configurations on the server +# TYPE influxdb_replications_total counter +influxdb_replications_total 1 +``` + ### Scrapers total Total number of scrapers on the server. #### Example -```sh +```text # HELP influxdb_scrapers_total Number of total scrapers on the server # TYPE influxdb_scrapers_total counter influxdb_scrapers_total 0 @@ -549,7 +561,7 @@ Total number of Telegraf configurations on the server. #### Example -```sh +```text # HELP influxdb_telegrafs_total Number of total telegraf configurations on the server # TYPE influxdb_telegrafs_total counter influxdb_telegrafs_total 0 @@ -561,7 +573,7 @@ Total number of API tokens on the server. #### Example -```sh +```text # HELP influxdb_tokens_total Number of total tokens on the server # TYPE influxdb_tokens_total counter influxdb_tokens_total 23 @@ -573,7 +585,7 @@ InfluxDB process uptime in seconds. #### Example -```sh +```text # HELP influxdb_uptime_seconds influxdb process uptime in seconds # TYPE influxdb_uptime_seconds gauge influxdb_uptime_seconds{id="077238f9ca108000"} 343354.914499305 @@ -585,7 +597,7 @@ Total number of users on the server. #### Example -```sh +```text # HELP influxdb_users_total Number of total users on the server # TYPE influxdb_users_total counter influxdb_users_total 84 @@ -599,7 +611,7 @@ Number of queries in all states. #### Example -```sh +```text # HELP qc_all_active Number of queries in all states # TYPE qc_all_active gauge qc_all_active{org="48c88459ee424a04"} 0 @@ -612,7 +624,7 @@ Total time spent in all query states. #### Example -```sh +```text # HELP qc_all_duration_seconds Histogram of total times spent in all query states # TYPE qc_all_duration_seconds histogram qc_all_duration_seconds_bucket{org="48c88459ee424a04",le="0.001"} 0 @@ -625,7 +637,7 @@ Number of queries actively compiling. #### Example -```sh +```text # HELP qc_compiling_active Number of queries actively compiling # TYPE qc_compiling_active gauge qc_compiling_active{compiler_type="ast",org="ed32b47572a0137b"} 0 @@ -638,7 +650,7 @@ Histogram of times spent compiling queries. #### Example -```sh +```text # HELP qc_compiling_duration_seconds Histogram of times spent compiling queries # TYPE qc_compiling_duration_seconds histogram qc_compiling_duration_seconds_bucket{compiler_type="ast",org="ed32b47572a0137b",le="0.001"} 999 @@ -651,7 +663,7 @@ Number of queries actively executing. #### Example -```sh +```text # HELP qc_executing_active Number of queries actively executing # TYPE qc_executing_active gauge qc_executing_active{org="48c88459ee424a04"} 0 @@ -664,7 +676,7 @@ Histogram of times spent executing queries. #### Example -```sh +```text # HELP qc_executing_duration_seconds Histogram of times spent executing queries # TYPE qc_executing_duration_seconds histogram qc_executing_duration_seconds_bucket{org="48c88459ee424a04",le="0.001"} 0 @@ -677,7 +689,7 @@ Free memory as seen by the internal memory manager. #### Example -```sh +```text # HELP qc_memory_unused_bytes The free memory as seen by the internal memory manager # TYPE qc_memory_unused_bytes gauge qc_memory_unused_bytes{org="48c88459ee424a04"} 0 @@ -690,7 +702,7 @@ Number of queries actively queueing. #### Example -```sh +```text # HELP qc_queueing_active Number of queries actively queueing # TYPE qc_queueing_active gauge qc_queueing_active{org="48c88459ee424a04"} 0 @@ -703,7 +715,7 @@ Histogram of times spent queueing queries. #### Example -```sh +```text # HELP qc_queueing_duration_seconds Histogram of times spent queueing queries # TYPE qc_queueing_duration_seconds histogram qc_queueing_duration_seconds_bucket{org="48c88459ee424a04",le="0.001"} 2 @@ -716,7 +728,7 @@ Count of the query requests. #### Example -```sh +```text # HELP qc_requests_total Count of the query requests # TYPE qc_requests_total counter qc_requests_total{org="48c88459ee424a04",result="success"} 2 @@ -729,7 +741,7 @@ Histogram of times spent in read requests. #### Example -```sh +```text # HELP query_influxdb_source_read_request_duration_seconds Histogram of times spent in read requests # TYPE query_influxdb_source_read_request_duration_seconds histogram query_influxdb_source_read_request_duration_seconds_bucket{op="readTagKeys",org="48c88459ee424a04",le="0.001"} 0 @@ -744,7 +756,7 @@ Number of calls to the bucket creation service. #### Example -```sh +```text # HELP service_bucket_new_call_total Number of calls # TYPE service_bucket_new_call_total counter service_bucket_new_call_total{method="find_bucket"} 6177 @@ -757,7 +769,7 @@ Duration of calls to the bucket creation service. #### Example -```sh +```text # HELP service_bucket_new_duration Duration of calls # TYPE service_bucket_new_duration histogram service_bucket_new_duration_bucket{method="find_bucket",le="0.005"} 5876 @@ -770,7 +782,7 @@ Number of errors encountered by the bucket creation service. #### Example -```sh +```text # HELP service_bucket_new_error_total Number of errors encountered # TYPE service_bucket_new_error_total counter service_bucket_new_error_total{code="not found",method="find_bucket_by_id"} 76 @@ -782,7 +794,7 @@ Number of calls to the onboarding service. #### Example -```sh +```text # HELP service_onboard_new_call_total Number of calls # TYPE service_onboard_new_call_total counter service_onboard_new_call_total{method="is_onboarding"} 11 @@ -794,7 +806,7 @@ Duration of calls to the onboarding service. #### Example -```sh +```text # HELP service_onboard_new_duration Duration of calls # TYPE service_onboard_new_duration histogram service_onboard_new_duration_bucket{method="is_onboarding",le="0.005"} 11 @@ -807,7 +819,7 @@ Number of calls to the organization service. #### Example -```sh +```text # HELP service_org_call_total Number of calls # TYPE service_org_call_total counter service_org_call_total{method="find_labels_for_resource"} 10 @@ -819,7 +831,7 @@ Duration of calls to the organization service. #### Example -```sh +```text # HELP service_org_duration Duration of calls # TYPE service_org_duration histogram service_org_duration_bucket{method="find_labels_for_resource",le="0.005"} 10 @@ -832,7 +844,7 @@ Number of calls to the organization creation service. #### Example -```sh +```text # HELP service_org_new_call_total Number of calls # TYPE service_org_new_call_total counter service_org_new_call_total{method="find_org"} 1572 @@ -845,7 +857,7 @@ Duration of calls to the organization creation service. #### Example -```sh +```text # HELP service_org_new_duration Duration of calls # TYPE service_org_new_duration histogram service_org_new_duration_bucket{method="find_org",le="0.005"} 1475 @@ -858,7 +870,7 @@ Number of errors encountered by the organization creation service. #### Example -```sh +```text # HELP service_org_new_error_total Number of errors encountered # TYPE service_org_new_error_total counter service_org_new_error_total{code="not found",method="find_orgs"} 1 @@ -870,7 +882,7 @@ Number of calls to the password creation service. #### Example -```sh +```text # HELP service_password_new_call_total Number of calls # TYPE service_password_new_call_total counter service_password_new_call_total{method="compare_password"} 4 @@ -882,7 +894,7 @@ Duration of calls to the password creation service. #### Example -```sh +```text # HELP service_password_new_duration Duration of calls # TYPE service_password_new_duration histogram service_password_new_duration_bucket{method="compare_password",le="0.005"} 0 @@ -895,7 +907,7 @@ Number of errors encountered by the password creation service. #### Example -```sh +```text # HELP service_password_new_error_total Number of errors encountered # TYPE service_password_new_error_total counter service_password_new_error_total{code="forbidden",method="compare_password"} 1 @@ -907,7 +919,7 @@ Number of calls to the `pkger` service. #### Example -```sh +```text # HELP service_pkger_call_total Number of calls # TYPE service_pkger_call_total counter service_pkger_call_total{method="export"} 3 @@ -919,7 +931,7 @@ Duration of calls to the `pkger` service. #### Example -```sh +```text # HELP service_pkger_duration Duration of calls # TYPE service_pkger_duration histogram service_pkger_duration_bucket{method="export",le="0.005"} 0 @@ -932,19 +944,140 @@ Metrics for exported resources. #### Example -```sh +```text # HELP service_pkger_template_export Metrics for resources being exported # TYPE service_pkger_template_export counter service_pkger_template_export{buckets="0",by_stack="false",checks="0",dashboards="0",endpoints="0",label_mappings="0",labels="0",method="export",num_org_ids="1",rules="0",tasks="0",telegraf_configs="0",variables="0"} 3 ``` +### Replication service call total + +Number of calls to the replication service. + +#### Example + +```text +# HELP service_replication_call_total Number of calls +# TYPE service_replication_call_total counter +service_replication_call_total{method="find_replications"} 1 +``` + +### Replication service call duration + +Duration of calls to the replication service. + +#### Example + +```text +# HELP service_replication_duration Duration of calls +# TYPE service_replication_duration histogram +service_replication_duration_bucket{method="create_replication",le="0.005"} 0 +service_replication_duration_bucket{method="find_replications",le="0.005"} 1 +``` + +### Replication queue total points queued + +Sum of all points that have been successfully added to the replication stream queue. + +#### Example + +```text +# HELP replications_queue_total_points_queued Sum of all points +# TYPE replications_queue_total_points_queued Counter +replications_queue_total_points_queued +``` + +### Replications queue total bytes queued + +Sum of all bytes that have been successfully added to the replication stream queue. + +#### Example + +```text +# HELP replications_queue_total_bytes_queued Sum of all bytes that have been successfully added to the replication stream queue +# TYPE replications_queue_total_bytes_queued counter +replications_queue_total_bytes_queued{replicationID="0cd2cd54e9fe9000"} 289 +``` + +### Replications queue current bytes queued + +Current number of bytes in the replication stream queue remaining to be processed. + +#### Example + +```text +# HELP replications_queue_current_bytes_queued Current number of bytes in the replication stream queue remaining to be processed +# TYPE replications_queue_current_bytes_queued gauge +replications_queue_current_bytes_queued{replicationID="0cd2cd54e9fe9000"} 297 +``` + +### Replications queue remote write errors + +Error codes returned from attempted remote writes. + +#### Example + +```text +# HELP replications_queue_remote_write_errors Error codes returned from attempted remote writes +# TYPE replications_queue_remote_write_errors counter +replications_queue_remote_write_errors{code="404",replicationID="0cd2cd54e9fe9000"} 11 +``` + +### Replications queue remote write bytes sent + +Bytes of data successfully sent to the remote by the replication stream. + +#### Example + +```text +# HELP replications_queue_remote_write_bytes_sent Bytes of data successfully sent to the remote by the replication stream +# TYPE replications_queue_remote_write_bytes_sent counter +replications_queue_remote_write_bytes_sent{...} +``` + +### Replications queue + +Bytes of data dropped due to remote write failures. + +#### Example + +```text +# HELP replications_queue_remote_write_bytes_dropped Bytes of data dropped due to remote write failures +# TYPE replications_queue_remote_write_bytes_dropped counter +replications_queue_remote_write_bytes_dropped{...} +``` + +### Replications queue + +Sum of all points that could not be added to the local replication queue. + +#### Example + +```text +# HELP replications_queue_points_failed_to_queue +# TYPE replications_queue_points_failed_to_queue +replications_queue_points_failed_to_queue{...} +``` + +### Replications queue + +Sum of all bytes that could not be added to the local replication queue. + +#### Example + +```text +# HELP replications_queue_bytes_failed_to_queue Sum of all bytes that could not be added to the local replication queue +# TYPE replications_queue_bytes_failed_to_queue counter +replications_queue_bytes_failed_to_queue{...} +``` + ### Session service call total Number of calls to the session service. #### Example -```sh +```text # HELP service_session_call_total Number of calls # TYPE service_session_call_total counter service_session_call_total{method="create_session"} 3 @@ -957,7 +1090,7 @@ Duration of calls to the session service. #### Example -```sh +```text # HELP service_session_duration Duration of calls # TYPE service_session_duration histogram service_session_duration_bucket{method="create_session",le="0.005"} 3 @@ -970,7 +1103,7 @@ Number of errors encountered by the session service. #### Example -```sh +```text # HELP service_session_error_total Number of errors encountered # TYPE service_session_error_total counter service_session_error_total{code="not found",method="find_session"} 4 @@ -982,7 +1115,7 @@ Number of calls to the token service. #### Example -```sh +```text # HELP service_token_call_total Number of calls # TYPE service_token_call_total counter service_token_call_total{method="delete_authorization"} 3 @@ -995,7 +1128,7 @@ Duration of calls to the token service. #### Example -```sh +```text # HELP service_token_duration Duration of calls # TYPE service_token_duration histogram service_token_duration_bucket{method="delete_authorization",le="0.005"} 1 @@ -1008,7 +1141,7 @@ Number of errors encountered by the token service. #### Example -```sh +```text # HELP service_token_error_total Number of errors encountered # TYPE service_token_error_total counter service_token_error_total{code="not found",method="delete_authorization"} 1 @@ -1019,7 +1152,7 @@ Number of calls to the URM (unified resource management) creation service. #### Example -```sh +```text # HELP service_urm_new_call_total Number of calls # TYPE service_urm_new_call_total counter service_urm_new_call_total{method="find_urms"} 6451 @@ -1030,7 +1163,7 @@ Duration of calls to the URM creation service. #### Example -```sh +```text # HELP service_urm_new_duration Duration of calls # TYPE service_urm_new_duration histogram service_urm_new_duration_bucket{method="find_urms",le="0.005"} 6198 @@ -1042,7 +1175,7 @@ Number of calls to the user creation service. #### Example -```sh +```text # HELP service_user_new_call_total Number of calls # TYPE service_user_new_call_total counter service_user_new_call_total{method="find_permission_for_user"} 4806 @@ -1054,7 +1187,7 @@ Duration of calls to the user creation service. #### Example -```sh +```text # HELP service_user_new_duration Duration of calls # TYPE service_user_new_duration histogram service_user_new_duration_bucket{method="find_permission_for_user",le="0.005"} 4039 @@ -1071,7 +1204,7 @@ Number of measurements in a bucket. #### Example -```sh +```text # HELP storage_bucket_measurement_num Gauge of measurement cardinality per bucket # TYPE storage_bucket_measurement_num gauge storage_bucket_measurement_num{bucket="0c3dd7d2d97f4b23"} 4 @@ -1084,7 +1217,7 @@ Number of series in a bucket. #### Example -```sh +```text # HELP storage_bucket_series_num Gauge of series cardinality per bucket # TYPE storage_bucket_series_num gauge storage_bucket_series_num{bucket="0c3dd7d2d97f4b23"} 38 @@ -1097,7 +1230,7 @@ Size (in bytes) of the most recent [snapshot](/influxdb/v2/reference/internals/s #### Example -```sh +```text # HELP storage_cache_disk_bytes Gauge of size of most recent snapshot # TYPE storage_cache_disk_bytes gauge storage_cache_disk_bytes{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1110,7 +1243,7 @@ Current memory consumption (in bytes) of the [cache](/influxdb/v2/reference/inte #### Example -```sh +```text # HELP storage_cache_inuse_bytes Gauge of current memory consumption of cache # TYPE storage_cache_inuse_bytes gauge storage_cache_inuse_bytes{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1123,7 +1256,7 @@ storage_cache_inuse_bytes{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path= #### Example -```sh +```text # HELP storage_cache_latest_snapshot Unix time of most recent snapshot # TYPE storage_cache_latest_snapshot gauge storage_cache_latest_snapshot{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 1.644269658196893e+09 @@ -1136,7 +1269,7 @@ Cumulative number of [cached](/influxdb/v2/reference/internals/storage-engine/#c #### Example -```sh +```text # HELP storage_cache_writes_dropped Counter of writes to cache with some dropped points # TYPE storage_cache_writes_dropped counter storage_cache_writes_dropped{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1149,7 +1282,7 @@ Cumulative number of [cached](/influxdb/v2/reference/internals/storage-engine/# #### Example -```sh +```text # HELP storage_cache_writes_err Counter of failed writes to cache # TYPE storage_cache_writes_err counter storage_cache_writes_err{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1162,7 +1295,7 @@ Cumulative number of writes to [cache](/influxdb/v2/reference/internals/storage #### Example -```sh +```text # HELP storage_cache_writes_total Counter of all writes to cache # TYPE storage_cache_writes_total counter storage_cache_writes_total{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1175,7 +1308,7 @@ Currently running [TSM](/influxdb/v2/reference/internals/storage-engine/#time-st #### Example -```sh +```text # HELP storage_compactions_active Gauge of compactions (by level) currently running # TYPE storage_compactions_active gauge storage_compactions_active{bucket="ec3f82d1de90eddf",engine="tsm1",id="565",level="1",path="/Users/me/.influxdbv2/engine/data/ec3f82d1de90eddf/autogen/565",walPath="/Users/me/.influxdbv2/engine/wal/ec3f82d1de90eddf/autogen/565"} 0 @@ -1188,7 +1321,7 @@ storage_compactions_active{bucket="ec3f82d1de90eddf",engine="tsm1",id="565",leve #### Example -```sh +```text # HELP storage_compactions_duration_seconds Histogram of compactions by level since startup # TYPE storage_compactions_duration_seconds histogram storage_compactions_duration_seconds_bucket{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="567",level="cache",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/567",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/567",le="60"} 1 @@ -1206,7 +1339,7 @@ Failed [TSM](/influxdb/v2/reference/internals/storage-engine/#time-structured-me #### Example -```sh +```text # HELP storage_compactions_failed Counter of TSM compactions (by level) that have failed due to error # TYPE storage_compactions_failed counter storage_compactions_failed{bucket="ec3f82d1de90eddf",engine="tsm1",id="565",level="1",path="/Users/me/.influxdbv2/engine/data/ec3f82d1de90eddf/autogen/565",walPath="/Users/me/.influxdbv2/engine/wal/ec3f82d1de90eddf/autogen/565"} 0 @@ -1219,7 +1352,7 @@ Queued [TSM](/influxdb/v2/reference/internals/storage-engine/#time-structured-me #### Example -```sh +```text # HELP storage_compactions_queued Counter of TSM compactions (by level) that are currently queued # TYPE storage_compactions_queued gauge storage_compactions_queued{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="567",level="1",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/567",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/567"} 0 @@ -1232,7 +1365,7 @@ Retention policy check duration (in seconds). #### Example -```sh +```text # HELP storage_retention_check_duration Histogram of duration of retention check (in seconds) # TYPE storage_retention_check_duration histogram storage_retention_check_duration_bucket{le="0.005"} 1 @@ -1258,7 +1391,7 @@ Disk size (in bytes) of the [shard](/influxdb/v2/reference/internals/shards/). #### Example -```sh +```text # HELP storage_shard_disk_size Gauge of the disk size for the shard # TYPE storage_shard_disk_size gauge storage_shard_disk_size{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 4.188743e+06 @@ -1271,7 +1404,7 @@ Number of [shard](/influxdb/v2/reference/internals/shards/) fields created. #### Example -```sh +```text # HELP storage_shard_fields_created Counter of the number of fields created # TYPE storage_shard_fields_created counter storage_shard_fields_created{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1284,7 +1417,7 @@ Number of series in the [shard](/influxdb/v2/reference/internals/shards/) index. #### Example -```sh +```text # HELP storage_shard_series Gauge of the number of series in the shard index # TYPE storage_shard_series gauge storage_shard_series{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 38 @@ -1297,7 +1430,7 @@ Number of [shard write](/influxdb/v2/reference/internals/shards/#shard-writes) r #### Example -```sh +```text # HELP storage_shard_write_count Count of the number of write requests # TYPE storage_shard_write_count counter storage_shard_write_count{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1310,7 +1443,7 @@ Number of [rejected points](/influxdb/v2/reference/glossary/#rejected-point) in #### Example -```sh +```text # HELP storage_shard_write_dropped_sum Counter of the number of points dropped # TYPE storage_shard_write_dropped_sum counter storage_shard_write_dropped_sum{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1323,7 +1456,7 @@ Number of [shard write](/influxdb/v2/reference/internals/shards/#shard-writes) r #### Example -```sh +```text # HELP storage_shard_write_err_count Count of the number of write requests with errors # TYPE storage_shard_write_err_count counter storage_shard_write_err_count{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1336,7 +1469,7 @@ Number of points in [shard write](/influxdb/v2/reference/internals/shards/#shard #### Example -```sh +```text # HELP storage_shard_write_err_sum Counter of the number of points for write requests with errors # TYPE storage_shard_write_err_sum counter storage_shard_write_err_sum{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1349,7 +1482,7 @@ Number of points in [shard write](/influxdb/v2/reference/internals/shards/#shard #### Example -```sh +```text # HELP storage_shard_write_sum Counter of the number of points for write requests # TYPE storage_shard_write_sum counter storage_shard_write_sum{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1362,7 +1495,7 @@ Gauge of the data size (in bytes) for each [shard](/influxdb/v2/reference/intern #### Example -```sh +```text # HELP storage_tsm_files_disk_bytes Gauge of data size in bytes for each shard # TYPE storage_tsm_files_disk_bytes gauge storage_tsm_files_disk_bytes{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 4.188743e+06 @@ -1375,7 +1508,7 @@ Number of files per [shard](/influxdb/v2/reference/internals/shards/). #### Example -```sh +```text # HELP storage_tsm_files_total Gauge of number of files per shard # TYPE storage_tsm_files_total gauge storage_tsm_files_total{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 1 @@ -1388,7 +1521,7 @@ storage_tsm_files_total{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/ #### Example -```sh +```text # HELP storage_wal_size Gauge of size of WAL in bytes # TYPE storage_wal_size gauge storage_wal_size{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1401,7 +1534,7 @@ Cumulative number of write attempts to the [WAL](/influxdb/v2/reference/internal #### Example -```sh +```text # HELP storage_wal_writes Number of write attempts to the WAL # TYPE storage_wal_writes counter storage_wal_writes{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1414,7 +1547,7 @@ Cumulative number of failed write attempts to the [WAL](/influxdb/v2/reference/i #### Example -```sh +```text # HELP storage_wal_writes_err Number of failed write attempts to the WAL # TYPE storage_wal_writes_err counter storage_wal_writes_err{bucket="0c3dd7d2d97f4b23",engine="tsm1",id="561",path="/Users/me/.influxdbv2/engine/data/0c3dd7d2d97f4b23/autogen/561",walPath="/Users/me/.influxdbv2/engine/wal/0c3dd7d2d97f4b23/autogen/561"} 0 @@ -1427,7 +1560,7 @@ Number of points dropped due to partial writes. #### Example -```sh +```text # HELP storage_writer_dropped_points Histogram of number of points dropped due to partial writes # TYPE storage_writer_dropped_points histogram storage_writer_dropped_points_bucket{path="/Users/me/.influxdbv2/engine",le="10"} 0 @@ -1447,7 +1580,7 @@ Number of points in [shard write](/influxdb/v2/reference/internals/shards/#shard #### Example -```sh +```text # HELP storage_writer_err_points Histogram of number of points in errored shard write requests # TYPE storage_writer_err_points histogram storage_writer_err_points_bucket{path="/Users/me/.influxdbv2/engine",le="10"} 0 @@ -1467,7 +1600,7 @@ Number of points in successful [shard write](/influxdb/v2/reference/internals/sh #### Example -```sh +```text # HELP storage_writer_ok_points Histogram of number of points in successful shard write requests # TYPE storage_writer_ok_points histogram storage_writer_ok_points_bucket{path="/Users/me/.influxdbv2/engine",le="10"} 6 @@ -1487,7 +1620,7 @@ Number of points in write requests. #### Example -```sh +```text # HELP storage_writer_req_points Histogram of number of points requested to be written # TYPE storage_writer_req_points histogram storage_writer_req_points_bucket{path="/Users/me/.influxdbv2/engine",le="10"} 6 @@ -1507,7 +1640,7 @@ Cumulative number of [shard write](/influxdb/v2/reference/internals/shards/#shar #### Example -```sh +```text # HELP storage_writer_timeouts Number of shard write request timeouts # TYPE storage_writer_timeouts counter storage_writer_timeouts{path="/Users/me/.influxdbv2/engine"} 0 @@ -1522,7 +1655,7 @@ Number of errors thrown by the executor with the type of error (ex. Invalid, Int #### Example -```sh +```text # HELP task_executor_errors_counter The number of errors thrown by the executor with the type of error (ex. Invalid, Internal, etc.) # TYPE task_executor_errors_counter counter task_executor_errors_counter{errorType="internal error",task_type="system"} 1183 @@ -1535,7 +1668,7 @@ Percent of the promise queue that is currently full. #### Example -```sh +```text # HELP task_executor_promise_queue_usage Percent of the promise queue that is currently full # TYPE task_executor_promise_queue_usage gauge task_executor_promise_queue_usage 0 @@ -1547,7 +1680,7 @@ Duration (in seconds) between a task run starting and finishing. #### Example -```sh +```text # HELP task_executor_run_duration The duration in seconds between a run starting and finishing. # TYPE task_executor_run_duration summary @@ -1565,7 +1698,7 @@ Latency between the task run's scheduled start time and the execution time, by t #### Example -```sh +```text # HELP task_executor_run_latency_seconds Records the latency between the time the run was due to run and the time the task started execution, by task type # TYPE task_executor_run_latency_seconds histogram task_executor_run_latency_seconds_bucket{task_type="system",le="0.005"} 0 @@ -1591,7 +1724,7 @@ Duration (in seconds) between the task run's scheduled start time and the execut #### Example -```sh +```text # HELP task_executor_run_queue_delta The duration in seconds between a run being due to start and actually starting. # TYPE task_executor_run_queue_delta summary task_executor_run_queue_delta{taskID="08017725990f6000",task_type="",quantile="0.5"} 0.324742 @@ -1608,7 +1741,7 @@ Number of workers currently running tasks. #### Example -```sh +```text # HELP task_executor_total_runs_active Total number of workers currently running tasks # TYPE task_executor_total_runs_active gauge task_executor_total_runs_active 0 @@ -1620,7 +1753,7 @@ Number of task runs completed across all tasks, split out by success or failure. #### Example -```sh +```text # HELP task_executor_total_runs_complete Total number of runs completed across all tasks, split out by success or failure. # TYPE task_executor_total_runs_complete counter task_executor_total_runs_complete{status="failed",task_type="system"} 1384 @@ -1634,7 +1767,7 @@ Percent of total available workers that are currently busy. #### Example -```sh +```text # HELP task_executor_workers_busy Percent of total available workers that are currently busy # TYPE task_executor_workers_busy gauge task_executor_workers_busy 0 @@ -1646,7 +1779,7 @@ Number of tasks currently being executed. #### Example -```sh +```text # HELP task_scheduler_current_execution Number of tasks currently being executed # TYPE task_scheduler_current_execution gauge task_scheduler_current_execution 128 @@ -1658,7 +1791,7 @@ Duration (in seconds) between a task run starting and finishing. #### Example -```sh +```text # HELP task_scheduler_execute_delta The duration in seconds between a run starting and finishing. # TYPE task_scheduler_execute_delta summary task_scheduler_execute_delta{quantile="0.5"} NaN @@ -1671,7 +1804,7 @@ Summary of the delay between when a task is scheduled to run and when it is told #### Example -```sh +```text # HELP task_scheduler_schedule_delay The duration between when a Item should be scheduled and when it is told to execute. # TYPE task_scheduler_schedule_delay summary task_scheduler_schedule_delay{quantile="0.5"} 120.001036 @@ -1688,7 +1821,7 @@ Number of times a scheduled task execution has failed. #### Example -```sh +```text # HELP task_scheduler_total_execute_failure Total number of times an execution has failed. # TYPE task_scheduler_total_execute_failure counter task_scheduler_total_execute_failure 0 @@ -1700,7 +1833,7 @@ Number of scheduled executions across all tasks. #### Example -```sh +```text # HELP task_scheduler_total_execution_calls Total number of executions across all tasks. # TYPE task_scheduler_total_execution_calls counter task_scheduler_total_execution_calls 4806 @@ -1712,7 +1845,7 @@ Number of release requests. #### Example -```sh +```text # HELP task_scheduler_total_release_calls Total number of release requests. # TYPE task_scheduler_total_release_calls counter task_scheduler_total_release_calls 0 @@ -1724,7 +1857,7 @@ Number of schedule requests. #### Example -```sh +```text # HELP task_scheduler_total_schedule_calls Total number of schedule requests. # TYPE task_scheduler_total_schedule_calls counter task_scheduler_total_schedule_calls 6 @@ -1736,7 +1869,7 @@ Number of schedule requests that fail to schedule. #### Example -```sh +```text # HELP task_scheduler_total_schedule_fails Total number of schedule requests that fail to schedule. # TYPE task_scheduler_total_schedule_fails counter task_scheduler_total_schedule_fails 0 diff --git a/content/influxdb/v2/tools/grafana.md b/content/influxdb/v2/tools/grafana.md index b0edc9a68..35693e6f8 100644 --- a/content/influxdb/v2/tools/grafana.md +++ b/content/influxdb/v2/tools/grafana.md @@ -19,22 +19,27 @@ Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/produ to visualize data from your **InfluxDB {{< current-version >}}** instance. {{% note %}} -The instructions in this guide require **Grafana Cloud** or **Grafana v8.0+**. +The instructions in this guide require **Grafana Cloud** or **Grafana 10.3+**. {{% /note %}} -1. {{% cloud-only %}}[Log into InfluxDB Cloud](https://cloud2.influxdata.com).{{% /cloud-only %}} -1. {{% oss-only %}}[Start InfluxDB](/influxdb/v2/install/#configure-and-start-influxdb).{{% /oss-only %}} -2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or - [download and install Grafana](https://grafana.com/grafana/download). -3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, - [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit - `http://localhost:3000` in your browser. -4. In the left navigation of the Grafana UI, hover over the gear - icon to expand the **Configuration** section. Click **Data Sources**. -5. Click **Add data source**. -6. Select **InfluxDB** from the list of available data sources. -7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. -8. Under **Query Language**, select one of the following: +1. {{% cloud-only %}}[Log into InfluxDB Cloud](https://cloud2.influxdata.com).{{% /cloud-only %}} +1. {{% oss-only %}}[Start InfluxDB](/influxdb/v2/install/#configure-and-start-influxdb).{{% /oss-only %}} +2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or + [download and install Grafana](https://grafana.com/grafana/download). +3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, + [start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit + in your browser. +4. In the left navigation of the Grafana UI, open the **Connections** section + and select **Add new connection**. +5. Select **InfluxDB** from the list of available data sources and click + **Add new data source**. +6. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source. +7. In the **Query Language** drop-down menu, select one of the query languages + supported by InfluxDB {{< current-version >}} (Flux or InfluxQL): + + {{% note %}} +SQL is only supported in InfluxDB v3. + {{% /note %}} {{< tabs-wrapper >}} {{% tabs %}} @@ -56,14 +61,13 @@ configure your InfluxDB connection: ```sh http://localhost:8086/ ``` - - - **Access**: Server (default) 2. Under **InfluxDB Details**, enter the following: - **Organization**: Your InfluxDB [organization name **or** ID](/influxdb/v2/admin/organizations/view-orgs/). - **Token**: Your InfluxDB [API token](/influxdb/v2/admin/tokens/). - - **Default Bucket**: The default [bucket](/influxdb/v2/admin/buckets/) to use in Flux queries. + - **Default Bucket**: The default [bucket](/influxdb/v2/admin/buckets/) to + use in Flux queries. - **Min time interval**: The [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval). Default is `10s` - **Max series**: The maximum number of series or tables Grafana will process. @@ -73,11 +77,11 @@ configure your InfluxDB connection: datasource and returns the results of the test. {{% cloud-only %}} - {{< img-hd src="/img/influxdb/cloud-tools-grafana.png" alt="Use Grafana with InfluxDB Cloud and Flux" />}} + {{< img-hd src="/img/influxdb/cloud-tools-grafana-flux.png" alt="Use Grafana with InfluxDB Cloud and Flux" />}} {{% /cloud-only %}} {{% oss-only %}} - {{< img-hd src="/img/influxdb/2-2-tools-grafana.png" alt="Use Grafana with InfluxDB and Flux" />}} + {{< img-hd src="/img/influxdb/v2-tools-grafana-flux.png" alt="Use Grafana with InfluxDB and Flux" />}} {{% /oss-only %}} {{% /tab-content %}} @@ -100,12 +104,14 @@ and then complete the instructions to configure Grafana: - [Manually migrated from InfluxDB 1.x to {{< current-version >}}](#manually-migrated-from-influxdb-1x-to-2x) ### Installed a new InfluxDB instance + To configure Grafana to use InfluxQL with a new install of InfluxDB {{< current-version >}}, do the following: 1. [Authenticate with InfluxDB {{< current-version >}} tokens](/influxdb/v2/admin/tokens/). 2. [Manually create DBRP mappings](#view-and-create-influxdb-dbrp-mappings). ### Upgraded from InfluxDB 1.x to 2.x + To configure Grafana to use InfluxQL when you've upgraded from InfluxDB 1.x to InfluxDB {{< current-version >}} (following an [official upgrade guide](/influxdb/v2/upgrade/v1-to-v2/)): @@ -114,6 +120,7 @@ InfluxDB {{< current-version >}} (following an [official upgrade guide](/influxd 2. Use the DBRP mappings InfluxDB automatically created in the upgrade process (no action necessary). ### Manually migrated from InfluxDB 1.x to 2.x + To configure Grafana to use InfluxQL when you've manually migrated from InfluxDB 1.x to InfluxDB {{< current-version >}}, do the following: @@ -131,6 +138,7 @@ authenticate with a username and password like InfluxDB 1.x _(separate from the credentials used to log into the InfluxDB user interface)_. #### View existing v1 authorizations + Use the [`influx v1 auth list`](/influxdb/v2/reference/cli/influx/v1/auth/list/) to list existing InfluxDB v1 compatible authorizations. @@ -139,6 +147,7 @@ influx v1 auth list ``` #### Create a v1 authorization + Use the [`influx v1 auth create` command](/influxdb/v2/reference/cli/influx/v1/auth/create/) to grant read/write permissions to specific buckets. Provide the following: @@ -166,6 +175,7 @@ These mappings allow queries following InfluxDB 1.x conventions to successfully query InfluxDB {{< current-version >}} buckets. #### View existing DBRP mappings + Use the [`influx v1 dbrp list`](/influxdb/v2/reference/cli/influx/v1/dbrp/list/) to list existing DBRP mappings. @@ -174,6 +184,7 @@ influx v1 dbrp list ``` #### Create a DBRP mapping + Use the [`influx v1 dbrp create` command](/influxdb/v2/reference/cli/influx/v1/dbrp/create/) command to create a DBRP mapping. Provide the following: @@ -194,13 +205,15 @@ influx v1 dbrp create \ {{% note %}} #### Repeat for each DBRP combination + Each unique database and retention policy combination used by Grafana must be mapped to an InfluxDB {{< current-version >}} bucket. If you have multiple retention policies for a single bucket, set one of the the retention polices as the default using the `--default` flag. {{% /note %}} -_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)._ +_For more information about DBRP mapping, see +[Database and retention policy mapping](/influxdb/v2/reference/api/influxdb-1x/dbrp/)._ {{< /expand >}} {{< /expand-wrapper >}} @@ -222,6 +235,7 @@ To query InfluxDB Cloud from Grafana using InfluxQL: 3. [Configure your InfluxDB connection](#configure-your-influxdb-connection) ### Download and set up the influx CLI + 1. [Download the latest version of the `influx` CLI](/influxdb/cloud/sign-up/#optional-download-install-and-use-the-influx-cli) appropriate for your local operating system. 2. Create a CLI configuration that provides the required InfluxDB Cloud **host**, @@ -245,6 +259,7 @@ To query InfluxDB Cloud from Grafana using InfluxQL: see [`influx config`](/influxdb/cloud/reference/cli/influx/config/). ### Create an InfluxDB DBRP mapping + When using InfluxQL to query InfluxDB Cloud, the query must specify a database and a retention policy. Use the [`influx v1 dbrp create` command](/influxdb/cloud/reference/cli/influx/v1/dbrp/create/) command to create a database/retention policy (DBRP) mapping that associates a database @@ -256,6 +271,7 @@ query InfluxDB Cloud buckets. {{% note %}} ##### Automatically create DBRP mappings on write + When using the InfluxDB 1.x compatibility API to write data to InfluxDB Cloud, InfluxDB Cloud automatically creates DBRP mappings for buckets whose names match the `db/rp` naming pattern of the database and retention policy specified in the write request. @@ -280,13 +296,15 @@ influx v1 dbrp create \ {{% note %}} #### Repeat for each DBRP combination + Each unique database and retention policy combination used by Grafana must be mapped to an InfluxDB {{< current-version >}} bucket. If you have multiple retention policies for a single bucket, set one of the the retention polices as the default using the `--default` flag. {{% /note %}} -_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)._ +_For more information about DBRP mapping, see +[Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)._ {{% /cloud-only %}} @@ -295,6 +313,7 @@ _For more information about DBRP mapping, see [Database and retention policy map ### Configure your InfluxDB connection + With **InfluxQL** selected as the query language in your InfluxDB data source settings: 1. Under **HTTP**, enter the following: @@ -304,7 +323,6 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se ```sh http://localhost:8086/ ``` - - **Access**: Server (default) 2. Configure InfluxDB authentication: @@ -342,7 +360,7 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se {{% /cloud-only %}} {{< oss-only >}} - {{< img-hd src="/img/influxdb/2-2-tools-grafana-influxql.png" alt="Use Grafana with InfluxDB and Flux" />}} + {{< img-hd src="/img/influxdb/v2-tools-grafana-influxql.png" alt="Use Grafana with InfluxDB and Flux" />}} {{< /oss-only >}} {{% /tab-content %}} diff --git a/content/influxdb/v2/write-data/replication/replicate-data.md b/content/influxdb/v2/write-data/replication/replicate-data.md index e9aabfbb4..413be04b4 100644 --- a/content/influxdb/v2/write-data/replication/replicate-data.md +++ b/content/influxdb/v2/write-data/replication/replicate-data.md @@ -20,6 +20,12 @@ InfluxDB OSS, InfluxDB Cloud, or InfluxDB Enterprise instance. Replicate data from InfluxDB OSS to InfluxDB Cloud, InfluxDB OSS, or InfluxDB Enterprise. +- [Configure a replication stream](#configure-a-replication-stream) +- [Replicate downsampled or processed data](#replicate-downsampled-or-processed-data) +{{% oss-only %}} +- [View replication service metrics](#view-influxdb-oss-replication-service-metrics) +{{% /oss-only %}} + ## Configure a replication stream Use the [`influx` CLI](/influxdb/v2/tools/influx-cli/) or the @@ -275,3 +281,11 @@ In some cases, you may not want to write raw, high-precision data to a remote In ``` 3. [Create a replication stream](#configure-a-replication-stream) to replicate data from the downsampled bucket to the remote InfluxDB {{% cloud-only %}}Cloud {{% /cloud-only %}}instance. + +## View InfluxDB OSS replication service metrics + +In addition to replication stream information that you can access using the [CLI](?t=CLI#configure-a-replication-stream) or [API](?t=API#configure-a-replication-stream), you can view replication service-level metrics for your InfluxDB OSS instance, such as `/api/v2/write` error details, the number and duration of calls to the service, and the total number of points queued. + +To view replication service-level metrics send a `GET` request to your local InfluxDB OSS `/metrics` endpoint. + +For more information, see [InfluxDB OSS metrics](/influxdb/v2/reference/internals/metrics/). diff --git a/content/telegraf/v1/_index.md b/content/telegraf/v1/_index.md index 36c623c22..35396feaf 100644 --- a/content/telegraf/v1/_index.md +++ b/content/telegraf/v1/_index.md @@ -5,7 +5,7 @@ description: > time series platform, used to collect and report metrics. Telegraf supports four categories of plugins -- input, output, aggregator, and processor. menu: telegraf_v1: - name: Telegraf v1.29 + name: Telegraf v1.30 weight: 1 related: - /resources/videos/intro-to-telegraf/ diff --git a/content/telegraf/v1/commands.md b/content/telegraf/v1/commands.md deleted file mode 100644 index beedcb3de..000000000 --- a/content/telegraf/v1/commands.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Telegraf commands and flags -description: The `telegraf` command starts and runs all the processes necessary for Telegraf to function. -menu: - telegraf_v1_ref: - name: Commands - weight: 25 ---- - -The `telegraf` command starts and runs all the processes necessary for Telegraf to function. - -## Usage - -``` -telegraf [commands] -telegraf [flags] -``` - -## Commands - - - -| Command | Description | -| :-------- | :--------------------------------------------- | -| `config` | Print out full sample configuration to stdout. | -| `version` | Print version to stdout. | - -## Flags {id="telegraf-command-flags"} - -| Flag | Description | -| :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- | -| `--aggregator-filter ` | Filter aggregators to enable. Separator is `:`. | -| `--config ` | Configuration file to load. | -| `--config-directory ` | Directory containing additional `*.conf` files. | -| `--deprecation-list` | Print all deprecated plugins or plugin options. | -| `--watch-config` | Restart Telegraf on local configuration changes. Use either fs notifications (`inotify`) or polling (`poll`). Disabled by default | -| `--plugin-directory ` | Directory containing `*.so` files to search recursively for plugins. Found plugins are loaded, tagged, and identified. | -| `--debug` | Enable debug logging. | -| `--input-filter ` | Filter input plugins to enable. Separator is `:`. | -| `--input-list` | Print available input plugins. | -| `--output-filter` | Filter output plugins to enable. Separator is `:`. | -| `--output-list` | Print available output plugins. | -| `--pidfile ` | File to write PID to. | -| `--pprof-addr
` | pprof address to listen on. Disabled by default. | -| `--processor-filter ` | Filter processor plugins to enable. Separator is `:`. | -| `--quiet` | Run in quiet mode. | -| `--section-filter ` | Filter configuration sections to output (`agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`). Separator is `:`. | -| `--sample-config` | Print full sample configuration. | -| `--once` | Gather metrics once, write them, and exit. | -| `--test` | Gather metrics once and print them. | -| `--test-wait` | Number of seconds to wait for service inputs to complete in test or once mode. | -| `--usage ` | Print plugin usage (example: `telegraf --usage mysql`). | -| `--version` | Print Telegraf version. | - -## Examples - -### Generate a Telegraf configuration file - -```sh -telegraf config > telegraf.conf -``` - -### Generate configuration with only CPU input and InfluxDB output plugins defined - -```sh -telegraf --input-filter cpu --output-filter influxdb config -``` - -### Run a single Telegraf configuration, outputting metrics to stdout - -```sh -telegraf --config telegraf.conf --test -``` - -### Run Telegraf with all plugins defined in configuration file** - -```sh -telegraf --config telegraf.conf -``` - -### Run Telegraf, enabling the CPU and memory input plugins and InfluxDB output plugin** - -```sh -telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb -``` - -### Run Telegraf with pprof - -```sh -telegraf --config telegraf.conf --pprof-addr localhost:6060 -``` diff --git a/content/telegraf/v1/commands/_index.md b/content/telegraf/v1/commands/_index.md new file mode 100644 index 000000000..d8e40eb3d --- /dev/null +++ b/content/telegraf/v1/commands/_index.md @@ -0,0 +1,110 @@ +--- +title: Telegraf commands and flags +description: The `telegraf` command starts and runs all the processes necessary for Telegraf to function. +menu: + telegraf_v1_ref: + name: Telegraf commands + weight: 25 +--- + +The `telegraf` command starts and runs all the processes necessary for Telegraf to function. + +## Usage + +``` +telegraf [commands] +telegraf [flags] +``` + +## Commands + +| Command | Description | +| :---------------------------------------- | :------------------------------------------- | +| [config](/telegraf/v1/commands/config/) | Generate and migrate Telegraf configurations | +| [secrets](/telegraf/v1/commands/secrets/) | Manage secrets in secret stores | +| [plugins](/telegraf/v1/commands/plugins/) | Print available plugins | +| [version](/telegraf/v1/commands/version/) | Print current version to stdout | + +## Global flags {id="telegraf-global-flags"} + +| Flag | Description | +| :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `--config ` | Configuration file to load. | +| `--config-directory ` | Directory containing additional `*.conf` files. | +| `--test-wait` | Number of seconds to wait for service inputs to complete in test or once mode. | +| `--usage ` | Print plugin usage (example: `telegraf --usage mysql`). | +| `--pprof-addr
` | pprof address to listen on. Disabled by default. | +| `--watch-config` | Restart Telegraf on local configuration changes. Use either fs notifications (`notify`) or polling (`poll`). Disabled by default. | +| `--pidfile ` | File to write PID to. | +| `--password ` | Password to unlock secret stores. | +| `--old-env-behavior` | Switch back to pre-v1.27 environment replacement behavior. | +| `--once` | Gather metrics once, write them, and exit. | +| `--debug` | Enable debug logging. | +| `--quiet` | Run in quiet mode. | +| `--unprotected` | Do not protect secrets in memory. | +| `--test` | Gather metrics once and print them. | +| `--deprecation-list` | Print all deprecated plugins or plugin options. | +| `--input-list` | Print available input plugins. | +| `--output-list` | Print available output plugins. | +| `--version` | ({{< req "Deprecated" >}}) Print Telegraf version. | +| `--sample-config` | ({{< req "Deprecated" >}}) Print full sample configuration. | +| `--plugin-directory ` | ({{< req "Deprecated" >}}) Directory containing `*.so` files to search recursively for plugins. Found plugins are loaded, tagged, and identified. | +| `--section-filter ` | Filter configuration sections to output (`agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`). Separator is `:`. | +| `--input-filter ` | Filter input plugins to enable. Separator is `:`. | +| `--output-filter` | Filter output plugins to enable. Separator is `:`. | +| `--aggregator-filter ` | Filter aggregators to enable. Separator is `:`. | +| `--processor-filter ` | Filter processor plugins to enable. Separator is `:`. | +| `--secretstore-filter ` | Filter secretstore plugins to enable. Separator is `:`. | + + +## Examples + +- [Generate a Telegraf configuration file](#generate-a-telegraf-configuration-file) +- [Generate a configuration with only specific plugins](#generate-a-configuration-with-only-specific-plugins) +- [Run a single Telegraf configuration and output metrics to stdout](#run-a-single-telegraf-configuration-and-output-metrics-to-stdout) +- [Run Telegraf with all plugins defined in configuration file](#run-telegraf-with-all-plugins-defined-in-configuration-file) +- [Run Telegraf, but only enable specific plugins](#run-telegraf-but-only-enable-specific-plugins) +- [Run Telegraf with pprof](#run-telegraf-with-pprof) + +### Generate a Telegraf configuration file + +```sh +telegraf config > telegraf.conf +``` + +### Generate a configuration with only specific plugins + +```sh +telegraf config \ + --input-filter cpu \ + --output-filter influxdb +``` + +### Run a single Telegraf configuration and output metrics to stdout + +```sh +telegraf --config telegraf.conf --test +``` + +### Run Telegraf with all plugins defined in configuration file + +```sh +telegraf --config telegraf.conf +``` + +### Run Telegraf, but only enable specific plugins + +```sh +telegraf \ + --config telegraf.conf \ + --input-filter cpu:mem \ + --output-filter influxdb +``` + +### Run Telegraf with pprof + +```sh +telegraf \ + --config telegraf.conf \ + --pprof-addr localhost:6060 +``` diff --git a/content/telegraf/v1/commands/config/_index.md b/content/telegraf/v1/commands/config/_index.md new file mode 100644 index 000000000..b8fd6d418 --- /dev/null +++ b/content/telegraf/v1/commands/config/_index.md @@ -0,0 +1,71 @@ +--- +title: telegraf config +description: > + The `telegraf config` command generates Telegraf configuration files and migrates deprecated plugins in configuration files. +menu: + telegraf_v1_ref: + parent: Telegraf commands +weight: 201 +--- + + The `telegraf config` command generates Telegraf configuration files and migrates deprecated plugins in configuration files. + +## Usage + +```sh +telegraf [global-flags] config [subcommand] [flags] +``` + +## Subcommands + +| Subcommand | Description | +| :----------------------------------------------------------------------------- | :---------------------------------------------- | +| [create](/telegraf/v1/commands/config/create/) (default) | Create and output a Telegraf configuration | +| [migrate](/telegraf/v1/commands/config/migrate/) | Migrate deprecated plugins to supported plugins | +| help, h | Show command help | + +## Flags + +| Flag | | Description | +| :--- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +| | `--section-filter` | Filter sections to print separated by `:` (Valid values are `agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`) | +| | `--input-filter` | Filter inputs to enable separated by `:` | +| | `--output-filter` | Filter outputs to enable separated by `:` | +| | `--aggregator-filter` | Filter aggregators to enable separated by `:` | +| | `--processor-filter` | Filter processors to enable separated by `:` | +| | `--secretstore-filter` | Filter secret-stores to enable separated by `:` | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [Create a full configuration](#create-a-full-configuration) +- [Create a full configuration as save it to a file](#create-a-full-configuration-as-save-it-to-a-file) +- [Create a configuration with specific sections and plugins](#create-a-configuration-with-specific-sections-and-plugins) + +### Create a full configuration + +```sh +telegraf config +``` + +### Create a full configuration as save it to a file + +```sh +telegraf config > telegraf.conf +``` + +### Create a configuration with specific sections and plugins + +To print a configuration containing only a Modbus input plugin and an +InfluxDB v2 output plugin, run the following: + +```sh +telegraf config \ + --section-filter "inputs:outputs" \ + --input-filter "modbus" \ + --output-filter "influxdb_v2" +``` diff --git a/content/telegraf/v1/commands/config/create.md b/content/telegraf/v1/commands/config/create.md new file mode 100644 index 000000000..1d56d87e6 --- /dev/null +++ b/content/telegraf/v1/commands/config/create.md @@ -0,0 +1,67 @@ +--- +title: telegraf config create +description: > + The `telegraf config create` command returns a full Telegraf configuration + containing all plugins as an example. You can also apply section or plugin + filters to reduce the output to the plugins you need. +menu: + telegraf_v1_ref: + parent: telegraf config +weight: 301 +--- + +The `telegraf config create` command returns a full Telegraf configuration +containing all plugins as an example. You can also apply section or plugin +filters to reduce the output to the plugins you need. + +## Usage + +```sh +telegraf [global-flags] config create [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +| | `--section-filter` | Filter sections to print separated by `:` (Valid values are `agent`, `global_tags`, `outputs`, `processors`, `aggregators` and `inputs`) | +| | `--input-filter` | Filter inputs to enable separated by `:` | +| | `--output-filter` | Filter outputs to enable separated by `:` | +| | `--aggregator-filter` | Filter aggregators to enable separated by `:` | +| | `--processor-filter` | Filter processors to enable separated by `:` | +| | `--secretstore-filter` | Filter secret-stores to enable separated by `:` | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [Create a full configuration](#create-a-full-configuration) +- [Create a full configuration as save it to a file](#create-a-full-configuration-as-save-it-to-a-file) +- [Create a configuration with specific sections and plugins](#create-a-configuration-with-specific-sections-and-plugins) + +### Create a full configuration + +```sh +telegraf config create +``` + +### Create a full configuration as save it to a file + +```sh +telegraf config create > telegraf.conf +``` + +### Create a configuration with specific sections and plugins + +To print a configuration containing only a Modbus input plugin and an +InfluxDB v2 output plugin, run the following: + +```sh +telegraf config create \ + --section-filter "inputs:outputs" \ + --input-filter "modbus" \ + --output-filter "influxdb_v2" +``` diff --git a/content/telegraf/v1/commands/config/migrate.md b/content/telegraf/v1/commands/config/migrate.md new file mode 100644 index 000000000..3994689e9 --- /dev/null +++ b/content/telegraf/v1/commands/config/migrate.md @@ -0,0 +1,66 @@ +--- +title: telegraf config migrate +description: > + The `telegraf config migrate` migrates deprecated plugins in a Telegraf configuration file to supported plugins. +menu: + telegraf_v1_ref: + parent: telegraf config +weight: 301 +--- + +The `telegraf config migrate` command reads the configuration files specified +in the `--config` or `--config-directory` and attempts to migrate plugins or +options that are currently deprecated to the recommended replacements. +If no configuration file is explicitly specified, the command reads the +[default locations](/telegraf/v1/configuration/#configuration-file-locations) +and uses those configuration files. + +Migrated files are stored with a `.migrated` suffix at the +location of the source configuration files. +If migrating remote configurations, the migrated configuration is stored in the +current directory using the URL as the filename with a `.migrated` suffix. + +{{% warn %}} +#### Test migrated configuration files + +We strongly recommend testing migrated configuration files before using them in production. +{{% /warn %}} + +## Usage + +```sh +telegraf [global-flags] config migrate [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :-------- | :----------------------------------------------- | +| | `--force` | Forces overwriting of an existing migration file | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [Migrate a single configuration file](#migrate-a-single-configuration-file) +- [Migrate a configuration directory](#migrate-a-configuration-directory) + +### Migrate a single configuration file + +To migrate the file `mysettings.conf`, run the following command: + +```sh +telegraf --config mysettings.conf config migrate +``` + +### Migrate a configuration directory + +To migrate all configurations files in the `~/telegraf/conf/` directory, use +the following command: + +```sh +telegraf --config-directory ~/telegraf/conf/ config migrate +``` \ No newline at end of file diff --git a/content/telegraf/v1/commands/plugins/_index.md b/content/telegraf/v1/commands/plugins/_index.md new file mode 100644 index 000000000..591348f80 --- /dev/null +++ b/content/telegraf/v1/commands/plugins/_index.md @@ -0,0 +1,42 @@ +--- +title: telegraf plugins +description: > + The `telegraf plugins` command prints available Telegraf plugins. +menu: + telegraf_v1_ref: + parent: Telegraf commands +weight: 201 +--- + +The `telegraf plugins` command prints available Telegraf plugins. + +## Usage + +```sh +telegraf [global-flags] plugins [subcommand] [flags] +``` + +## Subcommands + +| Subcommand | Description | +| :---------------------------------------------------------- | :---------------------------------- | +| [inputs](/telegraf/v1/commands/plugins/inputs/) | Print available input plugins | +| [outputs](/telegraf/v1/commands/plugins/outputs/) | Print available output plugins | +| [processors](/telegraf/v1/commands/plugins/processors/) | Print available processor plugins | +| [aggregators](/telegraf/v1/commands/plugins/aggregators/) | Print available aggregator plugins | +| [secretstores](/telegraf/v1/commands/plugins/secretstores/) | Print available secretstore plugins | +| help, h | Shows command help | + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + diff --git a/content/telegraf/v1/commands/plugins/aggregators.md b/content/telegraf/v1/commands/plugins/aggregators.md new file mode 100644 index 000000000..99437053b --- /dev/null +++ b/content/telegraf/v1/commands/plugins/aggregators.md @@ -0,0 +1,36 @@ +--- +title: telegraf plugins aggregators +description: > + The `telegraf plugins aggregators` command prints available aggregator plugins. +menu: + telegraf_v1_ref: + parent: telegraf plugins +weight: 304 +--- + +The `telegraf plugins aggregators` command prints available aggregator plugins. + +## Usage + +```sh +telegraf [global-flags] plugins aggregators [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +### List available aggregator plugins + +```sh +telegraf plugins aggregators +``` diff --git a/content/telegraf/v1/commands/plugins/inputs.md b/content/telegraf/v1/commands/plugins/inputs.md new file mode 100644 index 000000000..0c0245f63 --- /dev/null +++ b/content/telegraf/v1/commands/plugins/inputs.md @@ -0,0 +1,42 @@ +--- +title: telegraf plugins inputs +description: > + The `telegraf plugins inputs` command prints available input plugins. +menu: + telegraf_v1_ref: + parent: telegraf plugins +weight: 301 +--- + +The `telegraf plugins inputs` command prints available input plugins. + +## Usage + +```sh +telegraf [global-flags] plugins inputs [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +### List available input plugins + +```sh +telegraf plugins inputs +``` + +### List deprecated input plugins + +```sh +telegraf plugins inputs --deprecated +``` diff --git a/content/telegraf/v1/commands/plugins/outputs.md b/content/telegraf/v1/commands/plugins/outputs.md new file mode 100644 index 000000000..6a51b9bc9 --- /dev/null +++ b/content/telegraf/v1/commands/plugins/outputs.md @@ -0,0 +1,42 @@ +--- +title: telegraf plugins outputs +description: > + The `telegraf plugins outputs` command prints available output plugins. +menu: + telegraf_v1_ref: + parent: telegraf plugins +weight: 302 +--- + +The `telegraf plugins outputs` command prints available output plugins. + +## Usage + +```sh +telegraf [global-flags] plugins outputs [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +### List available output plugins + +```sh +telegraf plugins outputs +``` + +### List deprecated output plugins + +```sh +telegraf plugins outputs --deprecated +``` diff --git a/content/telegraf/v1/commands/plugins/processors.md b/content/telegraf/v1/commands/plugins/processors.md new file mode 100644 index 000000000..6758724c3 --- /dev/null +++ b/content/telegraf/v1/commands/plugins/processors.md @@ -0,0 +1,36 @@ +--- +title: telegraf plugins processors +description: > + The `telegraf plugins processors` command prints available processor plugins. +menu: + telegraf_v1_ref: + parent: telegraf plugins +weight: 303 +--- + +The `telegraf plugins processors` command prints available processor plugins. + +## Usage + +```sh +telegraf [global-flags] plugins processors [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +### List available processor plugins + +```sh +telegraf plugins processors +``` diff --git a/content/telegraf/v1/commands/plugins/secretstores.md b/content/telegraf/v1/commands/plugins/secretstores.md new file mode 100644 index 000000000..0dd87b408 --- /dev/null +++ b/content/telegraf/v1/commands/plugins/secretstores.md @@ -0,0 +1,36 @@ +--- +title: telegraf plugins secretstores +description: > + The `telegraf plugins secretstores` command prints available secretstore plugins. +menu: + telegraf_v1_ref: + parent: telegraf plugins +weight: 305 +--- + +The `telegraf plugins secretstores` command prints available secretstore plugins. + +## Usage + +```sh +telegraf [global-flags] plugins secretstores [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :---------------------------- | +| | `--deprecated` | Print only deprecated plugins | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +### List available secretstore plugins + +```sh +telegraf plugins secretstores +``` diff --git a/content/telegraf/v1/commands/secrets/_index.md b/content/telegraf/v1/commands/secrets/_index.md new file mode 100644 index 000000000..9a24a04ae --- /dev/null +++ b/content/telegraf/v1/commands/secrets/_index.md @@ -0,0 +1,36 @@ +--- +title: telegraf secrets +description: > + The `telegraf secrets` command manages secrets in secret stores to use with Telegraf. +menu: + telegraf_v1_ref: + parent: Telegraf commands +weight: 201 +--- + +The `telegraf secrets` command manages secrets in secret stores to use with Telegraf. + +## Usage + +```sh +telegraf [global-flags] secrets [subcommand] [flags] +``` + +## Subcommands + +| Subcommand | Description | +| :------------------------------------------ | :------------------------------------------------- | +| [list](/telegraf/v1/commands/secrets/list/) | List known secrets and secret stores | +| [get](/telegraf/v1/commands/secrets/get/) | Retrieve the value of a secret from a secret store | +| [set](/telegraf/v1/commands/secrets/set/) | Create or modify a secret in a secret store | +| `help`, `h` | Shows command help | + +## Flags + +| Flag | | Description | +| :--- | :------- | :---------------- | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} diff --git a/content/telegraf/v1/commands/secrets/get.md b/content/telegraf/v1/commands/secrets/get.md new file mode 100644 index 000000000..1976745b3 --- /dev/null +++ b/content/telegraf/v1/commands/secrets/get.md @@ -0,0 +1,86 @@ +--- +title: telegraf secrets get +description: > + The `telegraf secrets get` command retrieves the value of a secret from the + specified secret store. +menu: + telegraf_v1_ref: + parent: telegraf secrets +weight: 301 +--- + +The `telegraf secrets get` command retrieves the value of a secret from the +specified secret store. + +{{% note %}} +This command requires your configuration file that contains the secret store +definitions you want to access. If the `--config` or `--config-directory` flags +are not included in the command, Telegraf checks the +[default configuration file location](/telegraf/v1/configuration/#configuration-file-locations). +{{% /note %}} + +Use [`telegraf secrets list`](/telegraf/v1/commands/secrets/list/) to get the +IDs of available secret stores and the available secret keys. + +If you haven't configured a secret store, use +[`telegraf plugins secretstores`](/telegraf/v1/commands/plugins/secretstores/) +to list available secret store plugins. +View secret store plugin configuration documentation in the +[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores). + +## Usage + +```sh +telegraf [global-flags] secrets get [flags] +``` + +## Arguments + +| Argument | Description | +| :------------------ | :------------------------------------------------- | +| **SECRET_STORE_ID** | ID of the secret store to retrieve the secret from | +| **SECRET_KEY** | Key of the secret to retrieve | + +## Flags + +| Flag | | Description | +| :--- | :------- | :---------------- | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [Retrieve a secret using the default configuration location](#retrieve-a-secret-using-the-default-configuration-location) +- [Retrieve a secret using a non-default configuration location](#retrieve-a-secret-using-a-non-default-configuration-location) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`SECRET_STORE_ID`{{% /code-placeholder-key %}}: + The ID of the secret store to retrieve the secret from. +- {{% code-placeholder-key %}}`SECRET_KEY`{{% /code-placeholder-key %}}: + The key of the secret to retrieve from the secret store. +- {{% code-placeholder-key %}}`CUSTOM_CONFIG_PATH`{{% /code-placeholder-key %}}: + The non-default filepath to your Telegraf configuration file containing your + secret store definitions. + +### Retrieve a secret using the default configuration location + +The following example assumes the Telegraf configuration file that contains the +secret store definition is at the [default location](/telegraf/v1/configuration/#configuration-file-locations). + +{{% code-placeholders "SECRET_(STORE_ID|KEY)" %}} +```sh +telegraf secrets get SECRET_STORE_ID SECRET_KEY +``` +{{% /code-placeholders %}} + +### Retrieve a secret using a non-default configuration location + +{{% code-placeholders "CUSTOM_CONFIG_PATH|SECRET_(STORE_ID|KEY)" %}} +```sh +telegraf --config CUSTOM_CONFIG_PATH secrets get SECRET_STORE_ID SECRET_KEY +``` +{{% /code-placeholders %}} diff --git a/content/telegraf/v1/commands/secrets/list.md b/content/telegraf/v1/commands/secrets/list.md new file mode 100644 index 000000000..a626bf562 --- /dev/null +++ b/content/telegraf/v1/commands/secrets/list.md @@ -0,0 +1,96 @@ +--- +title: telegraf secrets list +description: > + The `telegraf secrets list` command lists known secrets and secret stores. +menu: + telegraf_v1_ref: + parent: telegraf secrets +weight: 301 +--- + +The `telegraf secrets list` command lists known secrets and secret stores. + +{{% note %}} +This command requires your configuration file that contains the secret store +definitions you want to access. If the `--config` or `--config-directory` flags +are not included in the command, Telegraf checks the +[default configuration file location](/telegraf/v1/configuration/#configuration-file-locations). +{{% /note %}} + +If you haven't configured a secret store, use +[`telegraf plugins secretstores`](/telegraf/v1/commands/plugins/secretstores/) +to list available secret store plugins. +View secret store plugin configuration documentation in the +[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores). + +## Usage + +```sh +telegraf [global-flags] secrets list [flags] [SECRET_STORE_ID[ ...[SECRET_STORE_ID]]] +``` + +## Arguments + +| Argument | Description | +| :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **SECRET_STORE_ID** | ID of the secret store to list secrets from. You can include multiple, space-delimited IDs. If no ID(s) are provided, the command lists secrets from all secret stores. | + +## Flags + +| Flag | | Description | +| :--- | :---------------- | :------------------ | +| | `--reveal-secret` | Print secret values | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [List secrets and secret stores using the default configuration location](#list-secrets-and-secret-stores-using-the-default-configuration-location) +- [List secrets and secret stores using a non-default configuration location](#list-secrets-and-secret-stores-using-a-non-default-configuration-location) +- [List secrets from a specific secret store](#list-secrets-from-a-specific-secret-store) +- [Show secret values when listing secrets and secret stores](#show-secret-values-when-listing-secrets-and-secret-stores) + +### List secrets and secret stores using the default configuration location + +The following example assumes the Telegraf configuration file that contains the +secret store definition is at the [default location](/telegraf/v1/configuration/#configuration-file-locations). + +```sh +telegraf secrets list +``` + +### List secrets and secret stores using a non-default configuration location + +{{% code-placeholders "CUSTOM_CONFIG_PATH" %}} +```sh +telegraf --config CUSTOM_CONFIG_PATH secrets list +``` +{{% /code-placeholders %}} + +- Replace {{% code-placeholder-key %}}`CUSTOM_CONFIG_PATH`{{% /code-placeholder-key %}} + with the non-default filepath to your Telegraf configuration file containing + your secret store definitions. + + +### List secrets from a specific secret store + +{{% code-placeholders "SECRET_STORE_ID" %}} +```sh +telegraf secrets list SECRET_STORE_ID +``` +{{% /code-placeholders %}} + +- Replace {{% code-placeholder-key %}}`SECRET_STORE_ID`{{% /code-placeholder-key %}} + with the ID of the secret store to retrieve the secret from. + +### Show secret values when listing secrets and secret stores + +To print secret values with listing secrets and secret stores, include the +`--reveal-secret` flag: + +```sh +telegraf secrets list --reveal-secret +``` diff --git a/content/telegraf/v1/commands/secrets/set.md b/content/telegraf/v1/commands/secrets/set.md new file mode 100644 index 000000000..430fa3986 --- /dev/null +++ b/content/telegraf/v1/commands/secrets/set.md @@ -0,0 +1,93 @@ +--- +title: telegraf secrets set +description: > + The `telegraf secrets set` command creates or modify a secret in a specified + secret store. +menu: + telegraf_v1_ref: + parent: telegraf secrets +weight: 301 +--- + +The `telegraf secrets set` command creates or modify a secret in a specified secret store. + +{{% note %}} +This command requires your configuration file that contains the secret store +definitions you want to access. If the `--config` or `--config-directory` flags +are not included in the command, Telegraf checks the +[default configuration file location](/telegraf/v1/configuration/#configuration-file-locations). +{{% /note %}} + +Use [`telegraf secrets list`](/telegraf/v1/commands/secrets/list/) to get the +IDs of available secret stores and the available secret keys. + +If you haven't configured a secret store, use +[`telegraf plugins secretstores`](/telegraf/v1/commands/plugins/secretstores/) +to list available secret store plugins. +View secret store plugin configuration documentation in the +[Telegraf GitHub repository](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores). + +## Usage + +```sh +telegraf [global-flags] secrets set [flags] +``` + +## Arguments + +| Argument | Description | +| :------------------ | :------------------------------------------ | +| **SECRET_STORE_ID** | ID of the secret store to set the secret in | +| **SECRET_KEY** | Key of the secret to set | +| **SECRET_VALUE** | Value of the secret to set | + +## Flags + +| Flag | | Description | +| :--- | :------- | :---------------- | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} + +## Examples + +- [Set a secret using the default configuration location](#set-a-secret-using-the-default-configuration-location) +- [Set a secret using a non-default configuration location](#set-a-secret-using-a-non-default-configuration-location) + +In the examples below, replace the following: + +- {{% code-placeholder-key %}}`SECRET_STORE_ID`{{% /code-placeholder-key %}}: + The ID of the secret store to store the secret in. +- {{% code-placeholder-key %}}`SECRET_KEY`{{% /code-placeholder-key %}}: + The key of the secret to set. +- {{% code-placeholder-key %}}`SECRET_VALUE`{{% /code-placeholder-key %}}: + The value of the secret to set. +- {{% code-placeholder-key %}}`CUSTOM_CONFIG_PATH`{{% /code-placeholder-key %}}: + The non-default filepath to your Telegraf configuration file containing your + secret store definitions. + +### Set a secret using the default configuration location + +The following example assumes the Telegraf configuration file that contains the +secret store definition is at the [default location](/telegraf/v1/configuration/#configuration-file-locations). + +{{% code-placeholders "SECRET_(STORE_ID|KEY|VALUE)" %}} +```sh +telegraf secrets set SECRET_STORE_ID SECRET_KEY SECRET_VALUE +``` +{{% /code-placeholders %}} + +### Set a secret using a non-default configuration location + +{{% code-placeholders "CUSTOM_CONFIG_PATH|SECRET_(STORE_ID|KEY|VALUE)" %}} +```sh +telegraf \ + --config CUSTOM_CONFIG_PATH \ + secrets set \ + SECRET_STORE_ID \ + SECRET_KEY \ + SECRET_VALUE +``` +{{% /code-placeholders %}} diff --git a/content/telegraf/v1/commands/version.md b/content/telegraf/v1/commands/version.md new file mode 100644 index 000000000..92fb90aed --- /dev/null +++ b/content/telegraf/v1/commands/version.md @@ -0,0 +1,27 @@ +--- +title: telegraf version +description: > + The `telegraf version` command prints the current Telegraf version. +menu: + telegraf_v1_ref: + parent: Telegraf commands +weight: 201 +--- + +The `telegraf version` command prints the current Telegraf version. + +## Usage + +```sh +telegraf [global-flags] version [flags] +``` + +## Flags + +| Flag | | Description | +| :--- | :------------- | :--------------------------------------------- | +| `-h` | `--help` | Show command help | + +{{% caption %}} +_Also see [Telegraf global flags](/telegraf/v1/commands/#telegraf-global-flags)._ +{{% /caption %}} diff --git a/content/telegraf/v1/configuration.md b/content/telegraf/v1/configuration.md index 70d09f8bf..efe742c27 100644 --- a/content/telegraf/v1/configuration.md +++ b/content/telegraf/v1/configuration.md @@ -150,8 +150,9 @@ The `[agent]` section contains the following configuration options: To use local time, set to `"local"`. See [timezone options and formats](https://socketloop.com/tutorials/golang-display-list-of-timezones-with-gmt). - **hostname**: Override default hostname, if empty use `os.Hostname()`. -- **omit_hostname**: If true, do no set the `host` tag in the Telegraf agent. - +- **omit_hostname**: If true, do not set the `host` tag in the Telegraf agent. +- **skip_processors_after_aggregators**: If true, processors do not run again + after aggregators. Default is false. ## Input configuration diff --git a/content/telegraf/v1/data_formats/input/json_v2.md b/content/telegraf/v1/data_formats/input/json_v2.md index 5f06bd44e..269bc9f1f 100644 --- a/content/telegraf/v1/data_formats/input/json_v2.md +++ b/content/telegraf/v1/data_formats/input/json_v2.md @@ -156,7 +156,7 @@ file,title=The\ Lord\ Of\ The\ Rings author="Tolkien",random=2 ``` -You can find more complicated examples under the folder `testdata`. +You can find more complicated examples under the folder [`testdata`][] in the telegraf repo. ## Types @@ -165,7 +165,7 @@ The following rules are in place for this configuration: * If a type is explicitly defined, the parser will enforce this type and convert the data to the defined type if possible. If the type can't be converted then the parser will fail. -* If a type isn't defined, the parser will use the default type defined in the JSON (int, float, string) +* If a type isn't defined, the parser will use the default type defined in the JSON (int, float, string). The type values you can set: @@ -175,4 +175,5 @@ The type values you can set: * `float`, string values (with valid numbers) or integers can be converted to a float. * `bool`, the string values "true" or "false" (regardless of capitalization) or the integer values `0` or `1` can be turned to a bool. -[json]: https://www.json.org/ +[json]: https://www.json.org/ +[testdata]: https://github.com/influxdata/telegraf/tree/master/plugins/parsers/json_v2/testdata \ No newline at end of file diff --git a/content/telegraf/v1/release-notes.md b/content/telegraf/v1/release-notes.md index bcd994ecb..052e6b867 100644 --- a/content/telegraf/v1/release-notes.md +++ b/content/telegraf/v1/release-notes.md @@ -11,7 +11,178 @@ menu: weight: 60 --- -## v1.29.0 {date="2023-12-11} +## v1.30.1 {date="2024-04-01"} + +### Bug fixes + +- Chrony (`inputs.chrony`): Remove chronyc dependency in documentation. +- DiskIO (`inputs.diskio`): Add missing udev properties. +- DNS Query (`inputs.dns_query`): + - Fill out additional record fields. + - Include the canonical CNAME target. +- KNX (`inputs.knx_listener`): + - Ignore GroupValueRead requests. + - Reconnect after connection loss. +- MySQL (`inputs.mysql`): + - Parse boolean values in metric v1 correctly. + - Use correct column-types for Percona 8 user stats. +- NVIDIA SMI (`inputs.nvidia_smi`): Add process info metrics. +- OpenStack(`inputs.openstack`): Resolve regression in block storage and server info. +- PHP-FPM (`inputs.phpfpm`): Add timeout for fcgi. +- Ping (`inputs.ping`): Add option to force ipv4. +- Prometheus (`inputs.prometheus`): Initialize logger of parser. +- S.M.A.R.T. (`inputs.smart`): Improve regexp to support flags with a plus. +- Systemd Units (`inputs.systemd_units`): Handle disabled multi-instance units correctly. +- BigQuery (`outputs.bigquery`): Add scope to bigquery and remove timeout context. +- Avoid count underflow by only counting initialized secrets. +- Ensure watch-config is passed to the Windows service. + +### Dependency updates + +- Update `github.com/IBM/sarama` from v1.42.2 to v1.43.1. +- Update `github.com/aws/aws-sdk-go-v2` from 1.25.3 to 1.26.0. +- Update `github.com/aws/aws-sdk-go-v2/config` from 1.27.5 to 1.27.9. +- Update `github.com/aws/aws-sdk-go-v2/feature/ec2/imds` from 1.15.2 to 1.16.0. +- Update `github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs` from 1.34.2 to 1.34.3. +- Update `github.com/aws/aws-sdk-go-v2/service/ec2` from 1.149.3 to 1.151.1. +- Update `github.com/aws/aws-sdk-go-v2/service/sts` from 1.28.2 to 1.28.4. +- Update `github.com/docker/docker` from 25.0.0+incompatible to 25.0.5+incompatible. +- Update `github.com/jackc/pgtype` from 1.14.0 to 1.14.2. +- Update `github.com/jackc/pgx/v4` from 4.18.1 to 4.18.2. +- Update `github.com/klauspost/compress` from 1.17.6 to 1.17.7. +- Update `github.com/pion/dtls/v2` from 2.2.8 to 2.2.10. +- Update `github.com/prometheus-community/pro-bing` from 0.3.0 to 0.4.0. +- Update `github.com/prometheus/procfs` from 0.12.0 to 0.13.0. +- Update `github.com/stretchr/testify` v1.8.4 to v1.9.0. +- Update `go.step.sm/crypto` from 0.43.0 to 0.44.1. +- Update `golang.org/x/crypto` from 0.20.0 to 0.21.0. +- Update `gonum.org/v1/gonum` from 0.14.0 to 0.15.0. +- Update `google.golang.org/api` from 0.165.0 to 0.171.0. +- Update `google.golang.org/protobuf` from 1.32.0 to 1.33.0. +- Update `tj-actions/changed-files` from 42 to 43. + + +## v1.30.0 {date="2024-03-11"} + +### Deprecation removals + +This release removes the following deprecated plugins: + +- `inputs.cassandra` +- `inputs.httpjson` +- `inputs.io` +- `inputs.jolokia` +- `inputs.kafka_consumer_legacy` +- `inputs.snmp_legacy` +- `inputs.tcp_listener` +- `inputs.udp_listener` +- `outputs.riemann_legacy` + +Furthermore, the following deprecated plugin options are removed: + +- `mountpoints` of `inputs.disk` +- `metric_buffer` of `inputs.mqtt_consumer` +- `metric_buffer` of `inputs.nats_consumer` +- `url` of `outputs.influxdb` + +Replacements do exist, so please migrate your configuration in case you are +still using one of these plugins. The [`telegraf config migrate` command](/telegraf/v1/commands/config/migrate/) +can help with migrating to newer plugins. + +### Important Changes + +- The default read-timeout of `inputs.syslog` of five seconds is not a sensible + default as the plugin will close the connection if the time between + consecutive messages exceeds the timeout. Telegraf 1.30.0+ sets the timeout + to infinite (i.e zero) as this is the expected behavior. +- Telegraf 1.30.0+ correctly sanitize PostgreSQL addresses, which may change the + server tag value for a URI-formatted address that contains spaces, backslashes + or single-quotes in non-redacted parameters. + +### New Plugins + +#### Outputs + +- [Zabbix](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/zabbix) (`outputs.zabbix`) + +#### Serializers + +- [Binary](https://github.com/influxdata/telegraf/tree/master/plugins/serializers/binary) (`serializers.binary`) + +#### Processors + +- [SNMP lookup](https://github.com/influxdata/telegraf/tree/master/plugins/processors/snmp_lookup) (`processors.snmp_lookup`) + +### Features + +- Add loongarch64 nightly and release builds. +- Add `skip_processors_after_aggregators` configuration option to skip + re-running processors after aggregators. +- Allow secrets in headers +- OPCUA (`common.opcua`): Add debug info for nodes not in server namespace. +- Aerospike (`inputs.aerospike`): Deprecate plugin. +- AMD ROCm System Management Interface (`inputs.amd_rocm_smi`): + Add `startup_error_behavior` configuration option. +- Chrony (`inputs.chrony`): + - Allow the collection of additional metrics. + - Remove `chronyc` dependency. +- Kafka Consumer (`inputs.kafka_consumer`): Mark messages that failed parsing. +- Kernel (`inputs.kernel`): Add pressure stall information. +- Modbus (`inputs.modbus`): Add a workaround for unusual string-byte locations. +- Net (`inputs.net`): Add speed metric. +- NVIDIA SMI (`inputs.nvidia_smi`): Add `startup_error_behavior` configuration option. +- Prometheus (`inputs.prometheus`): + - Add internal metrics. + - Add option to limit body length. +- Redfish (`inputs.redfish`): Allow secrets for username/password configuration. +- S.M.A.R.T. (`inputs.smart`): Add a `device_type` tag to differentiate disks + behind a RAID controller. +- SQL Server (`inputs.sqlserver`): Add stolen target memory ratio. +- Systemd Units (`inputs.systemd_units`) + - Support querying unloaded/disabled units. + - Introduce show subcommand for additional data. +- Windows Services (`inputs.win_services`): Make service selection case-insensitive. +- Graphite (`outputs.graphite`): Set the local address to bind to. +- NATS (`outputs.nats`): Introduce NATS Jetstream option. +- Nebius Cloud Monitoring (`outputs.nebius_cloud_monitoring`): Add service + configuration setting. +- Webscoket (`outputs.websocket`): Support secrets in headers. +- CSV (`serializers.csv`): Specify a fixed column order. + +### Bug fixes + +- Catch panics in input plugin goroutines. +- Reword error message about missing configuration options. +- Docker Log (`inputs.docker_log`): Use the correct name when matching container. +- GNMI (`inputs.gnmi`): + - Add option to infer the path tag from the subscription. + - Handle canonical field-name correctly +- Netflow (`inputs.netflow`): Fallback to IPFIX mappings for Netflow v9. +- PHP-FPM (`inputs.phpfpm`): Continue despite erroneous sockets. +- Prometheus (`inputs.prometheus`): List namespaces only when filtering by namespace. +- Prometheus (`parsers.prometheus`): Do not touch input data for protocol-buffers. +- Override (`processors.override`): Correct TOML tag name. +- Ensure valid statefile in package. + +### Dependency updates + +- Update all `github.com/aws/aws-sdk-go-v2` dependencies. +- Update `cloud.google.com/go/bigquery` from 1.58.0 to 1.59.1. +- Update `github.com/aws/aws-sdk-go-v2/service/dynamodb` from 1.27.0 to 1.30.2. +- Update `github.com/cloudevents/sdk-go/v2` from 2.15.0 to 2.15.2. +- Update `github.com/eclipse/paho.golang` from 0.20.0 to 0.21.0. +- Update `github.com/microsoft/go-mssqldb` from 1.6.0 to 1.7.0. +- Update `github.com/netsampler/goflow2` from v1.3.6 to v2.1.2. +- Update `github.com/peterbourgon/unixtransport` from 0.0.3 to 0.0.4. +- Update `github.com/prometheus/client_model` from 0.5.0 to 0.6.0. +- Update `github.com/srebhan/cborquery` from v0.0.0-20230626165538-38be85b82316 to v1.0.1. +- Update `github.com/vapourismo/knx-go` from v0.0.0-20240107135439-816b70397a00 to v0.0.0-20240217175130-922a0d50c241. +- Update `go.mongodb.org/mongo-driver` from 1.13.1 to 1.14.0. +- Update `golang.org/x/crypto` from 0.19.0 to 0.20.0. +- Update `modernc.org/sqlite` from 1.28.0 to 1.29.2. +- Update `super-linter/super-linter` from 6.1.1 to 6.3.0. + +## v1.29.0 {date="2023-12-11"} ### New Plugins diff --git a/data/notifications.yaml b/data/notifications.yaml index 2372ddb59..1c7c68599 100644 --- a/data/notifications.yaml +++ b/data/notifications.yaml @@ -9,24 +9,6 @@ # message: | # Markdown message content. -- id: influxdb-clustered-announcement - level: note - scope: - - / - title: Introducing InfluxDB Clustered - slug: A highly available InfluxDB 3.0 cluster on your own infrastructure. - message: | - [InfluxDB Clustered](/influxdb/clustered/) is a highly available InfluxDB 3.0 - cluster built for high write and query workloads on your own infrastructure. - - InfluxDB Clustered is currently in **limited availability** and is only - available to a limited group of InfluxData customers. If interested in being - part of the limited access group, please - [contact the InfluxData Sales team](https://www.influxdata.com/contact-sales-influxdb-clustered). - - [Learn more](https://www.influxdata.com/blog/announcing-influxdb-clustered/) - [Contact InfluxData Sales](https://www.influxdata.com/contact-sales-influxdb-clustered) - - id: future-of-flux level: warn scope: diff --git a/data/products.yml b/data/products.yml index 0fd56b5ac..f71f739ca 100644 --- a/data/products.yml +++ b/data/products.yml @@ -55,7 +55,7 @@ influxdb_cloud_dedicated: list_order: 3 latest: cloud-dedicated link: "https://www.influxdata.com/contact-sales-form/" - latest_cli: 2.7.0 + latest_cli: 2.8.0 placeholder_host: cluster-id.influxdb.io influxdb_clustered: @@ -75,9 +75,9 @@ telegraf: menu_category: other list_order: 6 versions: [v1] - latest: v1.29 + latest: v1.30 latest_patches: - v1: 1.29.0 + v1: 1.30.1 chronograf: name: Chronograf diff --git a/data/telegraf_plugins.yml b/data/telegraf_plugins.yml index 40c6cc0ec..b123e1f03 100644 --- a/data/telegraf_plugins.yml +++ b/data/telegraf_plugins.yml @@ -25,9 +25,13 @@ input: - name: Aerospike id: aerospike description: | + **Deprecated in favor of the [Prometheus plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/prometheus/README.md) + with the Aerospike Prometheus Exporter.** + The Aerospike input plugin queries Aerospike servers and gets node statistics and statistics for all configured namespaces. introduced: 0.2.0 + deprecated: 1.30.0 tags: [linux, macos, windows, data-stores] - name: Alibaba CloudMonitor Service (Aliyun) @@ -252,19 +256,6 @@ input: introduced: 1.7.0 tags: [linux, macos, windows, messaging] - - name: Cassandra - id: cassandra - description: | - *Deprecated in Telegraf 1.7.0 in favor of the [jolokia2](#jolokia2_agent) input plugin. - See [example Jolokia2/Cassandra configurations](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/jolokia2/examples/cassandra.conf).* - - The Cassandra input plugin collects Cassandra 3 / JVM metrics exposed as MBean - attributes through the jolokia REST endpoint. - All metrics are collected for each server configured. - introduced: 0.12.1 - deprecated: 1.6.4 - tags: [linux, macos, windows, data-stores] - - name: Ceph Storage id: ceph description: | @@ -692,17 +683,6 @@ input: introduced: 1.6.0 tags: [linux, macos, windows, servers, web] - - name: HTTP JSON - id: httpjson - description: | - *Deprecated in Telegraf 1.6.0. Use the [HTTP input plugin](#http).* - - The HTTP JSON input plugin collects data from HTTP URLs which respond with JSON. - It flattens the JSON and finds all numeric values, treating them as floats. - introduced: 0.1.6 - deprecated: 1.5.3 - tags: [linux, macos, windows, servers, web] - - name: HTTP Listener id: http_listener description: | @@ -949,14 +929,6 @@ input: introduced: 1.9.0 tags: [linux, macos, windows, build-deploy] - - name: Jolokia - id: jolokia - description: | - *Deprecated in Telegraf 1.5.0. Use the [Jolokia2 input plugin](#jolokia2_agent).* - introduced: 0.2.1 - deprecated: 1.4.5 - tags: [linux, macos, windows, networking] - - name: Jolokia2 Agent id: jolokia2_agent description: | @@ -1855,15 +1827,6 @@ input: introduced: 0.10.1 tags: [linux, macos, windows, networking] - - name: SNMP Legacy - id: snmp_legacy - description: | - The SNMP Legacy input plugin gathers metrics from SNMP agents. - *Deprecated in Telegraf 1.0.0. Use the [SNMP input plugin](#snmp).* - introduced: 0.10.1 - deprecated: 0.13.1 - tags: [linux, macos, windows, networking] - - name: SNMP Trap id: snmp_trap description: | @@ -2021,14 +1984,6 @@ input: introduced: 1.1.2 tags: [linux, macos, windows, logging] - - name: TCP Listener - id: tcp_listener - description: | - *Deprecated in Telegraf 1.3.0. Use the [Socket Listener input plugin](#socket_listener).* - introduced: 0.11.0 - deprecated: 1.2.1 - tags: [linux, macos, windows, networking, web] - - name: Teamspeak 3 id: teamspeak description: | @@ -2079,14 +2034,6 @@ input: introduced: 0.3.0 tags: [linux, macos, windows, servers, web] - - name: UDP Listener - id: udp_listener - description: | - *Deprecated in Telegraf 1.3.0. use the [Socket Listener input plugin](#socket_listener).* - introduced: 0.11.0 - deprecated: 1.2.1 - tags: [linux, macos, windows, networking] - - name: Unbound id: unbound description: | @@ -2620,16 +2567,6 @@ output: introduced: 1.3.0 tags: [linux, macos, windows, networking, systems] - - name: Riemann Legacy - id: riemann_legacy - description: | - The Riemann Legacy output plugin will be deprecated in a future release, - see [#1878](https://github.com/influxdata/telegraf/issues/1878) for more details & discussion. - link: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/riemann_legacy - introduced: 0.2.3 - deprecated: 1.2.1 - tags: [linux, macos, windows, applications] - - name: Sensu id: sensu description: | diff --git a/layouts/shortcodes/tabs.html b/layouts/shortcodes/tabs.html index 5e0480e46..43c6040a9 100644 --- a/layouts/shortcodes/tabs.html +++ b/layouts/shortcodes/tabs.html @@ -1,6 +1,7 @@ {{ $_hugo_config := `{ "version": 1 }` }} {{ $styleParsed := .Get 0 | default "" }} +{{ $hasStyle := gt (len $styleParsed) 0 }} {{ $style := .Get "style" | default $styleParsed }} -
+
{{ .Inner }}
diff --git a/static/img/influxdb/1-3-cli-1-0-beta.gif b/static/img/influxdb/1-3-cli-1-0-beta.gif deleted file mode 100644 index 8b73dc43e..000000000 Binary files a/static/img/influxdb/1-3-cli-1-0-beta.gif and /dev/null differ diff --git a/static/img/influxdb/1-8-tools-grafana-flux.png b/static/img/influxdb/1-8-tools-grafana-flux.png deleted file mode 100644 index 1a2e0e605..000000000 Binary files a/static/img/influxdb/1-8-tools-grafana-flux.png and /dev/null differ diff --git a/static/img/influxdb/2-0-tools-grafana-influxql.png b/static/img/influxdb/2-0-tools-grafana-influxql.png deleted file mode 100644 index dda2aeacc..000000000 Binary files a/static/img/influxdb/2-0-tools-grafana-influxql.png and /dev/null differ diff --git a/static/img/influxdb/2-2-tools-grafana-influxql.png b/static/img/influxdb/2-2-tools-grafana-influxql.png deleted file mode 100644 index b6e38471d..000000000 Binary files a/static/img/influxdb/2-2-tools-grafana-influxql.png and /dev/null differ diff --git a/static/img/influxdb/2-2-tools-grafana.png b/static/img/influxdb/2-2-tools-grafana.png deleted file mode 100644 index 85edace2f..000000000 Binary files a/static/img/influxdb/2-2-tools-grafana.png and /dev/null differ diff --git a/static/img/influxdb/cloud-tools-grafana-flux.png b/static/img/influxdb/cloud-tools-grafana-flux.png new file mode 100644 index 000000000..ac6e63de0 Binary files /dev/null and b/static/img/influxdb/cloud-tools-grafana-flux.png differ diff --git a/static/img/influxdb/cloud-tools-grafana-influxql.png b/static/img/influxdb/cloud-tools-grafana-influxql.png index f0cd23160..f3e8f7422 100644 Binary files a/static/img/influxdb/cloud-tools-grafana-influxql.png and b/static/img/influxdb/cloud-tools-grafana-influxql.png differ diff --git a/static/img/influxdb/cloud-tools-grafana.png b/static/img/influxdb/cloud-tools-grafana.png deleted file mode 100644 index acbe5f240..000000000 Binary files a/static/img/influxdb/cloud-tools-grafana.png and /dev/null differ diff --git a/static/img/influxdb/clustered-admin-monitoring-dashboard.png b/static/img/influxdb/clustered-admin-monitoring-dashboard.png new file mode 100644 index 000000000..ab0d1284d Binary files /dev/null and b/static/img/influxdb/clustered-admin-monitoring-dashboard.png differ diff --git a/static/img/influxdb/v1-tools-grafana-flux.png b/static/img/influxdb/v1-tools-grafana-flux.png new file mode 100644 index 000000000..1ad98c315 Binary files /dev/null and b/static/img/influxdb/v1-tools-grafana-flux.png differ diff --git a/static/img/influxdb/v1-tools-grafana-influxql.png b/static/img/influxdb/v1-tools-grafana-influxql.png new file mode 100644 index 000000000..80f2372f4 Binary files /dev/null and b/static/img/influxdb/v1-tools-grafana-influxql.png differ diff --git a/static/img/influxdb/v2-tools-grafana-flux.png b/static/img/influxdb/v2-tools-grafana-flux.png new file mode 100644 index 000000000..276a5e516 Binary files /dev/null and b/static/img/influxdb/v2-tools-grafana-flux.png differ diff --git a/static/img/influxdb/v2-tools-grafana-influxql.png b/static/img/influxdb/v2-tools-grafana-influxql.png new file mode 100644 index 000000000..d51a3fee0 Binary files /dev/null and b/static/img/influxdb/v2-tools-grafana-influxql.png differ diff --git a/yarn.lock b/yarn.lock index 716a9d973..ddff450cc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1513,6 +1513,7 @@ spdx-license-ids@^3.0.0: integrity sha512-sh8PWc/ftMqAAdFiBu6Fy6JUOYjqDJBJvIhpfDMyHrr0Rbp5liZqd4TjtQ/RgfLjKFZb+LMx5hpml5qOWy0qvg== "string-width-cjs@npm:string-width@^4.2.0", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: + name string-width-cjs version "4.2.3" resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -1538,6 +1539,7 @@ string_decoder@~1.1.1: safe-buffer "~5.1.0" "strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1: + name strip-ansi-cjs version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== @@ -1579,9 +1581,9 @@ tar-stream@^1.5.2: xtend "^4.0.0" tar@^6.1.15: - version "6.2.0" - resolved "https://registry.yarnpkg.com/tar/-/tar-6.2.0.tgz#b14ce49a79cb1cd23bc9b016302dea5474493f73" - integrity sha512-/Wo7DcT0u5HUV486xg675HtjNd3BXZ6xDbzsCUZPt5iw8bTQ63bP0Raut3mvro9u+CUyq7YQd8Cx55fsZXxqLQ== + version "6.2.1" + resolved "https://registry.yarnpkg.com/tar/-/tar-6.2.1.tgz#717549c541bc3c2af15751bea94b1dd068d4b03a" + integrity sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A== dependencies: chownr "^2.0.0" fs-minipass "^2.0.0" @@ -1712,6 +1714,7 @@ which@^2.0.1: isexe "^2.0.0" "wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0: + name wrap-ansi-cjs version "7.0.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==