From f1d82f4b00b2b7db405ff58195608ed210560bd5 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 28 Jan 2025 10:52:31 -0600 Subject: [PATCH] fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content --- .../management/content/info.yml | 12 - api-docs/generate-api-docs.sh | 147 +- api-docs/{ => influxdb}/cloud/.config.yml | 0 .../cloud/v1-compatibility/content/info.yml | 0 .../v1-compatibility/swaggerV1Compat.yml | 0 .../{ => influxdb}/cloud/v2/content/info.yml | 0 .../cloud/v2/content/servers.yml | 0 .../cloud/v2/content/tag-groups.yml | 0 api-docs/{ => influxdb}/cloud/v2/ref.yml | 0 api-docs/{ => influxdb}/v2/.config.yml | 0 api-docs/{ => influxdb}/v2/content/info.yml | 0 .../{ => influxdb}/v2/content/tag-groups.yml | 0 api-docs/{ => influxdb}/v2/ref.yml | 0 .../v2/v1-compatibility/content/info.yml | 0 .../v2/v1-compatibility/swaggerV1Compat.yml | 0 .../cloud-dedicated/.config.yml | 2 +- .../management/content/info.yml | 12 + .../management/content/servers.yml | 4 +- .../management/content/tag-groups.yml | 0 .../cloud-dedicated/management/openapi.yml | 104 +- .../v1-compatibility/content/info.yml | 6 +- .../v1-compatibility/swaggerV1Compat.yml | 14 +- .../cloud-dedicated/v2/content/info.yml | 6 +- .../cloud-dedicated/v2/content/servers.yml | 4 +- .../cloud-dedicated/v2/content/tag-groups.yml | 0 .../cloud-dedicated/v2/ref.yml | 180 +- .../cloud-serverless}/.config.yml | 2 +- .../v1-compatibility/content/info.yml | 6 +- .../v1-compatibility/swaggerV1Compat.yml | 6 +- .../cloud-serverless/v2/content/info.yml | 6 +- .../cloud-serverless/v2/content/servers.yml | 4 +- .../v2/content/tag-groups.yml | 0 .../cloud-serverless/v2/ref.yml | 512 +- .../clustered}/.config.yml | 2 +- .../v1-compatibility/content/info.yml | 6 +- .../v1-compatibility/swaggerV1Compat.yml | 6 +- .../clustered/v2/content/info.yml | 6 +- .../clustered/v2/content/servers.yml | 4 +- .../clustered/v2/content/tag-groups.yml | 0 api-docs/{ => influxdb3}/clustered/v2/ref.yml | 154 +- .../api/management/_index.html | 848 +++ .../api/v1-compatibility/_index.html | 609 +++ .../cloud-dedicated/api/v2/_index.html | 1002 ++++ .../api/v1-compatibility/_index.html | 579 ++ .../cloud-serverless/api/v2/_index.html | 4673 +++++++++++++++++ .../api/v1-compatibility/_index.html | 579 ++ .../influxdb3/clustered/api/v2/_index.html | 966 ++++ 47 files changed, 9863 insertions(+), 598 deletions(-) delete mode 100644 api-docs/cloud-dedicated/management/content/info.yml rename api-docs/{ => influxdb}/cloud/.config.yml (100%) rename api-docs/{ => influxdb}/cloud/v1-compatibility/content/info.yml (100%) rename api-docs/{ => influxdb}/cloud/v1-compatibility/swaggerV1Compat.yml (100%) rename api-docs/{ => influxdb}/cloud/v2/content/info.yml (100%) rename api-docs/{ => influxdb}/cloud/v2/content/servers.yml (100%) rename api-docs/{ => influxdb}/cloud/v2/content/tag-groups.yml (100%) rename api-docs/{ => influxdb}/cloud/v2/ref.yml (100%) rename api-docs/{ => influxdb}/v2/.config.yml (100%) rename api-docs/{ => influxdb}/v2/content/info.yml (100%) rename api-docs/{ => influxdb}/v2/content/tag-groups.yml (100%) rename api-docs/{ => influxdb}/v2/ref.yml (100%) rename api-docs/{ => influxdb}/v2/v1-compatibility/content/info.yml (100%) rename api-docs/{ => influxdb}/v2/v1-compatibility/swaggerV1Compat.yml (100%) rename api-docs/{ => influxdb3}/cloud-dedicated/.config.yml (83%) create mode 100644 api-docs/influxdb3/cloud-dedicated/management/content/info.yml rename api-docs/{ => influxdb3}/cloud-dedicated/management/content/servers.yml (55%) rename api-docs/{ => influxdb3}/cloud-dedicated/management/content/tag-groups.yml (100%) rename api-docs/{ => influxdb3}/cloud-dedicated/management/openapi.yml (90%) rename api-docs/{ => influxdb3}/cloud-dedicated/v1-compatibility/content/info.yml (70%) rename api-docs/{ => influxdb3}/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml (96%) rename api-docs/{ => influxdb3}/cloud-dedicated/v2/content/info.yml (60%) rename api-docs/{ => influxdb3}/cloud-dedicated/v2/content/servers.yml (58%) rename api-docs/{ => influxdb3}/cloud-dedicated/v2/content/tag-groups.yml (100%) rename api-docs/{ => influxdb3}/cloud-dedicated/v2/ref.yml (88%) rename api-docs/{clustered => influxdb3/cloud-serverless}/.config.yml (81%) rename api-docs/{ => influxdb3}/cloud-serverless/v1-compatibility/content/info.yml (70%) rename api-docs/{ => influxdb3}/cloud-serverless/v1-compatibility/swaggerV1Compat.yml (98%) rename api-docs/{ => influxdb3}/cloud-serverless/v2/content/info.yml (64%) rename api-docs/{ => influxdb3}/cloud-serverless/v2/content/servers.yml (62%) rename api-docs/{ => influxdb3}/cloud-serverless/v2/content/tag-groups.yml (100%) rename api-docs/{ => influxdb3}/cloud-serverless/v2/ref.yml (95%) rename api-docs/{cloud-serverless => influxdb3/clustered}/.config.yml (81%) rename api-docs/{ => influxdb3}/clustered/v1-compatibility/content/info.yml (72%) rename api-docs/{ => influxdb3}/clustered/v1-compatibility/swaggerV1Compat.yml (98%) rename api-docs/{ => influxdb3}/clustered/v2/content/info.yml (63%) rename api-docs/{ => influxdb3}/clustered/v2/content/servers.yml (58%) rename api-docs/{ => influxdb3}/clustered/v2/content/tag-groups.yml (100%) rename api-docs/{ => influxdb3}/clustered/v2/ref.yml (89%) create mode 100644 content/influxdb3/cloud-dedicated/api/management/_index.html create mode 100644 content/influxdb3/cloud-dedicated/api/v1-compatibility/_index.html create mode 100644 content/influxdb3/cloud-dedicated/api/v2/_index.html create mode 100644 content/influxdb3/cloud-serverless/api/v1-compatibility/_index.html create mode 100644 content/influxdb3/cloud-serverless/api/v2/_index.html create mode 100644 content/influxdb3/clustered/api/v1-compatibility/_index.html create mode 100644 content/influxdb3/clustered/api/v2/_index.html diff --git a/api-docs/cloud-dedicated/management/content/info.yml b/api-docs/cloud-dedicated/management/content/info.yml deleted file mode 100644 index 814a15f69..000000000 --- a/api-docs/cloud-dedicated/management/content/info.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: InfluxDB Cloud Dedicated Management API -x-influxdata-short-title: 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/generate-api-docs.sh b/api-docs/generate-api-docs.sh index 22d87c1e8..07d42eda1 100755 --- a/api-docs/generate-api-docs.sh +++ b/api-docs/generate-api-docs.sh @@ -36,27 +36,30 @@ while getopts "hc" opt; do done function generateHtml { - specPath="$1" - product="$2" - productName="$3" - api="$4" - configPath="$5" - isDefault=$6 + local specPath="$1" + local productVersion="$2" + local productName="$3" + local api="$4" + local configPath="$5" + local isDefault=$6 # Use the product name to define the menu for the Hugo template - menu="influxdb_$(echo $product | sed 's/\./_/g;s/-/_/g;')" + local menu="$(echo $productVersion | sed 's/\./_/g;s/-/_/g;s/\//_/g;')" + # Short version name (for old aliases) + # Everything after the last slash + local versionDir=$(echo $productVersion | sed 's/.*\///g;') # Extract the API name--for example, "management" from "management@v2". - apiName=$(echo $api | sed 's/@.*//g;') + local apiName=$(echo $api | sed 's/@.*//g;') # Extract the API version--for example, "v0" from "management@v0". - version=$(echo $api | sed 's/.*@//g;') + local apiVersion=$(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) - menuTitle=$(yq '.x-influxdata-short-title' $product/$apiName/content/info.yml) - description=$(yq '.summary' $product/$apiName/content/info.yml) + local title=$(yq '.title' $productVersion/$apiName/content/info.yml) + local menuTitle=$(yq '.x-influxdata-short-title' $productVersion/$apiName/content/info.yml) + local description=$(yq '.summary' $productVersion/$apiName/content/info.yml) # Define the file name for the Redoc HTML output. - specbundle=redoc-static_index.html + local specbundle=redoc-static_index.html # Define the temporary file for the Hugo template and Redoc HTML. - tmpfile="${product}-${api}_index.tmp" + local tmpfile="${productVersion}-${api}_index.tmp" echo "Bundling $specPath" @@ -75,7 +78,7 @@ function generateHtml { --options.noAutoAuth \ --output=$specbundle \ --templateOptions.description=$description \ - --templateOptions.product="$product" \ + --templateOptions.product="$productVersion" \ --templateOptions.productName="$productName" if [[ $apiName == "v1-compatibility" ]]; then @@ -90,10 +93,10 @@ menu: identifier: api-reference-$apiName weight: 304 aliases: - - /influxdb/$product/api/v1/ + - /influxdb/$versionDir/api/v1/ --- " - elif [[ $version == "0" ]]; then + elif [[ $apiVersion == "0" ]]; then echo $productName $apiName frontmatter="--- title: $title @@ -119,7 +122,7 @@ menu: identifier: api-reference-$apiName weight: 102 aliases: - - /influxdb/$product/api/ + - /influxdb/$versionDir/api/ --- " else @@ -152,68 +155,74 @@ weight: 102 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 + mkdir -p ../content/$productVersion/api/$apiName + mv $tmpfile ../content/$productVersion/api/$apiName/_index.html else - mkdir -p ../content/influxdb/$product/api - mv $tmpfile ../content/influxdb/$product/api/_index.html + mkdir -p ../content/$productVersion/api + mv $tmpfile ../content/$productVersion/api/_index.html fi } # Use a combination of directory names and configuration files to build the API documentation. # Each directory represents a product, and each product directory contains a configuration file that defines APIs and their spec file locations. 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." + local versions + versions="$(ls -d -- */* | grep -v 'node_modules' | grep -v 'openapi')" + for version in $versions; do + # Trim the trailing slash off the directory name + local version="${version%/}" + # Get the version API configuration file. + local configPath="$version/.config.yml" + if [ ! -f "$configPath" ]; then + configPath=".config.yml" fi - # Get default status from the configuration. - isDefault=false - defaultStatus=$(yq e ".apis | .$api | .x-influxdata-default" $configPath) - if [[ $defaultStatus == "true" ]]; then - isDefault=true + echo "Using config $configPath" + # Get the product name from the configuration. + local versionName + versionName=$(yq e '.x-influxdata-product-name' "$configPath") + if [[ -z "$versionName" ]]; then + versionName=InfluxDB fi - - # If the spec file differs from master, regenerate the HTML. - update=0 - if [[ $generate_changed == 0 ]]; then - diff=$(git diff --name-status master -- ${specPath}) - if [[ -z "$diff" ]]; then - update=1 + # Get an array of API names (keys) from the configuration file + local apis + apis=$(yq e '.apis | keys | .[]' "$configPath") + # Read each element of the apis array + while IFS= read -r api; do + echo "======Building $version $api======" + # Get the spec file path from the configuration. + local specRootPath + specRootPath=$(yq e ".apis | .$api | .root" "$configPath") + # Check that the YAML spec file exists. + local specPath + specPath="$version/$specRootPath" + if [ -d "$specPath" ] || [ ! -f "$specPath" ]; then + echo "OpenAPI spec $specPath doesn't exist." + fi + # Get default status from the configuration. + local isDefault=false + local defaultStatus + defaultStatus=$(yq e ".apis | .$api | .x-influxdata-default" "$configPath") + if [[ $defaultStatus == "true" ]]; then + isDefault=true fi - fi - if [[ $update -eq 0 ]]; then - echo "Regenerating $product $api" - generateHtml "$specPath" "$product" "$productName" "$api" "$configPath" $isDefault - fi - done <<< "$apis" -done + # If the spec file differs from master, regenerate the HTML. + local update=0 + if [[ $generate_changed == 0 ]]; then + local diff + diff=$(git diff --name-status master -- "${specPath}") + if [[ -z "$diff" ]]; then + update=1 + fi + fi + + if [[ $update -eq 0 ]]; then + echo "Regenerating $version $api" + generateHtml "$specPath" "$version" "$versionName" "$api" "$configPath" "$isDefault" + fi + echo "========Done with $version $api========" + done <<< "$apis" + done } build diff --git a/api-docs/cloud/.config.yml b/api-docs/influxdb/cloud/.config.yml similarity index 100% rename from api-docs/cloud/.config.yml rename to api-docs/influxdb/cloud/.config.yml diff --git a/api-docs/cloud/v1-compatibility/content/info.yml b/api-docs/influxdb/cloud/v1-compatibility/content/info.yml similarity index 100% rename from api-docs/cloud/v1-compatibility/content/info.yml rename to api-docs/influxdb/cloud/v1-compatibility/content/info.yml diff --git a/api-docs/cloud/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml similarity index 100% rename from api-docs/cloud/v1-compatibility/swaggerV1Compat.yml rename to api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/cloud/v2/content/info.yml b/api-docs/influxdb/cloud/v2/content/info.yml similarity index 100% rename from api-docs/cloud/v2/content/info.yml rename to api-docs/influxdb/cloud/v2/content/info.yml diff --git a/api-docs/cloud/v2/content/servers.yml b/api-docs/influxdb/cloud/v2/content/servers.yml similarity index 100% rename from api-docs/cloud/v2/content/servers.yml rename to api-docs/influxdb/cloud/v2/content/servers.yml diff --git a/api-docs/cloud/v2/content/tag-groups.yml b/api-docs/influxdb/cloud/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud/v2/content/tag-groups.yml rename to api-docs/influxdb/cloud/v2/content/tag-groups.yml diff --git a/api-docs/cloud/v2/ref.yml b/api-docs/influxdb/cloud/v2/ref.yml similarity index 100% rename from api-docs/cloud/v2/ref.yml rename to api-docs/influxdb/cloud/v2/ref.yml diff --git a/api-docs/v2/.config.yml b/api-docs/influxdb/v2/.config.yml similarity index 100% rename from api-docs/v2/.config.yml rename to api-docs/influxdb/v2/.config.yml diff --git a/api-docs/v2/content/info.yml b/api-docs/influxdb/v2/content/info.yml similarity index 100% rename from api-docs/v2/content/info.yml rename to api-docs/influxdb/v2/content/info.yml diff --git a/api-docs/v2/content/tag-groups.yml b/api-docs/influxdb/v2/content/tag-groups.yml similarity index 100% rename from api-docs/v2/content/tag-groups.yml rename to api-docs/influxdb/v2/content/tag-groups.yml diff --git a/api-docs/v2/ref.yml b/api-docs/influxdb/v2/ref.yml similarity index 100% rename from api-docs/v2/ref.yml rename to api-docs/influxdb/v2/ref.yml diff --git a/api-docs/v2/v1-compatibility/content/info.yml b/api-docs/influxdb/v2/v1-compatibility/content/info.yml similarity index 100% rename from api-docs/v2/v1-compatibility/content/info.yml rename to api-docs/influxdb/v2/v1-compatibility/content/info.yml diff --git a/api-docs/v2/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml similarity index 100% rename from api-docs/v2/v1-compatibility/swaggerV1Compat.yml rename to api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml diff --git a/api-docs/cloud-dedicated/.config.yml b/api-docs/influxdb3/cloud-dedicated/.config.yml similarity index 83% rename from api-docs/cloud-dedicated/.config.yml rename to api-docs/influxdb3/cloud-dedicated/.config.yml index 6d7fb6c01..b5f7ea8dc 100644 --- a/api-docs/cloud-dedicated/.config.yml +++ b/api-docs/influxdb3/cloud-dedicated/.config.yml @@ -3,7 +3,7 @@ plugins: extends: - recommended - docs/all -x-influxdata-product-name: InfluxDB v3 Cloud Dedicated +x-influxdata-product-name: InfluxDB 3 Cloud Dedicated apis: management@0: diff --git a/api-docs/influxdb3/cloud-dedicated/management/content/info.yml b/api-docs/influxdb3/cloud-dedicated/management/content/info.yml new file mode 100644 index 000000000..5b533dd20 --- /dev/null +++ b/api-docs/influxdb3/cloud-dedicated/management/content/info.yml @@ -0,0 +1,12 @@ +title: InfluxDB 3 Cloud Dedicated Management API +x-influxdata-short-title: Management API +summary: | + The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. +description: | + The Management API lets you manage an InfluxDB 3 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/influxdb3/cloud-dedicated/management/content/servers.yml similarity index 55% rename from api-docs/cloud-dedicated/management/content/servers.yml rename to api-docs/influxdb3/cloud-dedicated/management/content/servers.yml index 340d273d8..6e97ac280 100644 --- a/api-docs/cloud-dedicated/management/content/servers.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/content/servers.yml @@ -1,8 +1,8 @@ - url: 'https://{baseurl}/api/v0' - description: InfluxDB Cloud Dedicated Management API URL + description: InfluxDB 3 Cloud Dedicated Management API URL variables: baseurl: enum: - 'console.influxdata.com' default: 'console.influxdata.com' - description: InfluxDB Cloud Dedicated Console URL + description: InfluxDB 3 Cloud Dedicated Console URL diff --git a/api-docs/cloud-dedicated/management/content/tag-groups.yml b/api-docs/influxdb3/cloud-dedicated/management/content/tag-groups.yml similarity index 100% rename from api-docs/cloud-dedicated/management/content/tag-groups.yml rename to api-docs/influxdb3/cloud-dedicated/management/content/tag-groups.yml diff --git a/api-docs/cloud-dedicated/management/openapi.yml b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml similarity index 90% rename from api-docs/cloud-dedicated/management/openapi.yml rename to api-docs/influxdb3/cloud-dedicated/management/openapi.yml index 6aa404111..edadccd7f 100644 --- a/api-docs/cloud-dedicated/management/openapi.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/openapi.yml @@ -1,26 +1,26 @@ openapi: 3.1.0 info: - title: InfluxDB Cloud Dedicated Management API + title: InfluxDB 3 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. + The Management API lets you manage an InfluxDB 3 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. + The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a 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 + description: InfluxDB 3 Cloud Dedicated Management API URL variables: baseurl: enum: - console.influxdata.com default: console.influxdata.com - description: InfluxDB Cloud Dedicated Console URL + description: InfluxDB 3 Cloud Dedicated Console URL security: - bearerAuthManagementToken: [] bearerAuthJwt: [] @@ -30,13 +30,13 @@ tags: description: | The InfluxDB Management API endpoints require the following credentials: - - `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). - - `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). - - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb/cloud-dedicated/admin/tokens/management/). + - `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + - `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json). + - `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/). - See how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/). + See how to [create a management token](/influxdb3/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. + By default, management tokens in InfluxDB 3 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 @@ -299,13 +299,13 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [databases](/influxdb3/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 + description: The ID of the cluster to get the [databases](/influxdb3/cloud-dedicated/admin/databases/) for required: true schema: $ref: '#/components/schemas/UuidV4' @@ -320,7 +320,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/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 @@ -401,7 +401,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for required: true schema: $ref: '#/components/schemas/UuidV4' @@ -462,7 +462,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/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 @@ -571,7 +571,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to required: true schema: $ref: '#/components/schemas/UuidV4' @@ -629,7 +629,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/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 @@ -727,7 +727,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to required: true schema: $ref: '#/components/schemas/UuidV4' @@ -783,7 +783,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database table for required: true schema: $ref: '#/components/schemas/UuidV4' @@ -841,7 +841,7 @@ paths: 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 + description: The ID of the [account](/influxdb3/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 @@ -906,13 +906,13 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [database tokens](/influxdb3/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 + description: The ID of the cluster to get the [database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) for required: true schema: $ref: '#/components/schemas/UuidV4' @@ -927,10 +927,10 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to $ref: '#/components/schemas/UuidV4' id: description: The ID of the database token @@ -1004,7 +1004,7 @@ paths: tags: - Database tokens description: | - Create a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for a cluster. + Create a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for a cluster. The token returned on the `accessToken` property in the response can be used to authenticate query and write requests to the cluster. @@ -1019,18 +1019,18 @@ paths: We recommend storing database tokens in a **secure secret store**. For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os). - If you lose a token, [delete the token from InfluxDB](/influxdb/cloud-dedicated/admin/tokens/database/delete/) and create a new one. + If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one. 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the [database token](/influxdb3/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 + description: The ID of the cluster to create the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for required: true schema: $ref: '#/components/schemas/UuidV4' @@ -1078,10 +1078,10 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to $ref: '#/components/schemas/UuidV4' id: description: The ID of the database token @@ -1190,19 +1190,19 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/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 + description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to get required: true schema: $ref: '#/components/schemas/UuidV4' @@ -1215,10 +1215,10 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to $ref: '#/components/schemas/UuidV4' id: description: The ID of the database token @@ -1304,19 +1304,19 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/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 + description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to update required: true schema: $ref: '#/components/schemas/UuidV4' @@ -1371,10 +1371,10 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to $ref: '#/components/schemas/UuidV4' id: description: The ID of the database token @@ -1500,19 +1500,19 @@ paths: 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 + description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/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 + description: The ID of the cluster that the [database token](/influxdb3/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 + description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to delete required: true schema: $ref: '#/components/schemas/UuidV4' @@ -1593,7 +1593,7 @@ components: minLength: 1 ClusterDatabaseRetentionPeriod: description: | - The retention period of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) in nanoseconds, if applicable + The retention period of the [cluster database](/influxdb3/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 @@ -1623,7 +1623,7 @@ components: minimum: 1 ClusterDatabasePartitionTemplate: description: | - A template for [partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/) a cluster database. + A template for [partitioning](/influxdb3/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 @@ -1667,7 +1667,7 @@ components: * `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 + When using the default [partitioning](/influxdb3/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 @@ -1769,7 +1769,7 @@ components: tagName: c numberOfBuckets: 10 ClusterDatabaseTableName: - description: The name of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) table + description: The name of the [cluster database](/influxdb3/cloud-dedicated/admin/databases/) table type: string examples: - TableOne @@ -1782,15 +1782,15 @@ components: - 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 + description: A resource value for a [database token](/influxdb3/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 + description: The action the [database token](/influxdb3/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 + description: The resource the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) permission applies to anyOf: - $ref: '#/components/schemas/ClusterDatabaseName' - $ref: '#/components/schemas/DatabaseTokenResourceAllDatabases' @@ -1814,7 +1814,7 @@ components: - action: write resource: '*' DatabaseTokenPermissions: - description: The list of permissions the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) allows + description: The list of permissions the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) allows type: array items: $ref: '#/components/schemas/DatabaseTokenPermission' @@ -1827,7 +1827,7 @@ components: resource: '*' DatabaseTokenCreatedAt: description: | - The date and time that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) was created + The date and time that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) was created Uses RFC3339 format $ref: '#/components/schemas/DateTimeRfc3339' diff --git a/api-docs/cloud-dedicated/v1-compatibility/content/info.yml b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml similarity index 70% rename from api-docs/cloud-dedicated/v1-compatibility/content/info.yml rename to api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml index caa9d1643..5a162fa57 100644 --- a/api-docs/cloud-dedicated/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml @@ -1,6 +1,6 @@ -title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated +title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Dedicated database. +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 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. @@ -9,7 +9,7 @@ description: | #### Related - [InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Cloud Dedicated](/influxdb3/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/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml similarity index 96% rename from api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml rename to api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml index e13b311fe..46de3a497 100644 --- a/api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated + title: InfluxDB v1 HTTP API for InfluxDB 3 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. @@ -10,11 +10,11 @@ info: #### Related - [InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Cloud Dedicated](/influxdb3/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. + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database. servers: - url: / security: @@ -247,9 +247,9 @@ paths: The response is a HTTP `204` status code to inform you the querier is available. - For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. + For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. - To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write). + To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write). This endpoint doesn't require authentication. operationId: GetPing @@ -285,9 +285,9 @@ paths: The response is a HTTP `204` status code to inform you the querier is available. - For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. + For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. - To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write). + To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write). This endpoint doesn't require authentication. diff --git a/api-docs/cloud-dedicated/v2/content/info.yml b/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml similarity index 60% rename from api-docs/cloud-dedicated/v2/content/info.yml rename to api-docs/influxdb3/cloud-dedicated/v2/content/info.yml index 3b927a971..e8b72ba41 100644 --- a/api-docs/cloud-dedicated/v2/content/info.yml +++ b/api-docs/influxdb3/cloud-dedicated/v2/content/info.yml @@ -1,9 +1,9 @@ -title: InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated +title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated x-influxdata-short-title: v2 API -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. +summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). diff --git a/api-docs/cloud-dedicated/v2/content/servers.yml b/api-docs/influxdb3/cloud-dedicated/v2/content/servers.yml similarity index 58% rename from api-docs/cloud-dedicated/v2/content/servers.yml rename to api-docs/influxdb3/cloud-dedicated/v2/content/servers.yml index 4b4503143..6ec2da5f1 100644 --- a/api-docs/cloud-dedicated/v2/content/servers.yml +++ b/api-docs/influxdb3/cloud-dedicated/v2/content/servers.yml @@ -1,8 +1,8 @@ - url: https://{baseurl} - description: InfluxDB Cloud Dedicated API URL + description: InfluxDB 3 Cloud Dedicated API URL variables: baseurl: enum: - 'cluster-id.a.influxdb.io' default: 'cluster-id.a.influxdb.io' - description: InfluxDB Cloud Dedicated URL + description: InfluxDB 3 Cloud Dedicated URL diff --git a/api-docs/cloud-dedicated/v2/content/tag-groups.yml b/api-docs/influxdb3/cloud-dedicated/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud-dedicated/v2/content/tag-groups.yml rename to api-docs/influxdb3/cloud-dedicated/v2/content/tag-groups.yml diff --git a/api-docs/cloud-dedicated/v2/ref.yml b/api-docs/influxdb3/cloud-dedicated/v2/ref.yml similarity index 88% rename from api-docs/cloud-dedicated/v2/ref.yml rename to api-docs/influxdb3/cloud-dedicated/v2/ref.yml index b223b244e..eec0b7d3a 100644 --- a/api-docs/cloud-dedicated/v2/ref.yml +++ b/api-docs/influxdb3/cloud-dedicated/v2/ref.yml @@ -1,25 +1,25 @@ openapi: 3.0.0 info: - title: InfluxDB v2 HTTP API for Cloud Dedicated + title: InfluxDB v2 HTTP API for InfluxDB 3 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 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. + summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database. version: '' servers: - url: https://{baseurl} - description: InfluxDB Cloud Dedicated API URL + description: InfluxDB 3 Cloud Dedicated API URL variables: baseurl: enum: - cluster-id.a.influxdb.io default: cluster-id.a.influxdb.io - description: InfluxDB Cloud Dedicated URL + description: InfluxDB 3 Cloud Dedicated URL security: - BearerAuthentication: [] - TokenAuthentication: [] @@ -29,32 +29,32 @@ tags: - description: | ### Write data - InfluxDB Cloud Dedicated provides the following HTTP API endpoints for writing data: + InfluxDB 3 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. + - **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3. 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: + InfluxDB 3 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/). + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb3/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. + Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3. ### 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/). + 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](/influxdb3/cloud-dedicated/write-data/). - See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). + See how to [use the InfluxDB v2 HTTP API with InfluxDB 3 Cloud Dedicated](/influxdb3/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/). + See how to [use the InfluxDB v1 HTTP API with InfluxDB 3 Cloud Dedicated](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/). name: API compatibility x-traitTag: true - description: | @@ -102,19 +102,19 @@ tags: - 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. + - The `/api/v2/query` endpoint can't query InfluxDB 3 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/) + - [Get started querying InfluxDB](/influxdb3/cloud-dedicated/get-started/query/) + - [Execute queries](/influxdb3/cloud-dedicated/query-data/execute-queries/) name: Query - description: | - See the [**Get Started**](/influxdb/cloud-dedicated/get-started/) tutorial + See the [**Get Started**](/influxdb3/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/) + [**InfluxDB API client libraries and Flight clients**](/influxdb3/cloud-dedicated/reference/client-libraries/) are available to integrate InfluxDB APIs with your application. name: Quick start x-traitTag: true @@ -131,8 +131,8 @@ tags: | `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/)
| + | `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](/influxdb3/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](/influxdb3/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. | @@ -143,7 +143,7 @@ tags: - name: System information endpoints - name: Usage - description: | - Write time series data to [databases](/influxdb/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints. + Write time series data to [databases](/influxdb3/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints. name: Write paths: /ping: @@ -153,9 +153,9 @@ paths: The response is a HTTP `204` status code to inform you the querier is available. - For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. + For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. - To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write). + To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write). This endpoint doesn't require authentication. operationId: GetPing @@ -191,9 +191,9 @@ paths: The response is a HTTP `204` status code to inform you the querier is available. - For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. + For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters. - To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write). + To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write). This endpoint doesn't require authentication. operationId: HeadPing @@ -227,18 +227,18 @@ paths: 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. + Use this endpoint to send data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. - InfluxDB Cloud Dedicated does the following when you send a write request: + InfluxDB 3 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). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/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. - `400 Bad Request`: Some (_when **partial writes** are configured for the cluster_) or all of the data has been rejected. Data that has not been rejected is ingested and queryable. - The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains error details about [rejected points](/influxdb3/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. @@ -247,17 +247,17 @@ paths: #### Write endpoints - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 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/). + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/). + - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/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/) + - [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/) + - [Write data](/influxdb3/cloud-dedicated/write-data/) + - [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/) operationId: PostWrite parameters: - $ref: '#/components/parameters/TraceSpan' @@ -309,7 +309,7 @@ paths: #### Related guides - - [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) + - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/) in: header name: Accept schema: @@ -364,7 +364,7 @@ paths: format: byte type: string description: | - In the request body, provide data in [line protocol format](/influxdb/cloud-dedicated/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -374,12 +374,12 @@ paths: #### Related guides - - [Best practices for optimizing writes](/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](/influxdb3/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. + 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](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -444,7 +444,7 @@ paths: 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). + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp). enum: - application/json - application/csv @@ -478,7 +478,7 @@ paths: schema: type: string - description: | - The [database](/influxdb/cloud-dedicated/admin/databases/) to query data from. + The [database](/influxdb3/cloud-dedicated/admin/databases/) to query data from. in: query name: db required: true @@ -486,7 +486,7 @@ paths: 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). + For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention). in: query name: rp schema: @@ -499,8 +499,8 @@ paths: 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. + Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision. in: query name: epoch schema: @@ -557,9 +557,9 @@ paths: 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) + plan's [adjustable service quotas](/influxdb3/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) + [global limit](/influxdb3/cloud-dedicated/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. headers: Retry-After: @@ -583,19 +583,19 @@ paths: 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. + Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB. - InfluxDB Cloud Dedicated does the following when you send a write request: + InfluxDB 3 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). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/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. + The response body contains error details about [rejected points](/influxdb3/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. @@ -604,17 +604,17 @@ paths: #### Write endpoints - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated. + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 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/). + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/). + - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/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/) + - [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/) + - [Write data](/influxdb3/cloud-dedicated/write-data/) + - [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/) parameters: - $ref: '#/components/parameters/TraceSpan' - description: The InfluxDB 1.x username to authenticate the request. @@ -668,7 +668,7 @@ paths: Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected. If a partial write occurred, then some points from the batch are written and queryable. - The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains details about the [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -710,7 +710,7 @@ paths: The request contained data outside the databaseโ€™s retention period. InfluxDB rejected the batch and wrote no data. - The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points). + The response body contains details about the [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points). '429': description: Token is temporarily over quota. The Retry-After header describes when to try the write again. headers: @@ -928,7 +928,7 @@ components: orgID: description: | An organization ID. - Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -966,12 +966,12 @@ components: org: description: | An organization name. - Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping. type: string orgID: description: | An organization ID. - Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -1009,7 +1009,7 @@ components: $ref: '#/components/schemas/DBRP' type: array DateTimeLiteral: - description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp). + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp). properties: type: $ref: '#/components/schemas/NodeType' @@ -1033,18 +1033,18 @@ components: properties: predicate: description: | - An expression in [delete predicate syntax](/influxdb/cloud-dedicated/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](/influxdb3/cloud-dedicated/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-dedicated/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/cloud-dedicated/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-dedicated/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. format: date-time type: string @@ -1055,7 +1055,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](/influxdb/cloud-dedicated/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](/influxdb3/cloud-dedicated/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). @@ -1067,7 +1067,7 @@ components: #### Related guides - - See [Annotated CSV annotations](/influxdb/cloud-dedicated/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](/influxdb3/cloud-dedicated/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). @@ -1089,7 +1089,7 @@ components: default: RFC3339 description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -1629,7 +1629,7 @@ components: readOnly: true type: string time: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + description: The time ([RFC3339Nano date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. example: 2006-01-02T15:04:05.999999999Z07:00 format: date-time readOnly: true @@ -1824,7 +1824,7 @@ components: type: integer shardGroupDurationSeconds: description: | - The [shard group duration](/influxdb/cloud-dedicated/reference/glossary/#shard). + The [shard group duration](/influxdb3/cloud-dedicated/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud @@ -1833,7 +1833,7 @@ components: #### Related guides - - InfluxDB [shards and shard groups](/influxdb/cloud-dedicated/reference/internals/shards/) + - InfluxDB [shards and shard groups](/influxdb3/cloud-dedicated/reference/internals/shards/) format: int64 type: integer type: @@ -1910,7 +1910,7 @@ components: RetentionRules: description: | Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud-dedicated/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb3/cloud-dedicated/reference/glossary/#retention-period). #### InfluxDB Cloud @@ -1977,8 +1977,8 @@ components: ### Basic authentication scheme Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. - When authenticating requests, InfluxDB Cloud Dedicated checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/). - InfluxDB Cloud Dedicated ignores the `username` part of the decoded credential. + When authenticating requests, InfluxDB 3 Cloud Dedicated checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/). + InfluxDB 3 Cloud Dedicated ignores the `username` part of the decoded credential. ### Syntax @@ -1988,13 +1988,13 @@ components: Replace the following: - - **`[USERNAME]`**: an optional string value (ignored by InfluxDB Cloud Dedicated). - - **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/). + - **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Cloud Dedicated). + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/). - Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header. ### Example - The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb/cloud-dedicated/admin/tokens/): + The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb3/cloud-dedicated/admin/tokens/): ```sh ####################################### @@ -2012,8 +2012,8 @@ components: Replace the following: - - **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database - - **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database + - **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database scheme: basic type: http QuerystringAuthentication: @@ -2027,7 +2027,7 @@ components: ### Query string authentication In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests. - When authenticating requests, InfluxDB Cloud Dedicated checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter. + When authenticating requests, InfluxDB 3 Cloud Dedicated checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter. ### Syntax @@ -2038,7 +2038,7 @@ components: ### Example - The following example shows how to use cURL with query string authentication and a [database token](/influxdb/cloud-dedicated/admin/tokens/). + The following example shows how to use cURL with query string authentication and a [database token](/influxdb3/cloud-dedicated/admin/tokens/). ```sh ####################################### @@ -2057,8 +2057,8 @@ components: Replace the following: - - **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database - - **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database + - **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database BearerAuthentication: type: http scheme: bearer @@ -2092,8 +2092,8 @@ components: ``` For examples and more information, see the following: - - [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests) - - [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/) + - [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests) + - [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/) TokenAuthentication: description: | Use the Token authentication @@ -2124,8 +2124,8 @@ components: ### Related guides - - [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests) - - [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/) + - [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests) + - [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/) in: header name: Authorization type: apiKey diff --git a/api-docs/clustered/.config.yml b/api-docs/influxdb3/cloud-serverless/.config.yml similarity index 81% rename from api-docs/clustered/.config.yml rename to api-docs/influxdb3/cloud-serverless/.config.yml index e1bf4a4af..1c62fc56f 100644 --- a/api-docs/clustered/.config.yml +++ b/api-docs/influxdb3/cloud-serverless/.config.yml @@ -3,7 +3,7 @@ plugins: extends: - recommended - docs/all -x-influxdata-product-name: InfluxDB v3 Clustered +x-influxdata-product-name: InfluxDB 3 Serverless apis: v2@2: diff --git a/api-docs/cloud-serverless/v1-compatibility/content/info.yml b/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml similarity index 70% rename from api-docs/cloud-serverless/v1-compatibility/content/info.yml rename to api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml index 1307b7422..1e2d82d4c 100644 --- a/api-docs/cloud-serverless/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml @@ -1,6 +1,6 @@ -title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless +title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Serverless bucket. +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 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. @@ -9,7 +9,7 @@ description: | #### Related - [InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Cloud Serverless](/influxdb3/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/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml similarity index 98% rename from api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml rename to api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml index 44880f9f3..12332cb35 100644 --- a/api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless + title: InfluxDB v1 HTTP API for InfluxDB 3 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. @@ -10,11 +10,11 @@ info: #### Related - [InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Cloud Serverless](/influxdb3/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. + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket. servers: - url: / security: diff --git a/api-docs/cloud-serverless/v2/content/info.yml b/api-docs/influxdb3/cloud-serverless/v2/content/info.yml similarity index 64% rename from api-docs/cloud-serverless/v2/content/info.yml rename to api-docs/influxdb3/cloud-serverless/v2/content/info.yml index 5aab1cdbb..f175cf3c7 100644 --- a/api-docs/cloud-serverless/v2/content/info.yml +++ b/api-docs/influxdb3/cloud-serverless/v2/content/info.yml @@ -1,9 +1,9 @@ -title: InfluxDB Cloud Serverless API Service +title: InfluxDB 3 Cloud Serverless API Service x-influxdata-short-title: v2 API summary: | - The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket. + The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). diff --git a/api-docs/cloud-serverless/v2/content/servers.yml b/api-docs/influxdb3/cloud-serverless/v2/content/servers.yml similarity index 62% rename from api-docs/cloud-serverless/v2/content/servers.yml rename to api-docs/influxdb3/cloud-serverless/v2/content/servers.yml index 1d0433fb4..35fb9f892 100644 --- a/api-docs/cloud-serverless/v2/content/servers.yml +++ b/api-docs/influxdb3/cloud-serverless/v2/content/servers.yml @@ -1,8 +1,8 @@ - url: https://{baseurl} - description: InfluxDB Cloud Serverless API URL + description: InfluxDB 3 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 + description: InfluxDB 3 Cloud Serverless URL diff --git a/api-docs/cloud-serverless/v2/content/tag-groups.yml b/api-docs/influxdb3/cloud-serverless/v2/content/tag-groups.yml similarity index 100% rename from api-docs/cloud-serverless/v2/content/tag-groups.yml rename to api-docs/influxdb3/cloud-serverless/v2/content/tag-groups.yml diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/influxdb3/cloud-serverless/v2/ref.yml similarity index 95% rename from api-docs/cloud-serverless/v2/ref.yml rename to api-docs/influxdb3/cloud-serverless/v2/ref.yml index 4c6c01654..530c06856 100644 --- a/api-docs/cloud-serverless/v2/ref.yml +++ b/api-docs/influxdb3/cloud-serverless/v2/ref.yml @@ -1,8 +1,8 @@ openapi: 3.0.0 info: - title: InfluxDB Cloud Serverless API Service + title: InfluxDB 3 Cloud Serverless API Service 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). @@ -10,50 +10,50 @@ info: name: MIT url: https://opensource.org/licenses/MIT summary: | - The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket. + The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket. version: '' servers: - url: https://{baseurl} - description: InfluxDB Cloud Serverless API URL + description: InfluxDB 3 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 + description: InfluxDB 3 Cloud Serverless URL security: - TokenAuthentication: [] tags: - description: | ### Write data - InfluxDB Cloud Serverless provides the following HTTP API endpoints for writing data: + InfluxDB 3 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. + for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3. 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: + InfluxDB 3 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. + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb3/cloud-serverless/get-started/query/). + - HTTP API [`/query` request](/influxdb3/cloud-serverless/api/#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3. ### 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/). + 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](/influxdb3/cloud-serverless/write-data/). - See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Serverless](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + See how to [use the InfluxDB v2 HTTP API with InfluxDB 3 Cloud Serverless](/influxdb3/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/). + See how to [use the InfluxDB v1 HTTP API with InfluxDB 3 Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/). name: API compatibility x-traitTag: true - description: | @@ -82,7 +82,7 @@ tags: 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/). + For more information, see [how to assign a token to a specific user](/influxdb3/cloud-serverless/security/tokens/create-token/). To create a user session, use the [`POST /api/v2/signin` endpoint](#operation/PostSignin). ### Related endpoints @@ -92,22 +92,22 @@ tags: ### 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/) + - [Authorize API requests](/influxdb3/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb3/cloud-serverless/security/tokens/) + - [Assign a token to a specific user](/influxdb3/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). + Store your data in InfluxDB [buckets](/influxdb3/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), + have a [retention period](/influxdb3/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/) + - [Manage buckets](/influxdb3/cloud-serverless/admin/buckets/) name: Buckets - name: Cells - name: Checks @@ -120,10 +120,10 @@ tags: | 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/). | + | `bucket` | string | The bucket name or ID ([find your bucket](/influxdb3/cloud-serverless/admin/buckets/view-buckets/). | + | `bucketID` | string | The bucket ID ([find your bucket](/influxdb3/cloud-serverless/admin/buckets/view-buckets/). | + | `org` | string | The organization name or ID ([find your organization](/influxdb3/cloud-serverless/organizations/view-orgs/). | + | `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb3/cloud-serverless/organizations/view-orgs/). | name: Common parameters x-traitTag: true - name: Config @@ -141,7 +141,7 @@ tags: ### Related guides - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) name: DBRPs - description: | Delete data from an InfluxDB bucket. @@ -185,7 +185,7 @@ tags: - name: NotificationEndpoints - name: NotificationRules - description: | - Manage your [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + Manage your [organization](/influxdb3/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. @@ -233,20 +233,20 @@ tags: - description: | Query data stored in a bucket. - - HTTP clients can query the v1 [`/query` endpoint](/influxdb/cloud-serverless/api/#operation/GetLegacyQuery) + - HTTP clients can query the v1 [`/query` endpoint](/influxdb3/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/) + - [Get started querying InfluxDB](/influxdb3/cloud-serverless/get-started/query/) + - [Execute queries](/influxdb3/cloud-serverless/query-data/execute-queries/) name: Query - description: | - See the [**Get started**](/influxdb/cloud-serverless/get-started/) tutorial + See the [**Get started**](/influxdb3/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/) + [**InfluxDB API client libraries and Flight clients**](/influxdb3/cloud-serverless/reference/client-libraries/) are available to integrate InfluxDB with your application. name: Quick start x-traitTag: true @@ -265,7 +265,7 @@ tags: | `201` | Created | Successfully created a resource. The response body may contain details, for example [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) response bodies contain details of partial write failures. | | `204` | No content | The request succeeded. | | `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/)
| + | `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](/influxdb3/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. | @@ -347,12 +347,12 @@ tags: ### Related guides - - [Manage users](/influxdb/cloud-serverless/organizations/users/) + - [Manage users](/influxdb3/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. + Write time series data to [buckets](/influxdb3/cloud-serverless/reference/glossary/#bucket) using InfluxDB v1 or v2 endpoints. name: Write paths: /api/v2: @@ -390,7 +390,7 @@ paths: To limit which authorizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all authorizations. - InfluxDB Cloud Serverless doesn't expose [API token](/influxdb/cloud-serverless/reference/glossary/#token) + InfluxDB 3 Cloud Serverless doesn't expose [API token](/influxdb3/cloud-serverless/reference/glossary/#token) values in `GET /api/v2/authorizations` responses; returns `token: redacted` for all authorizations. @@ -404,38 +404,38 @@ paths: #### Related guides - - [View tokens](/influxdb/cloud-serverless/security/tokens/view-tokens/) + - [View tokens](/influxdb3/cloud-serverless/security/tokens/view-tokens/) operationId: GetAuthorizations parameters: - $ref: '#/components/parameters/TraceSpan' - description: | A user ID. - Only returns authorizations scoped to the specified [user](/influxdb/cloud-serverless/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](/influxdb3/cloud-serverless/reference/glossary/#user). in: query name: userID schema: type: string - description: | A user name. - Only returns authorizations scoped to the specified [user](/influxdb/cloud-serverless/reference/glossary/#user). + Only returns authorizations scoped to the specified [user](/influxdb3/cloud-serverless/reference/glossary/#user). in: query name: user schema: type: string - - description: An organization ID. Only returns authorizations that belong to the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + - description: An organization ID. Only returns authorizations that belong to the specified [organization](/influxdb3/cloud-serverless/reference/glossary/#organization). in: query name: orgID schema: type: string - description: | An organization name. - Only returns authorizations that belong to the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + Only returns authorizations that belong to the specified [organization](/influxdb3/cloud-serverless/reference/glossary/#organization). in: query name: org schema: type: string - description: | - An API [token](/influxdb/cloud-serverless/reference/glossary/#token) value. + An API [token](/influxdb3/cloud-serverless/reference/glossary/#token) value. Specifies an authorization by its `token` property value and returns the authorization. @@ -469,7 +469,7 @@ paths: #### InfluxDB OSS - **Warning**: The response body contains authorizations with their - [API token](/influxdb/cloud-serverless/reference/glossary/#token) values in clear text. + [API token](/influxdb3/cloud-serverless/reference/glossary/#token) values in clear text. - If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_, InfluxDB OSS returns authorizations for all organizations in the instance. '400': @@ -489,7 +489,7 @@ paths: post: description: | Creates an authorization and returns the authorization with the - generated API [token](/influxdb/cloud-serverless/reference/glossary/#token). + generated API [token](/influxdb3/cloud-serverless/reference/glossary/#token). Use this endpoint to create an authorization, which generates an API token with permissions to `read` or `write` to a specific resource or `type` of resource. @@ -514,7 +514,7 @@ paths: #### Related guides - - [Create a token](/influxdb/cloud-serverless/security/tokens/create-token/) + - [Create a token](/influxdb3/cloud-serverless/security/tokens/create-token/) operationId: PostAuthorizations parameters: - $ref: '#/components/parameters/TraceSpan' @@ -625,13 +625,13 @@ paths: #### InfluxDB OSS - InfluxDB OSS returns - [API token](/influxdb/cloud-serverless/reference/glossary/#token) values in authorizations. + [API token](/influxdb3/cloud-serverless/reference/glossary/#token) values in authorizations. - If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_, InfluxDB OSS returns authorizations for all organizations in the instance. #### Related guides - - [View tokens](/influxdb/cloud-serverless/security/tokens/view-tokens/) + - [View tokens](/influxdb3/cloud-serverless/security/tokens/view-tokens/) operationId: GetAuthorizationsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -726,19 +726,19 @@ paths: /api/v2/buckets: get: description: | - Lists [buckets](/influxdb/cloud-serverless/reference/glossary/#bucket). + Lists [buckets](/influxdb3/cloud-serverless/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the - [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) associated with the authorization - ([API token](/influxdb/cloud-serverless/reference/glossary/#token)). + ([API token](/influxdb3/cloud-serverless/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - - If you use an _[operator token](/influxdb/cloud-serverless/security/tokens/#operator-token)_ + - If you use an _[operator token](/influxdb3/cloud-serverless/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the @@ -749,11 +749,11 @@ paths: | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | - | Retrieve [_system buckets_](/influxdb/cloud-serverless/reference/internals/system-buckets/) | `read-orgs` | + | Retrieve [_system buckets_](/influxdb3/cloud-serverless/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + - [Manage buckets](/influxdb3/cloud-serverless/admin/buckets/) operationId: GetBuckets parameters: - $ref: '#/components/parameters/TraceSpan' @@ -763,7 +763,7 @@ paths: - description: | An organization name. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). @@ -774,7 +774,7 @@ paths: - description: | An organization ID. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). @@ -853,10 +853,10 @@ paths: --header "Content-Type: application/json" post: description: | - Creates a [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket) + Creates a [bucket](/influxdb3/cloud-serverless/reference/glossary/#bucket) and returns the bucket resource. The default data - [retention period](/influxdb/cloud-serverless/reference/glossary/#retention-period) + [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS @@ -875,8 +875,8 @@ paths: #### Related Guides - - [Create a bucket](/influxdb/cloud-serverless/admin/buckets/create-bucket/) - - [Create bucket CLI reference](/influxdb/cloud-serverless/reference/cli/influx/bucket/create) + - [Create a bucket](/influxdb3/cloud-serverless/admin/buckets/create-bucket/) + - [Create bucket CLI reference](/influxdb3/cloud-serverless/reference/cli/influx/bucket/create) operationId: PostBuckets parameters: - $ref: '#/components/parameters/TraceSpan' @@ -994,7 +994,7 @@ paths: description: | Deletes a bucket and all associated records. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Does the following when you send a delete request: @@ -1008,7 +1008,7 @@ paths: #### Related Guides - - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + - [Manage buckets](/influxdb3/cloud-serverless/admin/buckets/) operationId: DeleteBucketsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1025,7 +1025,7 @@ paths: description: | Success. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - The bucket is queued for deletion. '400': content: @@ -1157,14 +1157,14 @@ paths: Use this endpoint to update properties (`name`, `description`, and `retentionRules`) of a bucket. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Requires the `retentionRules` property in the request body. If you don't provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. #### Related Guides - - [Update a bucket](/influxdb/cloud-serverless/admin/buckets/update-bucket/) + - [Update a bucket](/influxdb3/cloud-serverless/admin/buckets/update-bucket/) operationId: PatchBucketsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1302,7 +1302,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage buckets](/influxdb/cloud-serverless/admin/buckets/) + - [Manage buckets](/influxdb3/cloud-serverless/admin/buckets/) operationId: GetBucketsIDLabels parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1366,7 +1366,7 @@ paths: #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - - [Manage labels in the InfluxDB UI](/influxdb/cloud-serverless/visualize-data/labels/) + - [Manage labels in the InfluxDB UI](/influxdb3/cloud-serverless/visualize-data/labels/) operationId: PostBucketsIDLabels parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1492,10 +1492,10 @@ paths: description: | Lists all users for a bucket. - InfluxDB [users](/influxdb/cloud-serverless/reference/glossary/#user) have + InfluxDB [users](/influxdb3/cloud-serverless/reference/glossary/#user) have permission to access InfluxDB. - [Members](/influxdb/cloud-serverless/reference/glossary/#member) are users in + [Members](/influxdb3/cloud-serverless/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. @@ -1559,18 +1559,18 @@ paths: description: | Add a user to a bucket and return the new user information. - InfluxDB [users](/influxdb/cloud-serverless/reference/glossary/#user) have + InfluxDB [users](/influxdb3/cloud-serverless/reference/glossary/#user) have permission to access InfluxDB. - [Members](/influxdb/cloud-serverless/reference/glossary/#member) are users in + [Members](/influxdb3/cloud-serverless/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - - [Manage users](/influxdb/cloud-serverless/users/) - - [Manage members](/influxdb/cloud-serverless/organizations/members/) + - [Manage users](/influxdb3/cloud-serverless/users/) + - [Manage members](/influxdb3/cloud-serverless/organizations/members/) operationId: PostBucketsIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1650,8 +1650,8 @@ paths: #### Related guides - - [Manage users](/influxdb/cloud-serverless/users/) - - [Manage members](/influxdb/cloud-serverless/organizations/members/) + - [Manage users](/influxdb3/cloud-serverless/users/) + - [Manage members](/influxdb3/cloud-serverless/organizations/members/) operationId: DeleteBucketsIDMembersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1692,13 +1692,13 @@ paths: /api/v2/buckets/{bucketID}/owners: get: description: | - Lists all [owners](/influxdb/cloud-serverless/reference/glossary/#owner) + Lists all [owners](/influxdb3/cloud-serverless/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. - InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. #### Limitations @@ -1766,14 +1766,14 @@ paths: - Buckets post: description: | - Adds an owner to a bucket and returns the [owners](/influxdb/cloud-serverless/reference/glossary/#owner) + Adds an owner to a bucket and returns the [owners](/influxdb3/cloud-serverless/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. - InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. #### Limitations @@ -1792,7 +1792,7 @@ paths: #### Related guides - - [Manage users](/influxdb/cloud-serverless/users/) + - [Manage users](/influxdb3/cloud-serverless/users/) operationId: PostBucketsIDOwners parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1871,7 +1871,7 @@ paths: Use this endpoint to remove a user's `owner` role for a bucket. - InfluxDB Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless uses [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign resource permissions; doesn't use `owner` and `member` roles. #### Limitations @@ -1891,7 +1891,7 @@ paths: #### Related guides - - [Manage users](/influxdb/cloud-serverless/users/) + - [Manage users](/influxdb3/cloud-serverless/users/) operationId: DeleteBucketsIDOwnersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -1933,7 +1933,7 @@ paths: get: description: | Lists _explicit_ - [schemas](/influxdb/cloud-serverless/reference/glossary/#schema) + [schemas](/influxdb3/cloud-serverless/reference/glossary/#schema) (`"schemaType": "explicit"`) for a bucket. _Explicit_ schemas are used to enforce column names, tags, fields, and data @@ -2012,7 +2012,7 @@ paths: - Bucket Schemas post: description: | - Creates an _explicit_ measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema) + Creates an _explicit_ measurement [schema](/influxdb3/cloud-serverless/reference/glossary/#schema) for a bucket. _Explicit_ schemas are used to enforce column names, tags, fields, and data @@ -2148,7 +2148,7 @@ paths: /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}: get: description: | - Retrieves an explicit measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema). + Retrieves an explicit measurement [schema](/influxdb3/cloud-serverless/reference/glossary/#schema). operationId: getMeasurementSchema parameters: - description: | @@ -2204,7 +2204,7 @@ paths: - Bucket Schemas patch: description: | - Updates a measurement [schema](/influxdb/cloud-serverless/reference/glossary/#schema). + Updates a measurement [schema](/influxdb3/cloud-serverless/reference/glossary/#schema). Use this endpoint to update the fields (`name`, `type`, and `dataType`) of a measurement schema. @@ -2215,7 +2215,7 @@ paths: #### Related guides - - [Manage bucket schemas](/influxdb/cloud-serverless/admin/buckets/bucket-schema/). + - [Manage bucket schemas](/influxdb3/cloud-serverless/admin/buckets/bucket-schema/). - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/). operationId: updateMeasurementSchema parameters: @@ -2336,7 +2336,7 @@ paths: #### Related guide - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) operationId: GetDBRPs parameters: - $ref: '#/components/parameters/TraceSpan' @@ -2447,7 +2447,7 @@ paths: #### Related guide - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) operationId: PostDBRP parameters: - $ref: '#/components/parameters/TraceSpan' @@ -2462,7 +2462,7 @@ paths: Note that _`retention_policy`_ is a required parameter in the request body. The value of _`retention_policy`_ can be any arbitrary `string` name or value, with the default value commonly set as `autogen`. - The value of _`retention_policy`_ isn't a [retention_policy](/influxdb/cloud-serverless/reference/glossary/#retention-policy-rp) + The value of _`retention_policy`_ isn't a [retention_policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) required: true responses: '201': @@ -2532,7 +2532,7 @@ paths: #### Related guide - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) operationId: DeleteDBRPID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -2595,7 +2595,7 @@ paths: #### Related guide - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) operationId: GetDBRPsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -2704,7 +2704,7 @@ paths: #### Related guide - - [Database and retention policy mapping](/influxdb/cloud-serverless/reference/api/influxdb-1x/dbrp/) + - [Database and retention policy mapping](/influxdb3/cloud-serverless/reference/api/influxdb-1x/dbrp/) required: true responses: '200': @@ -2770,19 +2770,19 @@ paths: description: | Deletes data from a bucket. - **NOTE**: This endpoint has been **disabled** for InfluxDB Cloud Serverless organizations. - See how to [**delete data**](/influxdb/cloud-serverless/write-data/delete-data/). + **NOTE**: This endpoint has been **disabled** for InfluxDB 3 Cloud Serverless organizations. + See how to [**delete data**](/influxdb3/cloud-serverless/write-data/delete-data/). #### Related guides - - [Delete data](/influxdb/cloud-serverless/write-data/delete-data/) + - [Delete data](/influxdb3/cloud-serverless/write-data/delete-data/) operationId: PostDelete parameters: - $ref: '#/components/parameters/TraceSpan' - description: | An organization name or ID. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. in: query @@ -2802,7 +2802,7 @@ paths: - description: | An organization ID. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. in: query @@ -2835,8 +2835,8 @@ paths: responses: '204': description: | - **NOTE**: This endpoint has been **disabled** for InfluxDB Cloud Serverless organizations. - See how to [**delete data**](/influxdb/cloud-serverless/write-data/delete-data/). + **NOTE**: This endpoint has been **disabled** for InfluxDB 3 Cloud Serverless organizations. + See how to [**delete data**](/influxdb3/cloud-serverless/write-data/delete-data/). '400': content: application/json: @@ -2900,13 +2900,13 @@ paths: /api/v2/orgs: get: description: | - Lists [organizations](/influxdb/cloud-serverless/reference/glossary/#organization/). + Lists [organizations](/influxdb3/cloud-serverless/reference/glossary/#organization/). - InfluxDB Cloud Serverless only returns the organization that owns the token passed in the request. + InfluxDB 3 Cloud Serverless only returns the organization that owns the token passed in the request. #### Related guides - - [View organizations](/influxdb/cloud-serverless/organizations/view-orgs/) + - [View organizations](/influxdb3/cloud-serverless/organizations/view-orgs/) operationId: GetOrgs parameters: - $ref: '#/components/parameters/TraceSpan' @@ -2977,14 +2977,14 @@ paths: - Organizations post: description: | - Creates an [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + Creates an [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) and returns the newly created organization. - InfluxDB Cloud Serverless doesn't allow you to use this endpoint to create organizations. + InfluxDB 3 Cloud Serverless doesn't allow you to use this endpoint to create organizations. #### Related guides - - [Manage organizations](/influxdb/cloud-serverless/organizations) + - [Manage organizations](/influxdb3/cloud-serverless/organizations) operationId: PostOrgs parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3082,7 +3082,7 @@ paths: #### Related guides - - [Delete organizations](/influxdb/cloud-serverless/organizations/delete-orgs/) + - [Delete organizations](/influxdb3/cloud-serverless/organizations/delete-orgs/) operationId: DeleteOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3141,7 +3141,7 @@ paths: #### Related guides - - [View organizations](/influxdb/cloud-serverless/organizations/view-orgs/) + - [View organizations](/influxdb3/cloud-serverless/organizations/view-orgs/) operationId: GetOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3210,7 +3210,7 @@ paths: #### Related Guides - - [Update an organization](/influxdb/cloud-serverless/organizations/update-org/) + - [Update an organization](/influxdb3/cloud-serverless/organizations/update-org/) operationId: PatchOrgsID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3286,7 +3286,7 @@ paths: description: | Lists all users that belong to an organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: GetOrgsIDMembers parameters: @@ -3359,7 +3359,7 @@ paths: description: | Add a user to an organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: PostOrgsIDMembers parameters: @@ -3436,7 +3436,7 @@ paths: description: | Removes a member from an organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: DeleteOrgsIDMembersID parameters: @@ -3478,7 +3478,7 @@ paths: description: | Lists all owners of an organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: GetOrgsIDOwners parameters: @@ -3528,7 +3528,7 @@ paths: description: | Adds an owner to an organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: PostOrgsIDOwners parameters: @@ -3595,10 +3595,10 @@ paths: /api/v2/orgs/{orgID}/owners/{userID}: delete: description: | - Removes an [owner](/influxdb/cloud-serverless/reference/glossary/#owner) from + Removes an [owner](/influxdb3/cloud-serverless/reference/glossary/#owner) from the organization. - InfluxDB Cloud Serverless doesn't use `owner` and `member` roles. + InfluxDB 3 Cloud Serverless doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to manage resource permissions. operationId: DeleteOrgsIDOwnersID parameters: @@ -3760,7 +3760,7 @@ paths: schema: type: string - description: | - Earliest time ([unix timestamp format](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. + Earliest time ([unix timestamp format](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. in: query name: start required: true @@ -3768,7 +3768,7 @@ paths: format: unix timestamp type: integer - description: | - Latest time ([unix timestamp format](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. + Latest time ([unix timestamp format](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp)) to include in results. in: query name: stop required: false @@ -3814,9 +3814,9 @@ paths: description: | Retrieves data from buckets. - This endpoint isn't supported in InfluxDB Cloud Serverless. + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + See how to [query data](/influxdb3/cloud-serverless/query-data/). operationId: PostQuery parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3840,7 +3840,7 @@ paths: - description: | An organization name or ID. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. in: query @@ -3850,7 +3850,7 @@ paths: - description: | An organization ID. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Doesn't use the `org` parameter or `orgID` parameter. in: query @@ -3873,8 +3873,8 @@ paths: schema: type: string description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). headers: Content-Encoding: description: Lists encodings (usually compression algorithms) that have been applied to the response payload. @@ -3915,11 +3915,11 @@ paths: $ref: '#/components/responses/ResourceNotFoundError' '429': description: | - #### InfluxDB Cloud Serverless: + #### InfluxDB 3 Cloud Serverless: - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) + plan's [adjustable service quotas](/influxdb3/cloud-serverless/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits). + [global limit](/influxdb3/cloud-serverless/account-management/limits/#global-limits). headers: Retry-After: description: Non-negative decimal integer indicating seconds to wait before retrying the request. @@ -3937,8 +3937,8 @@ paths: post: deprecated: true description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). operationId: PostQueryAnalyze parameters: - $ref: '#/components/parameters/TraceSpan' @@ -3981,8 +3981,8 @@ paths: schema: $ref: '#/components/schemas/AnalyzeQueryResponse' description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). '400': content: application/json: @@ -4041,8 +4041,8 @@ paths: post: deprecated: true description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). operationId: PostQueryAst parameters: - $ref: '#/components/parameters/TraceSpan' @@ -4064,8 +4064,8 @@ paths: schema: $ref: '#/components/schemas/ASTResponse' description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). '400': content: application/json: @@ -4104,16 +4104,16 @@ paths: get: deprecated: true description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). operationId: GetQuerySuggestions parameters: - $ref: '#/components/parameters/TraceSpan' responses: '200': description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). '301': content: text/html: @@ -4154,8 +4154,8 @@ paths: get: deprecated: true description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). operationId: GetQuerySuggestionsName parameters: - $ref: '#/components/parameters/TraceSpan' @@ -4169,8 +4169,8 @@ paths: responses: '200': description: | - This endpoint isn't supported in InfluxDB Cloud Serverless. - See how to [query data](/influxdb/cloud-serverless/query-data/). + This endpoint isn't supported in InfluxDB 3 Cloud Serverless. + See how to [query data](/influxdb3/cloud-serverless/query-data/). '500': content: application/json: @@ -4226,7 +4226,7 @@ paths: The offset for pagination. The number of records to skip. - For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](/influxdb3/cloud-serverless/api/#tag/Pagination). in: query name: offset required: false @@ -4814,7 +4814,7 @@ paths: parameters: - description: | An organization ID. - Only returns stacks owned by the specified [organization](/influxdb/cloud-serverless/reference/glossary/#organization). + Only returns stacks owned by the specified [organization](/influxdb3/cloud-serverless/reference/glossary/#organization). #### InfluxDB Cloud @@ -5119,7 +5119,7 @@ paths: /api/v2/tasks: get: description: | - Retrieves a list of [tasks](/influxdb/cloud-serverless/reference/glossary/#task). + Retrieves a list of [tasks](/influxdb3/cloud-serverless/reference/glossary/#task). To limit which tasks are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all tasks up to the default `limit`. @@ -5127,7 +5127,7 @@ paths: parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) name. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) name. Only returns tasks with the specified name. Different tasks may have the same name. in: query @@ -5135,35 +5135,35 @@ paths: schema: type: string - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) ID. Only returns tasks created after the specified task. in: query name: after schema: type: string - description: | - A [user](/influxdb/cloud-serverless/reference/glossary/#user) ID. + A [user](/influxdb3/cloud-serverless/reference/glossary/#user) ID. Only returns tasks owned by the specified user. in: query name: user schema: type: string - description: | - An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. + An [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) name. Only returns tasks owned by the specified organization. in: query name: org schema: type: string - description: | - An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) ID. + An [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) ID. Only returns tasks owned by the specified organization. in: query name: orgID schema: type: string - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) status. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) status. Only returns tasks that have the specified status (`active` or `inactive`). in: query name: status @@ -5173,7 +5173,7 @@ paths: - inactive type: string - description: | - The maximum number of [tasks](/influxdb/cloud-serverless/reference/glossary/#task) to return. + The maximum number of [tasks](/influxdb3/cloud-serverless/reference/glossary/#task) to return. Default is `100`. The minimum is `1` and the maximum is `500`. @@ -5212,7 +5212,7 @@ paths: - name type: string - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) type (`basic` or `system`). + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) type (`basic` or `system`). Default is `system`. Specifies the level of detail for tasks in the response. The default (`system`) response contains all the metadata properties for tasks. @@ -5325,7 +5325,7 @@ paths: --header 'Authorization: Token INFLUX_API_TOKEN' post: description: | - Creates a [task](/influxdb/cloud-serverless/reference/glossary/#task) and returns the task. + Creates a [task](/influxdb3/cloud-serverless/reference/glossary/#task) and returns the task. Use this endpoint to create a scheduled task that runs a Flux script. @@ -5470,7 +5470,7 @@ paths: /api/v2/tasks/{taskID}: delete: description: | - Deletes a [task](/influxdb/cloud-serverless/reference/glossary/#task) and associated records. + Deletes a [task](/influxdb3/cloud-serverless/reference/glossary/#task) and associated records. Use this endpoint to delete a task and all associated records (task runs, logs, and labels). Once the task is deleted, InfluxDB cancels all scheduled runs of the task. @@ -5479,7 +5479,7 @@ paths: operationId: DeleteTasksID parameters: - $ref: '#/components/parameters/TraceSpan' - - description: A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. Specifies the task to delete. + - description: A [task](/influxdb3/cloud-serverless/reference/glossary/#task) ID. Specifies the task to delete. in: path name: taskID required: true @@ -5503,12 +5503,12 @@ paths: - Tasks get: description: | - Retrieves a [task](/influxdb/cloud-serverless/reference/glossary/#task). + Retrieves a [task](/influxdb3/cloud-serverless/reference/glossary/#task). operationId: GetTasksID parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) ID. Specifies the task to retrieve. in: path name: taskID @@ -5537,7 +5537,7 @@ paths: - Tasks patch: description: | - Updates a [task](/influxdb/cloud-serverless/reference/glossary/#task), + Updates a [task](/influxdb3/cloud-serverless/reference/glossary/#task), and then cancels all scheduled runs of the task. Use this endpoint to set, modify, or clear task properties--for example: `cron`, `name`, `flux`, `status`. @@ -5595,7 +5595,7 @@ paths: parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) ID. Specifies the task to update. in: path name: taskID @@ -5743,7 +5743,7 @@ paths: /api/v2/tasks/{taskID}/logs: get: description: | - Retrieves a list of all logs for a [task](/influxdb/cloud-serverless/reference/glossary/#task). + Retrieves a list of all logs for a [task](/influxdb3/cloud-serverless/reference/glossary/#task). When an InfluxDB task runs, a โ€œrunโ€ record is created in the taskโ€™s history. Logs associated with each run provide relevant log messages, timestamps, and the exit status of the run attempt. @@ -5813,7 +5813,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. - Lists all users that have the `member` role for the specified [task](/influxdb/cloud-serverless/reference/glossary/#task). + Lists all users that have the `member` role for the specified [task](/influxdb3/cloud-serverless/reference/glossary/#task). operationId: GetTasksIDMembers parameters: - $ref: '#/components/parameters/TraceSpan' @@ -5887,7 +5887,7 @@ paths: **Deprecated**: Tasks don't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. - Removes a member from a [task](/influxdb/cloud-serverless/reference/glossary/#task). + Removes a member from a [task](/influxdb3/cloud-serverless/reference/glossary/#task). operationId: DeleteTasksIDMembersID parameters: - $ref: '#/components/parameters/TraceSpan' @@ -6107,7 +6107,7 @@ paths: minimum: 1 type: integer - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after this time. in: query name: afterTime @@ -6115,7 +6115,7 @@ paths: format: date-time type: string - description: | - A timestamp ([RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before this time. in: query name: beforeTime @@ -6181,7 +6181,7 @@ paths: /api/v2/tasks/{taskID}/runs/{runID}: delete: description: | - Cancels a running [task](/influxdb/cloud-serverless/reference/glossary/#task). + Cancels a running [task](/influxdb3/cloud-serverless/reference/glossary/#task). Use this endpoint with InfluxDB OSS to cancel a running task. @@ -6391,7 +6391,7 @@ paths: parameters: - $ref: '#/components/parameters/TraceSpan' - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) ID. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) ID. Specifies the task to retry. in: path name: taskID @@ -6399,7 +6399,7 @@ paths: schema: type: string - description: | - A [task](/influxdb/cloud-serverless/reference/glossary/#task) run ID. + A [task](/influxdb3/cloud-serverless/reference/glossary/#task) run ID. Specifies the task run to retry. To find a task run ID, use the @@ -6922,7 +6922,7 @@ paths: property in the request body. - Some templates may contain queries that use - [secrets](/influxdb/cloud-serverless/reference/glossary/#secret). + [secrets](/influxdb3/cloud-serverless/reference/glossary/#secret). To provide custom secret values, pass the _`secrets`_ property in the request body. Don't expose secret values in templates. @@ -6934,7 +6934,7 @@ paths: #### Rate limits (with InfluxDB Cloud) - Adjustable service quotas apply. - For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/account-management/limits/). + For more information, see [limits and adjustable quotas](/influxdb3/cloud-serverless/account-management/limits/). operationId: ApplyTemplate @@ -7483,18 +7483,18 @@ paths: description: | Writes data to a bucket. - Use this endpoint to send data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint to send data in [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. - InfluxDB Cloud Serverless does the following when you send a write request: + InfluxDB 3 Cloud Serverless does the following when you send a write request: 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/cloud-serverless/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. - `400 Bad Request`: Data from the batch was rejected and not written. The response body indicates if a partial write occurred. - The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains error details about [rejected points](/influxdb3/cloud-serverless/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. @@ -7503,22 +7503,22 @@ paths: #### Write endpoints - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Serverless. + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless. - - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/). - - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-serverless/guides/api-compatibility/v1/). + - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-serverless/guides/api-compatibility/v2/). #### Rate limits _Write_ rate limits apply. - For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/admin/billing/limits/). + For more information, see [limits and adjustable quotas](/influxdb3/cloud-serverless/admin/billing/limits/). #### Related guides - - [Get started writing data](/influxdb/cloud-serverless/get-started/write/) - - [Write data with the InfluxDB API](/influxdb/cloud-serverless/get-started/write/) - - [Best practices for writing data](/influxdb/cloud-serverless/write-data/best-practices/) - - [Troubleshoot issues writing data](/influxdb/cloud-serverless/write-data/troubleshoot/) + - [Get started writing data](/influxdb3/cloud-serverless/get-started/write/) + - [Write data with the InfluxDB API](/influxdb3/cloud-serverless/get-started/write/) + - [Best practices for writing data](/influxdb3/cloud-serverless/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb3/cloud-serverless/write-data/troubleshoot/) operationId: PostWrite parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7563,14 +7563,14 @@ paths: Writes only return a response body if they fail--for example, due to a formatting problem or quota limit. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - 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-serverless/write-data/troubleshoot/) + - [Troubleshoot issues writing data](/influxdb3/cloud-serverless/write-data/troubleshoot/) in: header name: Accept schema: @@ -7582,7 +7582,7 @@ paths: - description: | An organization name or ID. - InfluxDB Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); + InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); doesn't use the `org` parameter or `orgID` parameter. in: query name: org @@ -7593,7 +7593,7 @@ paths: - description: | An organization ID. - InfluxDB Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); + InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); doesn't use the `org` parameter or `orgID` parameter. in: query name: orgID @@ -7625,7 +7625,7 @@ paths: format: byte type: string description: | - In the request body, provide data in [line protocol format](/influxdb/cloud-serverless/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](/influxdb3/cloud-serverless/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -7635,7 +7635,7 @@ paths: #### Related guides - - [Best practices for optimizing writes](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes/) required: true responses: '204': @@ -7645,7 +7645,7 @@ paths: Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected. If a partial write occurred, then some points from the batch are written and queryable. - The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains details about the [rejected points](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -7703,8 +7703,8 @@ paths: #### InfluxDB Cloud - - Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) - or if a **delete** request exceeds the maximum [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits). + - Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb3/cloud-serverless/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum [global limit](/influxdb3/cloud-serverless/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. @@ -7753,8 +7753,8 @@ paths: #### Related guides - - [Use the InfluxDB v1 HTTP API](/influxdb/cloud-serverless/guides/api-compatibility/v1/) - - [Query data](/influxdb/cloud-serverless/query-data/) + - [Use the InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/guides/api-compatibility/v1/) + - [Query data](/influxdb3/cloud-serverless/query-data/) operationId: GetLegacyQuery parameters: - $ref: '#/components/parameters/TraceSpan' @@ -7765,7 +7765,7 @@ paths: description: | Media type that the client can understand. - **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp). enum: - application/json - application/csv @@ -7800,7 +7800,7 @@ paths: type: string - description: | The database to query data from. - This is mapped to an InfluxDB [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket). + This is mapped to an InfluxDB [bucket](/influxdb3/cloud-serverless/reference/glossary/#bucket). For more information, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/). in: query name: db @@ -7809,7 +7809,7 @@ paths: type: string - description: | The retention policy to query data from. - This is mapped to an InfluxDB [bucket](/influxdb/cloud-serverless/reference/glossary/#bucket). + This is mapped to an InfluxDB [bucket](/influxdb3/cloud-serverless/reference/glossary/#bucket). For more information, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/). in: query name: rp @@ -7823,8 +7823,8 @@ paths: type: string - description: | A unix timestamp precision. - Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-serverless/reference/glossary/#unix-timestamp) the specified precision - instead of [RFC3339 timestamps](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) with nanosecond precision. + Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp) with nanosecond precision. in: query name: epoch schema: @@ -7884,9 +7884,9 @@ paths: description: | #### InfluxDB Cloud: - returns this error if a **read** or **write** request exceeds your - plan's [adjustable service quotas](/influxdb/cloud-serverless/account-management/limits/#adjustable-service-quotas) + plan's [adjustable service quotas](/influxdb3/cloud-serverless/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](/influxdb/cloud-serverless/account-management/limits/#global-limits) + [global limit](/influxdb3/cloud-serverless/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. headers: Retry-After: @@ -7910,19 +7910,19 @@ paths: description: | Writes data to a bucket. - Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-serverless/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb3/cloud-serverless/reference/syntax/line-protocol/) format to InfluxDB. - InfluxDB Cloud Serverless does the following when you send a write request: + InfluxDB 3 Cloud Serverless does the following when you send a write request: 1. Validates the request. - 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). + 2. If successful, attempts to [ingest data](/influxdb3/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/cloud-serverless/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`: 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-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains error details about [rejected points](/influxdb3/cloud-serverless/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. @@ -7931,21 +7931,21 @@ paths: #### Write endpoints - The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Serverless. + The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless. - - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v1/). - - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-serverless/guides/api-compatibility/v2/). + - Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-serverless/guides/api-compatibility/v1/). + - Use [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-serverless/guides/api-compatibility/v2/). #### Rate limits _Write_ rate limits apply. - For more information, see [limits and adjustable quotas](/influxdb/cloud-serverless/admin/billing/limits/). + For more information, see [limits and adjustable quotas](/influxdb3/cloud-serverless/admin/billing/limits/). #### Related guides - - [Write data with the InfluxDB API](/influxdb/cloud-serverless/get-started/write/) - - [Optimize writes to InfluxDB](/influxdb/cloud-serverless/write-data/best-practices/optimize-writes/) - - [Troubleshoot issues writing data](/influxdb/cloud-serverless/write-data/troubleshoot/) + - [Write data with the InfluxDB API](/influxdb3/cloud-serverless/get-started/write/) + - [Optimize writes to InfluxDB](/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](/influxdb3/cloud-serverless/write-data/troubleshoot/) parameters: - $ref: '#/components/parameters/TraceSpan' - description: The InfluxDB 1.x username to authenticate the request. @@ -7994,7 +7994,7 @@ paths: 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-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + 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](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -8012,7 +8012,7 @@ paths: description: | All data in the batch is rejected and not written. - The response body contains details about the [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). + The response body contains details about the [rejected points](/influxdb3/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points). content: application/json: examples: @@ -8132,7 +8132,7 @@ components: 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). + For more information about pagination parameters, see [Pagination](/influxdb3/cloud-serverless/api/#tag/Pagination). in: query name: after required: false @@ -8161,7 +8161,7 @@ components: The offset for pagination. The number of records to skip. - For more information about pagination parameters, see [Pagination](/influxdb/cloud-serverless/api/#tag/Pagination). + For more information about pagination parameters, see [Pagination](/influxdb3/cloud-serverless/api/#tag/Pagination). in: query name: offset required: false @@ -8358,14 +8358,14 @@ components: org: description: | The organization name. - Specifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) + Specifies the [organization](/influxdb3/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. + Specifies the [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) that the authorization is scoped to. type: string permissions: description: | @@ -8379,7 +8379,7 @@ components: description: | The API token. The token value is unique to the authorization. - [API tokens](/influxdb/cloud-serverless/reference/glossary/#token) are + [API tokens](/influxdb3/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). @@ -8392,13 +8392,13 @@ components: user: description: | The user name. - Specifies the [user](/influxdb/cloud-serverless/reference/glossary/#user) that owns the authorization. + Specifies the [user](/influxdb3/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. + description: The user ID. Specifies the [user](/influxdb3/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 @@ -8871,7 +8871,7 @@ components: 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. + description: A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true type: string @@ -9124,7 +9124,7 @@ components: orgID: description: | An organization ID. - Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -9162,12 +9162,12 @@ components: org: description: | An organization name. - Identifies the [organization](/influxdb/cloud-serverless/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/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. + Identifies the [organization](/influxdb3/cloud-serverless/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -9349,7 +9349,7 @@ components: $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). + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339nano-timestamp). properties: type: $ref: '#/components/schemas/NodeType' @@ -9414,18 +9414,18 @@ components: properties: predicate: description: | - An expression in [delete predicate syntax](/influxdb/cloud-serverless/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](/influxdb3/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)). + A timestamp ([RFC3339 date/time format](/influxdb3/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)). + A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. format: date-time type: string @@ -9436,7 +9436,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](/influxdb3/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). @@ -9448,7 +9448,7 @@ components: #### Related guides - - See [Annotated CSV annotations](/influxdb/cloud-serverless/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](/influxdb3/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). @@ -9470,7 +9470,7 @@ components: default: RFC3339 description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -10819,7 +10819,7 @@ components: readOnly: true type: string time: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + description: The time ([RFC3339Nano date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. example: 2006-01-02T15:04:05.999999999Z07:00 format: date-time readOnly: true @@ -10971,7 +10971,7 @@ components: type: array name: description: | - The [measurement](/influxdb/cloud-serverless/reference/glossary/#measurement) + The [measurement](/influxdb3/cloud-serverless/reference/glossary/#measurement) name. type: string required: @@ -11305,7 +11305,7 @@ components: 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. + description: A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true type: string @@ -11670,20 +11670,20 @@ components: type: integer shardGroupDurationSeconds: description: | - The [shard group duration](/influxdb/cloud-serverless/reference/glossary/#shard). + The [shard group duration](/influxdb3/cloud-serverless/reference/glossary/#shard). The number of seconds that each shard group covers. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 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). + - Default value depends on the [bucket retention period](/influxdb3/cloud-serverless/reference/internals/shards/#shard-group-duration). #### Related guides - - InfluxDB [shards and shard groups](/influxdb/cloud-serverless/reference/internals/shards/) + - InfluxDB [shards and shard groups](/influxdb3/cloud-serverless/reference/internals/shards/) format: int64 type: integer type: @@ -11813,7 +11813,7 @@ components: [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). + [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period). The InfluxDB `/api/v2` API uses `RetentionRules` to configure the retention period. type: string schemaType: @@ -12107,7 +12107,7 @@ components: The shard group duration. The duration or interval (in seconds) that each shard group covers. - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - Does not use `shardGroupDurationsSeconds`. format: int64 @@ -12123,9 +12123,9 @@ components: 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). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period). - #### InfluxDB Cloud Serverless + #### InfluxDB 3 Cloud Serverless - `retentionRules` is required. @@ -12272,13 +12272,13 @@ components: readOnly: true type: array requestedAt: - description: The time ([RFC3339Nano date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested. + description: The time ([RFC3339Nano date/time format](/influxdb3/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. + description: The time [RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. format: date-time type: string startedAt: @@ -12303,7 +12303,7 @@ components: properties: scheduledFor: description: | - The time [RFC3339 date/time format](/influxdb/cloud-serverless/reference/glossary/#rfc3339-timestamp) + The time [RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp) used for the run's `now` option. Default is the server _now_ time. format: date-time @@ -12892,7 +12892,7 @@ components: 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. + description: The interval ([duration literal](/influxdb3/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: @@ -12919,7 +12919,7 @@ components: 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. + description: A timestamp ([RFC3339 date/time format](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run. format: date-time readOnly: true type: string @@ -12955,17 +12955,17 @@ components: type: string org: description: | - An [organization](/influxdb/cloud-serverless/reference/glossary/#organization) name. + An [organization](/influxdb3/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. + An [organization](/influxdb3/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. + A [user](/influxdb3/cloud-serverless/reference/glossary/#user) ID. Specifies the owner of the task. To find a user ID, you can use the @@ -13396,7 +13396,7 @@ components: The organization owns all resources created by the template. To find your organization, see how to - [view organizations](/influxdb/cloud-serverless/organizations/view-orgs/). + [view organizations](/influxdb3/cloud-serverless/organizations/view-orgs/). type: string remotes: description: | @@ -14718,7 +14718,7 @@ components: 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) + - **`PASSWORD`**: InfluxDB Cloud [API token](/influxdb3/cloud-serverless/reference/glossary/#token) - **`INFLUX_URL`**: your InfluxDB Cloud URL #### Encode credentials with cURL @@ -14791,7 +14791,7 @@ components: Replace the following: - *`INFLUX_URL`*: your InfluxDB Cloud URL - - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud-serverless/reference/glossary/#token) + - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb3/cloud-serverless/reference/glossary/#token) ### Related endpoints @@ -14799,8 +14799,8 @@ components: ### Related guides - - [Authorize API requests](/influxdb/cloud-serverless/api-guide/api_intro/#authentication) - - [Manage API tokens](/influxdb/cloud-serverless/security/tokens/) + - [Authorize API requests](/influxdb3/cloud-serverless/api-guide/api_intro/#authentication) + - [Manage API tokens](/influxdb3/cloud-serverless/security/tokens/) in: header name: Authorization type: apiKey diff --git a/api-docs/cloud-serverless/.config.yml b/api-docs/influxdb3/clustered/.config.yml similarity index 81% rename from api-docs/cloud-serverless/.config.yml rename to api-docs/influxdb3/clustered/.config.yml index 16abffd30..8d5b93bc9 100644 --- a/api-docs/cloud-serverless/.config.yml +++ b/api-docs/influxdb3/clustered/.config.yml @@ -3,7 +3,7 @@ plugins: extends: - recommended - docs/all -x-influxdata-product-name: InfluxDB v3 Serverless +x-influxdata-product-name: InfluxDB 3 Clustered apis: v2@2: diff --git a/api-docs/clustered/v1-compatibility/content/info.yml b/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml similarity index 72% rename from api-docs/clustered/v1-compatibility/content/info.yml rename to api-docs/influxdb3/clustered/v1-compatibility/content/info.yml index 7fbb572ef..80ab8c17f 100644 --- a/api-docs/clustered/v1-compatibility/content/info.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/content/info.yml @@ -1,6 +1,6 @@ -title: InfluxDB v1 HTTP API for InfluxDB Clustered +title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered x-influxdata-short-title: v1 Compatibility API -summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Clustered database. +summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 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. @@ -9,7 +9,7 @@ description: | #### Related - [InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Clustered](/influxdb3/clustered/api/v2/) license: name: MIT url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/clustered/v1-compatibility/swaggerV1Compat.yml b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml similarity index 98% rename from api-docs/clustered/v1-compatibility/swaggerV1Compat.yml rename to api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml index 8f3a1373a..7bfc57eda 100644 --- a/api-docs/clustered/v1-compatibility/swaggerV1Compat.yml +++ b/api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - title: InfluxDB v1 HTTP API for InfluxDB Clustered + title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered 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. @@ -10,11 +10,11 @@ info: #### Related - [InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/) + [InfluxDB `/api/v2` API for InfluxDB 3 Clustered](/influxdb3/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. + summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database. servers: - url: / security: diff --git a/api-docs/clustered/v2/content/info.yml b/api-docs/influxdb3/clustered/v2/content/info.yml similarity index 63% rename from api-docs/clustered/v2/content/info.yml rename to api-docs/influxdb3/clustered/v2/content/info.yml index f1f4be6d3..bc01b768f 100644 --- a/api-docs/clustered/v2/content/info.yml +++ b/api-docs/influxdb3/clustered/v2/content/info.yml @@ -1,8 +1,8 @@ -title: InfluxDB Clustered API Service +title: InfluxDB 3 Clustered API Service x-influxdata-short-title: v2 API -summary: The InfluxDB v2 HTTP API for InfluxDB Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Clustered database. +summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance. This documentation is generated from the [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). diff --git a/api-docs/clustered/v2/content/servers.yml b/api-docs/influxdb3/clustered/v2/content/servers.yml similarity index 58% rename from api-docs/clustered/v2/content/servers.yml rename to api-docs/influxdb3/clustered/v2/content/servers.yml index 5d8667e0b..f3616d33a 100644 --- a/api-docs/clustered/v2/content/servers.yml +++ b/api-docs/influxdb3/clustered/v2/content/servers.yml @@ -1,8 +1,8 @@ - url: https://{baseurl} - description: InfluxDB Clustered API URL + description: InfluxDB 3 Clustered API URL variables: baseurl: enum: - 'cluster-host.com' default: 'cluster-host.com' - description: InfluxDB Clustered URL + description: InfluxDB 3 Clustered URL diff --git a/api-docs/clustered/v2/content/tag-groups.yml b/api-docs/influxdb3/clustered/v2/content/tag-groups.yml similarity index 100% rename from api-docs/clustered/v2/content/tag-groups.yml rename to api-docs/influxdb3/clustered/v2/content/tag-groups.yml diff --git a/api-docs/clustered/v2/ref.yml b/api-docs/influxdb3/clustered/v2/ref.yml similarity index 89% rename from api-docs/clustered/v2/ref.yml rename to api-docs/influxdb3/clustered/v2/ref.yml index b617a7103..71245c9c2 100644 --- a/api-docs/clustered/v2/ref.yml +++ b/api-docs/influxdb3/clustered/v2/ref.yml @@ -1,25 +1,25 @@ openapi: 3.0.0 info: - title: InfluxDB Clustered API Service + title: InfluxDB 3 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. + The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 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. + summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database. servers: - url: https://{baseurl} - description: InfluxDB Clustered API URL + description: InfluxDB 3 Clustered API URL variables: baseurl: enum: - cluster-host.com default: cluster-host.com - description: InfluxDB Clustered URL + description: InfluxDB 3 Clustered URL security: - BearerAuthentication: [] - TokenAuthentication: [] @@ -29,32 +29,32 @@ tags: - description: | ### Write data - InfluxDB Clustered provides the following HTTP API endpoints for writing data: + InfluxDB 3 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. + - **Recommended**: [`/api/v2/write` endpoint](/influxdb3/clustered/api/#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3. + - [`/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3. 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: + InfluxDB 3 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. + - **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb3/clustered/get-started/query/). + - HTTP API [`/query` request](/influxdb3/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL query. + Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3. ### 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/). + The HTTP API [`/api/v2/write` endpoint](/influxdb3/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](/influxdb3/clustered/write-data/). - See how to [use the InfluxDB v2 HTTP API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v2/). + See how to [use the InfluxDB v2 HTTP API with InfluxDB 3 Clustered ](/influxdb3/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. + The HTTP API [`/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite) and [`/query` endpoint](/influxdb3/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/). + See how to [use the InfluxDB v1 HTTP API with InfluxDB 3 Clustered ](/influxdb3/clustered/guides/api-compatibility/v1/). name: API compatibility x-traitTag: true - description: | @@ -100,21 +100,21 @@ tags: - description: | Query data stored in a database. - - HTTP clients can query the v1 [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) + - HTTP clients can query the v1 [`/query` endpoint](/influxdb3/clustered/api/#operation/GetLegacyQuery) using **InfluxQL** and retrieve data in **CSV** or **JSON** format. - - The `/api/v2/query` endpoint can't query InfluxDB Clustered. + - The `/api/v2/query` endpoint can't query InfluxDB 3 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/) + - [Get started querying InfluxDB](/influxdb3/clustered/get-started/query/) + - [Execute queries](/influxdb3/clustered/query-data/execute-queries/) name: Query - description: | - See the [**Get Started**](/influxdb/clustered/get-started/) tutorial + See the [**Get Started**](/influxdb3/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/) + [**InfluxDB API client libraries and Flight clients**](/influxdb3/clustered/reference/client-libraries/) are available to integrate InfluxDB APIs with your application. name: Quick start x-traitTag: true @@ -131,7 +131,7 @@ tags: | `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/)
| + | `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](/influxdb3/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. | @@ -144,7 +144,7 @@ tags: - name: System information endpoints - name: Usage - description: | - Write time series data to [databases](/influxdb/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints. + Write time series data to [databases](/influxdb3/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints. name: Write paths: /ping: @@ -222,12 +222,12 @@ paths: description: | Writes data to a database. - Use this endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB. + Use this endpoint to send data in [line protocol](/influxdb3/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. + 2. If successful, attempts to [ingest the data](/influxdb3/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, @@ -235,10 +235,10 @@ paths: #### 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/) + - [Get started writing data](/influxdb3/clustered/get-started/write/) + - [Write data](/influxdb3/clustered/write-data/) + - [Best practices for writing data](/influxdb3/clustered/write-data/best-practices/) + - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/) operationId: PostWrite parameters: - $ref: '#/components/parameters/TraceSpan' @@ -288,7 +288,7 @@ paths: #### Related guides - - [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) + - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/) in: header name: Accept schema: @@ -343,7 +343,7 @@ paths: format: byte type: string description: | - In the request body, provide data in [line protocol format](/influxdb/clustered/reference/syntax/line-protocol/). + In the request body, provide data in [line protocol format](/influxdb3/clustered/reference/syntax/line-protocol/). To send compressed data, do the following: @@ -353,7 +353,7 @@ paths: #### Related guides - - [Best practices for optimizing writes](/influxdb/clustered/write-data/best-practices/optimize-writes/) + - [Best practices for optimizing writes](/influxdb3/clustered/write-data/best-practices/optimize-writes/) required: true responses: '204': @@ -415,8 +415,8 @@ paths: #### 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 this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas) + or if a **delete** request exceeds the maximum [global limit](/influxdb3/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. @@ -462,7 +462,7 @@ paths: 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). + **Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb3/clustered/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp). enum: - application/json - application/csv @@ -496,7 +496,7 @@ paths: schema: type: string - description: | - The [database](/influxdb/clustered/admin/databases/) to query data from. + The [database](/influxdb3/clustered/admin/databases/) to query data from. in: query name: db required: true @@ -504,7 +504,7 @@ paths: 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). + For more information, see [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). in: query name: rp schema: @@ -517,8 +517,8 @@ paths: 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. + Formats timestamps as [unix (epoch) timestamps](/influxdb3/clustered/reference/glossary/#unix-timestamp) the specified precision + instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision. in: query name: epoch schema: @@ -575,9 +575,9 @@ paths: 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) + plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum - [global limit](/influxdb/clustered/account-management/limits/#global-limits) + [global limit](/influxdb3/clustered/account-management/limits/#global-limits) - returns `Retry-After` header that describes when to try the write again. headers: Retry-After: @@ -649,7 +649,7 @@ paths: description: | Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected. If a partial write occurred, then some points from the batch are written and queryable. - The response body contains details about the [rejected points](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + The response body contains details about the [rejected points](/influxdb3/clustered/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. content: application/json: examples: @@ -710,12 +710,12 @@ paths: 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. + Use this InfluxDB v1-compatible endpoint to send data in [line protocol](/influxdb3/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. + 2. If successful, attempts to [ingest the data](/influxdb3/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, @@ -723,9 +723,9 @@ paths: #### 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/) + - [Write data with the InfluxDB API](/influxdb3/clustered/get-started/write/) + - [Optimize writes to InfluxDB](/influxdb3/clustered/write-data/best-practices/optimize-writes/) + - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/) summary: Write data using the InfluxDB v1 HTTP API tags: - Write @@ -920,7 +920,7 @@ components: orgID: description: | An organization ID. - Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -958,12 +958,12 @@ components: org: description: | An organization name. - Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping. type: string orgID: description: | An organization ID. - Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping. + Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping. type: string retention_policy: description: | @@ -1001,7 +1001,7 @@ components: $ref: '#/components/schemas/DBRP' type: array DateTimeLiteral: - description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp). + description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp). properties: type: $ref: '#/components/schemas/NodeType' @@ -1025,18 +1025,18 @@ components: properties: predicate: description: | - An expression in [delete predicate syntax](/influxdb/clustered/reference/syntax/delete-predicate/). + An expression in [delete predicate syntax](/influxdb3/clustered/reference/syntax/delete-predicate/). example: tag1="value1" and (tag2="value2" and tag3!="value3") type: string start: description: | - A timestamp ([RFC3339 date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp)). The earliest time to delete from. format: date-time type: string stop: description: | - A timestamp ([RFC3339 date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp)). + A timestamp ([RFC3339 date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp)). The latest time to delete from. format: date-time type: string @@ -1047,7 +1047,7 @@ components: Dialect: description: | Options for tabular data output. - Default output is [annotated CSV](/influxdb/clustered/reference/syntax/annotated-csv/#csv-response-format) with headers. + Default output is [annotated CSV](/influxdb3/clustered/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). @@ -1059,7 +1059,7 @@ components: #### Related guides - - See [Annotated CSV annotations](/influxdb/clustered/reference/syntax/annotated-csv/#annotations) for examples and more information. + - See [Annotated CSV annotations](/influxdb3/clustered/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). @@ -1081,7 +1081,7 @@ components: default: RFC3339 description: | The format for timestamps in results. - Default is [`RFC3339` date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp). + Default is [`RFC3339` date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`. #### Example formatted date/time values @@ -1621,7 +1621,7 @@ components: readOnly: true type: string time: - description: The time ([RFC3339Nano date/time format](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. + description: The time ([RFC3339Nano date/time format](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp)) that the event occurred. example: 2006-01-02T15:04:05.999999999Z07:00 format: date-time readOnly: true @@ -1816,7 +1816,7 @@ components: type: integer shardGroupDurationSeconds: description: | - The [shard group duration](/influxdb/clustered/reference/glossary/#shard). + The [shard group duration](/influxdb3/clustered/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud @@ -1825,7 +1825,7 @@ components: #### Related guides - - InfluxDB [shards and shard groups](/influxdb/clustered/reference/internals/shards/) + - InfluxDB [shards and shard groups](/influxdb3/clustered/reference/internals/shards/) format: int64 type: integer type: @@ -1902,7 +1902,7 @@ components: RetentionRules: description: | Retention rules to expire or retain data. - The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/clustered/reference/glossary/#retention-period). + The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb3/clustered/reference/glossary/#retention-period). #### InfluxDB Cloud @@ -1969,8 +1969,8 @@ components: ### Basic authentication scheme Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. - When authenticating requests, InfluxDB Clustered checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/clustered/admin/tokens/#database-tokens). - InfluxDB Clustered ignores the `username` part of the decoded credential. + When authenticating requests, InfluxDB 3 Clustered checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/clustered/admin/tokens/#database-tokens). + InfluxDB 3 Clustered ignores the `username` part of the decoded credential. ### Syntax @@ -1980,13 +1980,13 @@ components: Replace the following: - - **`[USERNAME]`**: an optional string value (ignored by InfluxDB Clustered). - - **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens). + - **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Clustered). + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens). - Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header. ### Example - The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb/clustered/admin/tokens/#database-tokens): + The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb3/clustered/admin/tokens/#database-tokens): ```sh ####################################### @@ -2004,8 +2004,8 @@ components: Replace the following: - - **`DATABASE_NAME`**: your InfluxDB Clustered database - - **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database + - **`DATABASE_NAME`**: your InfluxDB 3 Clustered database + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database scheme: basic type: http QuerystringAuthentication: @@ -2019,7 +2019,7 @@ components: ### Query string authentication In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests. - When authenticating requests, InfluxDB Clustered checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter. + When authenticating requests, InfluxDB 3 Clustered checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter. ### Syntax @@ -2030,7 +2030,7 @@ components: ### Example - The following example shows how to use cURL with query string authentication and a [database token](/influxdb/clustered/admin/tokens/#database-tokens). + The following example shows how to use cURL with query string authentication and a [database token](/influxdb3/clustered/admin/tokens/#database-tokens). ```sh ####################################### @@ -2049,8 +2049,8 @@ components: Replace the following: - - **`DATABASE_NAME`**: your InfluxDB Clustered database - - **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database + - **`DATABASE_NAME`**: your InfluxDB 3 Clustered database + - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database BearerAuthentication: type: http scheme: bearer @@ -2084,8 +2084,8 @@ components: ``` For examples and more information, see the following: - - [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests) - - [Manage tokens](/influxdb/clustered/admin/tokens/) + - [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests) + - [Manage tokens](/influxdb3/clustered/admin/tokens/) TokenAuthentication: description: | Use the Token authentication @@ -2116,8 +2116,8 @@ components: ### Related guides - - [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests) - - [Manage tokens](/influxdb/clustered/admin/tokens/) + - [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests) + - [Manage tokens](/influxdb3/clustered/admin/tokens/) in: header name: Authorization type: apiKey diff --git a/content/influxdb3/cloud-dedicated/api/management/_index.html b/content/influxdb3/cloud-dedicated/api/management/_index.html new file mode 100644 index 000000000..66324e6c2 --- /dev/null +++ b/content/influxdb3/cloud-dedicated/api/management/_index.html @@ -0,0 +1,848 @@ +--- +title: InfluxDB 3 Cloud Dedicated Management API +description: The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance. +layout: api +weight: 102 +menu: + influxdb3_cloud_dedicated: + parent: InfluxDB HTTP API + name: Management API + identifier: api-reference-management +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB 3 Cloud Dedicated Management API

License: MIT

The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.

+

The Management API lets you manage an InfluxDB 3 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.

+

Authentication

The InfluxDB Management API endpoints require the following credentials:

+
    +
  • ACCOUNT_ID: The ID of the account that the cluster belongs to. To view account ID and cluster ID, list cluster details.

    +
  • +
  • CLUSTER_ID: The ID of the cluster that you want to manage. To view account ID and cluster ID, list cluster details.

    +
  • +
  • Authorization MANAGEMENT_TOKEN: the Authorization HTTP header with a management token.

    +

    See how to create a management token.

    +

    By default, management tokens in InfluxDB 3 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.

    +
  • +
+

Database tokens

Manage database read/write tokens for a cluster

+

Get all database tokens for a cluster

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account to get the database tokens for

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster to get the database tokens for

+

Responses

Request samples

HOST="https://console.influxdata.com"
+
+list_tokens () {
+  local response=$( \
+    curl \
+      --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens" \
+      --header "Accept: application/json" \
+      --header "Authorization: Bearer $MANAGEMENT_TOKEN" \
+  )
+  echo "$response"
+}
+

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create a database token

Create a database token for a cluster.

+

The token returned on the accessToken property in the response can be used to authenticate query and write requests to the cluster.

+

Notable behaviors

+
    +
  • InfluxDB might take some time--from a few seconds to a few minutes--to activate and synchronize new tokens. If a new database token doesn't immediately work (you receive a 401 Unauthorized error) for querying or writing, wait and then try your request again.

    +
  • +
  • Token strings are viewable only on token creation and aren't stored by InfluxDB; you can't recover a lost token.

    +
  • +
+

Store secure tokens in a secret store

+

We recommend storing database tokens in a secure secret store. +For example, see how to authenticate Telegraf using tokens in your OS secret store.

+

If you lose a token, delete the token from InfluxDB and create a new one.

+
path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account to create the database token for

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster to create the database token for

+
Request Body schema: application/json
description
required
string (schemas)

The description of the database token

+
Array of objects (schemas)

The list of permissions the database token allows

+

Responses

Request samples

Content type
application/json
Example
{
  • "description": "Limited Access Token",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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",
  • "accessToken": "apiv1_5555555555555555555555555555555555555555555555555555555555555555"
}

Get a database token

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account that the database token belongs to

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster that the database token belongs to

+
tokenId
required
string <uuid> (UuidV4)

The ID of the database token to get

+

Responses

Request samples

HOST="https://console.influxdata.com"
+
+get_token () {
+  local tokenId=$1
+  local response=$( \
+    curl \
+      --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \
+      --header "Accept: application/json" \
+      --header "Authorization: Bearer $MANAGEMENT_TOKEN" \
+  )
+  echo "$response"
+}
+

Response samples

Content type
application/json
Example
{
  • "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"
}

Update a database token

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account that the database token belongs to

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster that the database token belongs to

+
tokenId
required
string <uuid> (UuidV4)

The ID of the database token to update

+
Request Body schema: application/json
description
string (schemas)

The description of the database token

+
Array of objects (schemas)

The list of permissions the database token allows

+

Responses

Request samples

Content type
application/json
Example
{
  • "description": "Updated Limited Access Token",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "accountId": "11111111-1111-4111-8111-111111111111",
  • "clusterId": "33333333-3333-4333-8333-333333333333",
  • "id": "55555555-5555-4555-8555-555555555555",
  • "description": "Updated Limited Access Token",
  • "permissions": [
    ],
  • "createdAt": "2023-12-21T17:32:28.000Z"
}

Delete a database token

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account that the database token belongs to

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster that the database token belongs to

+
tokenId
required
string <uuid> (UuidV4)

The ID of the database token to delete

+

Responses

Request samples

HOST="https://console.influxdata.com"
+
+delete_token () {
+  local tokenId=$1
+  local response=$( \
+    curl \
+      --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/tokens/$tokenId" \
+      --request DELETE \
+      --header "Accept: application/json" \
+      --header "Authorization: Bearer $MANAGEMENT_TOKEN" \
+  )
+  echo "$response"
+}
+

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "bad request"
}

Databases

Manage databases for a cluster

+

Get all databases for a cluster

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account to get the databases for

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster to get the databases for

+

Responses

Request samples

HOST="https://console.influxdata.com"
+
+list_databases () {
+  local response=$( \
+    curl \
+      --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases" \
+      --header "Accept: application/json" \
+      --header "Authorization: Bearer $MANAGEMENT_TOKEN" \
+  )
+  echo "$response"
+}
+

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a database

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account to create the database for

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster to create the database for

+
Request Body schema: application/json
maxColumnsPerTable
integer <int32> (schemas) >= 1
Default: 200

The maximum number of columns per table for the cluster database

+
maxTables
integer <int32> (schemas) >= 1
Default: 500

The maximum number of tables for the cluster database

+
name
required
string (schemas) [ 1 .. 64 ] characters

The name of the cluster database

+
Array of ClusterDatabasePartitionTemplatePartTagValue (object) or ClusterDatabasePartitionTemplatePartTimeFormat (object) or ClusterDatabasePartitionTemplatePartBucket (object) (schemas) [ 1 .. 8 ] items unique

A template for partitioning 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:

+
[
+  {
+    "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=<long string> -> 2023|<long string>#|!|!
  • +
  • time=2023-01-01, c=<long string> -> 2023|!|!|<bucket ID for untruncated long string>
  • +
+

When using the default partitioning 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.

+
retentionPeriod
integer <int64> (schemas) >= 0
Default: 0

The retention period of the cluster database in nanoseconds, if applicable

+

If the retention period is not set or is set to 0, the database will have infinite retention

+

Responses

Request samples

Content type
application/json
Example
{
  • "name": "DatabaseOne"
}

Response samples

Content type
application/json
Example
{
  • "accountId": "11111111-1111-4111-8111-111111111111",
  • "clusterId": "33333333-3333-4333-8333-333333333333",
  • "name": "DatabaseOne",
  • "maxTables": 500,
  • "maxColumnsPerTable": 200,
  • "retentionPeriod": 0
}

Update a database

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account that the database belongs to

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster that the database belongs to

+
databaseName
required
string (ClusterDatabaseName) [ 1 .. 64 ] characters

The name of the database to update

+
Request Body schema: application/json
maxColumnsPerTable
integer <int32> (schemas) >= 1
Default: 200

The maximum number of columns per table for the cluster database

+
maxTables
integer <int32> (schemas) >= 1
Default: 500

The maximum number of tables for the cluster database

+
retentionPeriod
integer <int64> (schemas) >= 0
Default: 0

The retention period of the cluster database in nanoseconds, if applicable

+

If the retention period is not set or is set to 0, the database will have infinite retention

+

Responses

Request samples

Content type
application/json
Example
{
  • "maxTables": 300,
  • "maxColumnsPerTable": 150,
  • "retentionPeriod": 600000000000
}

Response samples

Content type
application/json
Example
{
  • "accountId": "11111111-1111-4111-8111-111111111111",
  • "clusterId": "33333333-3333-4333-8333-333333333333",
  • "name": "DatabaseOne",
  • "maxTables": 300,
  • "maxColumnsPerTable": 150,
  • "retentionPeriod": 600000000000
}

Delete a database

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account that the database belongs to

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster that the database belongs to

+
databaseName
required
string (ClusterDatabaseName) [ 1 .. 64 ] characters

The name of the database to delete

+

Responses

Request samples

HOST="https://console.influxdata.com"
+
+delete_database () {
+  local databaseName=$1
+  local response=$( \
+    curl \
+      --location "$HOST/api/v0/accounts/$ACCOUNT_ID/clusters/$CLUSTER_ID/databases/$databaseName" \
+      --request DELETE \
+      --header "Accept: application/json" \
+      --header "Authorization: Bearer $MANAGEMENT_TOKEN" \
+  )
+  echo "$response"
+}
+

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "bad request"
}

Tables

Manage tables in a database

+

Create a database table

path Parameters
accountId
required
string <uuid> (UuidV4)

The ID of the account to create the database table for

+
clusterId
required
string <uuid> (UuidV4)

The ID of the cluster to create the database table for

+
databaseName
required
string (ClusterDatabaseName) [ 1 .. 64 ] characters

The name of the database to create the database table for

+
Request Body schema: application/json
name
required
string (schemas) non-empty

The name of the cluster database table

+
Array of ClusterDatabasePartitionTemplatePartTagValue (object) or ClusterDatabasePartitionTemplatePartTimeFormat (object) or ClusterDatabasePartitionTemplatePartBucket (object) (schemas) [ 1 .. 8 ] items unique

A template for partitioning 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:

+
[
+  {
+    "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=<long string> -> 2023|<long string>#|!|!
  • +
  • time=2023-01-01, c=<long string> -> 2023|!|!|<bucket ID for untruncated long string>
  • +
+

When using the default partitioning 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.

+

Responses

Request samples

Content type
application/json
Example
{
  • "name": "TableOne"
}

Response samples

Content type
application/json
Example
{
  • "accountId": "11111111-1111-4111-8111-111111111111",
  • "clusterId": "33333333-3333-4333-8333-333333333333",
  • "databaseName": "DatabaseOne",
  • "name": "TableOne"
}
+ + + + + diff --git a/content/influxdb3/cloud-dedicated/api/v1-compatibility/_index.html b/content/influxdb3/cloud-dedicated/api/v1-compatibility/_index.html new file mode 100644 index 000000000..cb1826f4e --- /dev/null +++ b/content/influxdb3/cloud-dedicated/api/v1-compatibility/_index.html @@ -0,0 +1,609 @@ +--- +title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated +description: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database. +layout: api +menu: + influxdb3_cloud_dedicated: + parent: InfluxDB HTTP API + name: v1 Compatibility API + identifier: api-reference-v1-compatibility +weight: 304 +aliases: + - /influxdb/cloud-dedicated/api/v1/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated

License: MIT

The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database.

+

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.

+ +

InfluxDB /api/v2 API for InfluxDB 3 Cloud Dedicated

+

Authentication

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:

+ +

TokenAuthentication

Use the Token authentication +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:

+ +
Security Scheme Type API Key
Header parameter name: Authorization

BasicAuthentication

Use the HTTP Basic authentication +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.

+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuthentication

Use the Querystring authentication +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.

+
Security Scheme Type API Key
Query parameter name: u=&p=

Query

Query using the InfluxDB v1 HTTP API

query Parameters
db
required
string

Bucket to query.

+
p
string

User token.

+
q
string

Defines the influxql query to run.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Specifies how query results should be encoded in the response. Note: With application/csv, query results include epoch timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.

+
Content-Type
string
Value: "application/vnd.influxql"
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

InfluxQL query to execute.

+
string

Responses

Response samples

Content type
No sample

Write

Write time series data into InfluxDB in a V1-compatible format

query Parameters
db
required
string

Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.

+
p
string

User token.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, its value indicates to the database that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}

Ping

Get the status of the instance

Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

+

The response is a HTTP 204 status code to inform you the querier is available.

+

For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.

+

To check the health of ingesters before writing data, send a request to one of the write endpoints.

+

This endpoint doesn't require authentication.

+
Authorizations:
None

Responses

Get the status of the instance

Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

+

The response is a HTTP 204 status code to inform you the querier is available.

+

For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.

+

To check the health of ingesters before writing data, send a request to one of the write endpoints.

+

This endpoint doesn't require authentication.

+
Authorizations:
None

Responses

+ + + + + diff --git a/content/influxdb3/cloud-dedicated/api/v2/_index.html b/content/influxdb3/cloud-dedicated/api/v2/_index.html new file mode 100644 index 000000000..af765539b --- /dev/null +++ b/content/influxdb3/cloud-dedicated/api/v2/_index.html @@ -0,0 +1,1002 @@ +--- +title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated +description: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database. +layout: api +menu: + influxdb3_cloud_dedicated: + parent: InfluxDB HTTP API + name: v2 API + identifier: api-reference-v2 +weight: 102 +aliases: + - /influxdb/cloud-dedicated/api/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated

License: MIT

The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database.

+

The InfluxDB v2 HTTP API lets you use /api/v2 endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.

+

This documentation is generated from the +InfluxDB OpenAPI specification.

+

Quick start

See the Get Started tutorial +to get up and running authenticating with tokens, writing to databases, and querying data.

+

InfluxDB API client libraries and Flight clients +are available to integrate InfluxDB APIs with your application.

+

API compatibility

Write data

+

InfluxDB 3 Cloud Dedicated provides the following HTTP API endpoints for writing data:

+
    +
  • Recommended: /api/v2/write endpoint for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3.
  • +
  • /write endpoint for bringing existing InfluxDB v1 write workloads to InfluxDB 3.
  • +
+

Both endpoints accept the same line protocol format and process data in the same way.

+

Query data

+

InfluxDB 3 Cloud Dedicated provides the following protocols for executing a query:

+ +

InfluxDB v2 compatibility

+

The HTTP API /api/v2/write endpoint works with the Bearer and Token authentication schemes and existing InfluxDB 2.x tools and code for writing data.

+

See how to use the InfluxDB v2 HTTP API with InfluxDB 3 Cloud Dedicated.

+

InfluxDB v1 compatibility

+

The HTTP API /write endpoint and /query endpoint work with InfluxDB 1.x username/password authentication schemes and existing InfluxDB 1.x tools and code.

+

See how to use the InfluxDB v1 HTTP API with InfluxDB 3 Cloud Dedicated.

+

Authentication

Use one of the following schemes to authenticate to the InfluxDB API:

+ +

BasicAuthentication

Basic authentication scheme

+

Use the Authorization header with the Basic scheme to authenticate v1 API /write and /query requests. +When authenticating requests, InfluxDB 3 Cloud Dedicated checks that the password part of the decoded credential is an authorized database token. +InfluxDB 3 Cloud Dedicated ignores the username part of the decoded credential.

+

Syntax

+
Authorization: Basic <base64-encoded [USERNAME]:DATABASE_TOKEN>
+

Replace the following:

+
    +
  • [USERNAME]: an optional string value (ignored by InfluxDB 3 Cloud Dedicated).
  • +
  • DATABASE_TOKEN: a database token.
  • +
  • Encode the [USERNAME]:DATABASE_TOKEN credential using base64 encoding, and then append the encoded string to the Authorization: Basic header.
  • +
+

Example

+

The following example shows how to use cURL with the Basic authentication scheme and a database token:

+
#######################################
+# Use Basic authentication with a database token
+# to query the InfluxDB v1 HTTP API
+#######################################
+# Use the --user option with `--user username:DATABASE_TOKEN` syntax
+#######################################
+
+curl --get "http://cluster-id.a.influxdb.io/query" \
+  --user "":"DATABASE_TOKEN" \
+  --data-urlencode "db=DATABASE_NAME" \
+  --data-urlencode "q=SELECT * FROM MEASUREMENT"
+

Replace the following:

+
    +
  • DATABASE_NAME: your InfluxDB 3 Cloud Dedicated database
  • +
  • DATABASE_TOKEN: a database token with sufficient permissions to the database
  • +
+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuthentication

Use the Querystring authentication +scheme with InfluxDB 1.x API parameters to provide credentials through the query string.

+

Query string authentication

+

In the URL, pass the p query parameter to authenticate /write and /query requests. +When authenticating requests, InfluxDB 3 Cloud Dedicated checks that p (password) is an authorized database token and ignores the u (username) parameter.

+

Syntax

+
https://cluster-id.a.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN
+https://cluster-id.a.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN
+

Example

+

The following example shows how to use cURL with query string authentication and a database token.

+
#######################################
+# Use an InfluxDB 1.x compatible username and password
+# to query the InfluxDB v1 HTTP API
+#######################################
+# Use authentication query parameters:
+#   ?p=DATABASE_TOKEN
+#######################################
+
+curl --get "https://cluster-id.a.influxdb.io/query" \
+  --data-urlencode "p=DATABASE_TOKEN" \
+  --data-urlencode "db=DATABASE_NAME" \
+  --data-urlencode "q=SELECT * FROM MEASUREMENT"
+

Replace the following:

+
    +
  • DATABASE_NAME: your InfluxDB 3 Cloud Dedicated database
  • +
  • DATABASE_TOKEN: a database token with sufficient permissions to the database
  • +
+
Security Scheme Type API Key
Query parameter name: u=&p=

BearerAuthentication

Use the OAuth Bearer authentication +scheme to authenticate to the InfluxDB API.

+

In your API requests, send an Authorization header. +For the header value, provide the word Bearer followed by a space and a database token.

+

Syntax

+
Authorization: Bearer INFLUX_TOKEN
+

Example

+
########################################################
+# Use the Bearer token authentication scheme with /api/v2/write
+# to write data.
+########################################################
+
+curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \
+  --header "Authorization: Bearer DATABASE_TOKEN" \
+  --data-binary 'home,room=kitchen temp=72 1463683075'
+

For examples and more information, see the following:

+ +
Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

TokenAuthentication

Use the Token authentication +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 a database token. +The word Token is case-sensitive.

+

Syntax

+
Authorization: Token INFLUX_API_TOKEN
+

Example

+
########################################################
+# Use the Token authentication scheme with /api/v2/write
+# to write data.
+########################################################
+
+curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \
+  --header "Authorization: Token DATABASE_TOKEN" \
+  --data-binary 'home,room=kitchen temp=72 1463683075'
+ + +
Security Scheme Type API Key
Header parameter name: Authorization

Headers

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HeaderValue typeDescription
AcceptstringThe content type that the client can understand.
AuthorizationstringThe authorization scheme and credential.
Content-LengthintegerThe size of the entity-body, in bytes, sent to the database.
Content-TypestringThe format of the data in the request body.
+

Response codes

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 StatusDescription
200Success
201CreatedOne or more resources are created. The response body contains details about the resource.
204No contentThe request is successful and no data is returned. For example, The /write and /api/v2/write endpoints return this status code if all data in the batch is written and queryable.
400Bad requestInfluxDB 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
  • Authorization header is missing or malformed or the API token doesn't have permission for the operation.
401UnauthorizedMay 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
404Not foundRequested resource was not found. message in the response body provides details about the requested resource.
405Method not allowedThe 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.
422Unprocessable entityRequest data is invalid. code and message in the response body provide details about the problem.
500Internal server error
503Service unavailableServer is temporarily unavailable to process the request. The Retry-After header describes when to try the request again.
+

System information endpoints

Ping

Get the status of the instance

Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

+

The response is a HTTP 204 status code to inform you the querier is available.

+

For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.

+

To check the health of ingesters before writing data, send a request to one of the write endpoints.

+

This endpoint doesn't require authentication.

+
Authorizations:
None

Responses

Get the status of the instance

Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

+

The response is a HTTP 204 status code to inform you the querier is available.

+

For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.

+

To check the health of ingesters before writing data, send a request to one of the write endpoints.

+

This endpoint doesn't require authentication.

+
Authorizations:
None

Responses

Query

Query data stored in a database.

+
    +
  • HTTP clients can query the v1 /query endpoint +using InfluxQL and retrieve data in CSV or JSON format.
  • +
  • The /api/v2/query endpoint can't query InfluxDB 3 Cloud Dedicated.
  • +
  • Flight + gRPC clients can query using SQL or InfluxQL and retrieve data in Arrow format.
  • +
+ + +

Query using the InfluxDB v1 HTTP API

Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats.

+
query Parameters
db
required
string

The database to query data from.

+
epoch
string
Enum: "ns" "u" "ยต" "ms" "s" "m" "h"

A unix timestamp precision. +Formats timestamps as unix (epoch) timestamps the specified precision +instead of RFC3339 timestamps with nanosecond precision.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
q
required
string

The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (;).

+
rp
string

The retention policy to query data from. +For more information, see InfluxQL DBRP naming convention.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Media type that the client can understand.

+

Note: With application/csv, query results include unix timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The content encoding (usually a compression algorithm) that the client can understand.

+
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
No sample

Write

Write time series data to databases using InfluxDB v1 or v2 endpoints.

+

Write data

Writes data to a database.

+

Use this endpoint to send data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Dedicated does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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.
    • +
    • 400 Bad Request: Some (when partial writes are configured for the cluster) or all of the data has been rejected. Data that has not been rejected is ingested and queryable.
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Dedicated.

+ + + +
query Parameters
bucket
required
string

A database name or ID. +InfluxDB writes all points in the batch to the specified database.

+
org
required
string

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.

+
orgID
string

Ignored. An organization ID.

+

InfluxDB ignores this parameter; authorizes the request using the specified database token +and writes data to the specified cluster database.

+
precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for unix timestamps in the line protocol batch.

+
header Parameters
Accept
string
Default: application/json
Value: "application/json"

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.
  • +
+ + +
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

The compression applied to the line protocol in the request payload. +To send a gzip payload, pass Content-Encoding: gzip header.

+
Content-Length
integer

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.

+
Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8"

The format of the data in the request body. +To send a line protocol payload, pass Content-Type: text/plain; charset=utf-8.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

In the request body, provide data in line protocol format.

+

To send compressed data, do the following:

+
    +
  1. Use gzip to compress the line protocol data.
  2. +
  3. In your request, send the compressed data and the +Content-Encoding: gzip header.
  4. +
+ + +
string <byte>

Responses

Request samples

Content type
text/plain
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
+

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "line": 2,
  • "message": "failed to parse line protocol: errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}

Write data using the InfluxDB v1 HTTP API

Writes data to a database.

+

Use this endpoint for InfluxDB v1 parameter compatibility when sending data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Dedicated does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Dedicated.

+ + + +
query Parameters
db
required
string

database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, its value indicates to the database that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
Example
{
  • "code": "invalid",
  • "line": 2,
  • "message": "no data written, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}
+ + + + + diff --git a/content/influxdb3/cloud-serverless/api/v1-compatibility/_index.html b/content/influxdb3/cloud-serverless/api/v1-compatibility/_index.html new file mode 100644 index 000000000..7274eb439 --- /dev/null +++ b/content/influxdb3/cloud-serverless/api/v1-compatibility/_index.html @@ -0,0 +1,579 @@ +--- +title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless +description: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket. +layout: api +menu: + influxdb3_cloud_serverless: + parent: InfluxDB HTTP API + name: v1 Compatibility API + identifier: api-reference-v1-compatibility +weight: 304 +aliases: + - /influxdb/cloud-serverless/api/v1/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless

License: MIT

The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.

+

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.

+ +

InfluxDB /api/v2 API for InfluxDB 3 Cloud Serverless

+

Authentication

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:

+ +

TokenAuthentication

Use the Token authentication +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:

+ +
Security Scheme Type API Key
Header parameter name: Authorization

BasicAuthentication

Use the HTTP Basic authentication +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.

+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuthentication

Use the Querystring authentication +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.

+
Security Scheme Type API Key
Query parameter name: u=&p=

Query

Query using the InfluxDB v1 HTTP API

query Parameters
db
required
string

Bucket to query.

+
p
string

User token.

+
q
string

Defines the influxql query to run.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Specifies how query results should be encoded in the response. Note: With application/csv, query results include epoch timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.

+
Content-Type
string
Value: "application/vnd.influxql"
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

InfluxQL query to execute.

+
string

Responses

Response samples

Content type
No sample

Write

Write time series data into InfluxDB in a V1-compatible format

query Parameters
db
required
string

Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.

+
p
string

User token.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, its value indicates to the database that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}
+ + + + + diff --git a/content/influxdb3/cloud-serverless/api/v2/_index.html b/content/influxdb3/cloud-serverless/api/v2/_index.html new file mode 100644 index 000000000..bafe01ebc --- /dev/null +++ b/content/influxdb3/cloud-serverless/api/v2/_index.html @@ -0,0 +1,4673 @@ +--- +title: InfluxDB 3 Cloud Serverless API Service +description: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket. +layout: api +menu: + influxdb3_cloud_serverless: + parent: InfluxDB HTTP API + name: v2 API + identifier: api-reference-v2 +weight: 102 +aliases: + - /influxdb/cloud-serverless/api/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB 3 Cloud Serverless API Service

License: MIT

The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.

+

The InfluxDB v2 HTTP API lets you use /api/v2 endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.

+

This documentation is generated from the +InfluxDB OpenAPI specification.

+

Quick start

See the Get started tutorial +to get up and running authenticating with tokens, writing to buckets, and querying data.

+

InfluxDB API client libraries and Flight clients +are available to integrate InfluxDB with your application.

+

Authentication

Use one of the following schemes to authenticate to the InfluxDB API:

+ +

BasicAuthentication

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. +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
  • +
  • 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.

+
curl --get "INFLUX_URL/api/v2/signin"
+    --user "EMAIL_ADDRESS":"PASSWORD"
+

Encode credentials with Flux

+

The Flux http.basicAuth() function 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:

+
btoa('EMAIL_ADDRESS:PASSWORD')
+

The output is the following:

+
'VVNFUk5BTUU6UEFTU1dPUkQ='
+

Once you have the Base64-encoded credentials, you can pass them in the +Authorization header--for example:

+
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._

+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

TokenAuthentication

Use the Token authentication +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:

+
curl --request GET "INFLUX_URL/api/v2/buckets" \
+     --header "Authorization: Token INFLUX_API_TOKEN"
+

Replace the following:

+ + + + + +
Security Scheme Type API Key
Header parameter name: Authorization

Supported operations

The following table shows the most common operations that the InfluxDB /api/v2 API supports. +Some resources may support other operations that perform functions more specific to those resources. +For example, you can use the PATCH /api/v2/scripts endpoint to update properties of a script +resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Operation
WriteWrites (POST) data to a bucket.
RunExecutes (POST) a query or script and returns the result.
ListRetrieves (GET) a list of zero or more resources.
CreateCreates (POST) a new resource and returns the resource.
UpdateModifies (PUT) an existing resource to reflect data in your request.
DeleteRemoves (DELETE) a specific resource.
+

Headers

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HeaderValue typeDescription
AcceptstringThe content type that the client can understand.
AuthorizationstringThe authorization scheme and credential.
Content-LengthintegerThe size of the entity-body, in bytes.
Content-TypestringThe format of the data in the request body.
+

Pagination

Some InfluxDB API list operations may support the following query parameters for paginating results:

+ + + + + + + + + + + + + + + + + + + + + + + +
Query parameterValue typeDescription
limitintegerThe maximum number of records to return (after other parameters are applied).
offsetintegerThe number of records to skip (before limit, after other parameters are applied).
afterstring (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:

    +
    curl --request GET "INFLUX_URL/api/v2/buckets?limit=1&offset=50" \
    +    --header "Authorization: Token INFLUX_API_TOKEN"
    +

    The response contains the following:

    +
    {
    +  "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": []
    +}
    +
  • +
+

Response codes

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 StatusDescription
200Success
201CreatedSuccessfully created a resource. The response body may contain details, for example /write and /api/v2/write response bodies contain details of partial write failures.
204No contentThe request succeeded.
400Bad requestInfluxDB 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.
401UnauthorizedMay 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
404Not foundRequested resource was not found. message in the response body provides details about the requested resource.
405Method not allowedThe 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.
413Request entity too largeRequest payload exceeds the size limit.
422Unprocessable entityRequest data is invalid. code and message in the response body provide details about the problem.
429Too many requestsAPI token is temporarily over the request quota. The Retry-After header describes when to try the request again.
500Internal server error
503Service unavailableServer is temporarily unavailable to process the request. The Retry-After header describes when to try the request again.
+

Data I/O endpoints

Write data

Writes data to a bucket.

+

Use this endpoint to send data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Serverless does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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.
    • +
    • 400 Bad Request: Data from the batch was rejected and not written. The response body indicates if a partial write occurred.
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless.

+ +

Rate limits

+

Write rate limits apply. +For more information, see limits and adjustable quotas.

+ + +
Authorizations:
query Parameters
bucket
required
string

A bucket name or ID. +InfluxDB writes all points in the batch to the specified bucket.

+
org
required
string

An organization name or ID.

+

InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); +doesn't use the org parameter or orgID parameter.

+
orgID
string

An organization ID.

+

InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); +doesn't use the org parameter or orgID parameter.

+
precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for unix timestamps in the line protocol batch.

+
header Parameters
Accept
string
Default: application/json
Value: "application/json"

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 3 Cloud Serverless

+
    +
  • Returns only application/json for format and limit errors.
  • +
  • Returns only text/html for some quota limit errors.
  • +
+ + +
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

The compression applied to the line protocol in the request payload. +To send a gzip payload, pass Content-Encoding: gzip header.

+
Content-Length
integer

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.

+
Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8"

The format of the data in the request body. +To send a line protocol payload, pass Content-Type: text/plain; charset=utf-8.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

In the request body, provide data in line protocol format.

+

To send compressed data, do the following:

+
    +
  1. Use gzip to compress the line protocol data.
  2. +
  3. In your request, send the compressed data and the +Content-Encoding: gzip header.
  4. +
+ + +
string <byte>

Responses

Request samples

Content type
text/plain
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
+

Response samples

Content type
application/json
Example
{
  • "code": "invalid",
  • "line": 2,
  • "message": "no data written, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}

Query using the InfluxDB v1 HTTP API

Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats.

+ + +
Authorizations:
query Parameters
db
required
string

The database to query data from. +This is mapped to an InfluxDB bucket. +For more information, see Database and retention policy mapping.

+
epoch
string
Enum: "ns" "u" "ยต" "ms" "s" "m" "h"

A unix timestamp precision. +Formats timestamps as unix (epoch) timestamps the specified precision +instead of RFC3339 timestamps with nanosecond precision.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
q
required
string

The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (;).

+
rp
string

The retention policy to query data from. +This is mapped to an InfluxDB bucket. +For more information, see Database and retention policy mapping.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Media type that the client can understand.

+

Note: With application/csv, query results include unix timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The content encoding (usually a compression algorithm) that the client can understand.

+
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
No sample

Write data using the InfluxDB v1 HTTP API

Writes data to a bucket.

+

Use this endpoint for InfluxDB v1 parameter compatibility when sending data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Serverless does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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: some points in the batch are ingested and queryable, and some points are rejected
    • +
    • 400 Bad Request: all data is rejected
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless.

+ +

Rate limits

+

Write rate limits apply. +For more information, see limits and adjustable quotas.

+ + +
Authorizations:
query Parameters
db
required
string

Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, indicates that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "line": 2,
  • "message": "failed to parse line protocol: errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}

Security and access endpoints

List authorizations

Lists authorizations.

+

To limit which authorizations are returned, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all authorizations.

+

InfluxDB 3 Cloud Serverless doesn't expose API token + values in GET /api/v2/authorizations responses; + returns token: redacted for all authorizations.

+

Required permissions

+

To retrieve an authorization, the request must use an API token that has the +following permissions:

+
    +
  • read-authorizations
  • +
  • read-user for the user that the authorization is scoped to
  • +
+ + +
Authorizations:
query Parameters
org
string

An organization name. +Only returns authorizations that belong to the specified organization.

+
orgID
string

An organization ID. Only returns authorizations that belong to the specified organization.

+
token
string

An API token value. +Specifies an authorization by its token property value +and returns the authorization.

+

InfluxDB OSS

+
    +
  • Doesn't support this parameter. InfluxDB OSS ignores the token= parameter, +applies other parameters, and then returns the result.
  • +
+

Limitations

+
    +
  • The parameter is non-repeatable. If you specify more than one, +only the first one is used. If a resource with the specified +property value doesn't exist, then the response body contains an empty list.
  • +
+
user
string

A user name. +Only returns authorizations scoped to the specified user.

+
userID
string

A user ID. +Only returns authorizations scoped to the specified user.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "links": {}
}

Create an authorization

Creates an authorization and returns the authorization with the +generated API token.

+

Use this endpoint to create an authorization, which generates an API token +with permissions to read or write to a specific resource or type of resource. +The API token is the authorization's token property value.

+

To follow best practices for secure API token generation and retrieval, +InfluxDB enforces access restrictions on API tokens.

+
    +
  • InfluxDB allows access to the API token value immediately after the authorization is created.
  • +
  • You canโ€™t change access (read/write) permissions for an API token after itโ€™s created.
  • +
  • Tokens stop working when the user who created the token is deleted.
  • +
+

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.
  • +
+

Required permissions

+
    +
  • write-authorizations
  • +
  • write-user for the user that the authorization is scoped to
  • +
+ + +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The authorization to create.

+
description
string

A description of the token.

+
orgID
required
string

An organization ID. +Specifies the organization that owns the authorization.

+
required
Array of objects (Permission) non-empty

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.

+
status
string
Default: "active"
Enum: "active" "inactive"

Status of the token. If inactive, InfluxDB rejects requests that use the token.

+
userID
string

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.

+

Responses

Request samples

Content type
application/json
Example

Creates an authorization.

+
{
  • "description": "iot_users read buckets",
  • "orgID": "INFLUX_ORG_ID",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

Delete an authorization

Deletes an authorization.

+

Use the endpoint to delete an API token.

+

If you want to disable an API token instead of delete it, +update the authorization's status to inactive.

+
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "id must have a length of 16 bytes"
}

Retrieve an authorization

Retrieves an authorization.

+

Use this endpoint to retrieve information about an API token, including +the token's permissions and the user that the token is scoped to.

+

InfluxDB OSS

+
    +
  • InfluxDB OSS returns +API token values in authorizations.
  • +
  • If the request uses an operator token, +InfluxDB OSS returns authorizations for all organizations in the instance.
  • +
+ + +
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to retrieve.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

Update an API token to be active or inactive

Updates an authorization.

+

Use this endpoint to set an API token's status to be active or inactive. +InfluxDB rejects requests that use inactive API tokens.

+
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to update.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

In the request body, provide the authorization properties to update.

+
description
string

A description of the token.

+
status
string
Default: "active"
Enum: "active" "inactive"

Status of the token. If inactive, InfluxDB rejects requests that use the token.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

System information endpoints

List all top level routes

Retrieves all the top level routes for the InfluxDB API.

+

Limitations

+
    +
  • Only returns top level routes--for example, the response contains +"tasks":"/api/v2/tasks", and doesn't contain resource-specific routes +for tasks (/api/v2/tasks/TASK_ID/...).
  • +
+
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{}

List all known resources

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Authorizations (API tokens)

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. +To create a user session, use the POST /api/v2/signin endpoint.

+ + + + +

List authorizations

Lists authorizations.

+

To limit which authorizations are returned, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all authorizations.

+

InfluxDB 3 Cloud Serverless doesn't expose API token + values in GET /api/v2/authorizations responses; + returns token: redacted for all authorizations.

+

Required permissions

+

To retrieve an authorization, the request must use an API token that has the +following permissions:

+
    +
  • read-authorizations
  • +
  • read-user for the user that the authorization is scoped to
  • +
+ + +
Authorizations:
query Parameters
org
string

An organization name. +Only returns authorizations that belong to the specified organization.

+
orgID
string

An organization ID. Only returns authorizations that belong to the specified organization.

+
token
string

An API token value. +Specifies an authorization by its token property value +and returns the authorization.

+

InfluxDB OSS

+
    +
  • Doesn't support this parameter. InfluxDB OSS ignores the token= parameter, +applies other parameters, and then returns the result.
  • +
+

Limitations

+
    +
  • The parameter is non-repeatable. If you specify more than one, +only the first one is used. If a resource with the specified +property value doesn't exist, then the response body contains an empty list.
  • +
+
user
string

A user name. +Only returns authorizations scoped to the specified user.

+
userID
string

A user ID. +Only returns authorizations scoped to the specified user.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "links": {}
}

Create an authorization

Creates an authorization and returns the authorization with the +generated API token.

+

Use this endpoint to create an authorization, which generates an API token +with permissions to read or write to a specific resource or type of resource. +The API token is the authorization's token property value.

+

To follow best practices for secure API token generation and retrieval, +InfluxDB enforces access restrictions on API tokens.

+
    +
  • InfluxDB allows access to the API token value immediately after the authorization is created.
  • +
  • You canโ€™t change access (read/write) permissions for an API token after itโ€™s created.
  • +
  • Tokens stop working when the user who created the token is deleted.
  • +
+

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.
  • +
+

Required permissions

+
    +
  • write-authorizations
  • +
  • write-user for the user that the authorization is scoped to
  • +
+ + +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The authorization to create.

+
description
string

A description of the token.

+
orgID
required
string

An organization ID. +Specifies the organization that owns the authorization.

+
required
Array of objects (Permission) non-empty

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.

+
status
string
Default: "active"
Enum: "active" "inactive"

Status of the token. If inactive, InfluxDB rejects requests that use the token.

+
userID
string

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.

+

Responses

Request samples

Content type
application/json
Example

Creates an authorization.

+
{
  • "description": "iot_users read buckets",
  • "orgID": "INFLUX_ORG_ID",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

Delete an authorization

Deletes an authorization.

+

Use the endpoint to delete an API token.

+

If you want to disable an API token instead of delete it, +update the authorization's status to inactive.

+
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "id must have a length of 16 bytes"
}

Retrieve an authorization

Retrieves an authorization.

+

Use this endpoint to retrieve information about an API token, including +the token's permissions and the user that the token is scoped to.

+

InfluxDB OSS

+
    +
  • InfluxDB OSS returns +API token values in authorizations.
  • +
  • If the request uses an operator token, +InfluxDB OSS returns authorizations for all organizations in the instance.
  • +
+ + +
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to retrieve.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

Update an API token to be active or inactive

Updates an authorization.

+

Use this endpoint to set an API token's status to be active or inactive. +InfluxDB rejects requests that use inactive API tokens.

+
Authorizations:
path Parameters
authID
required
string

An authorization ID. Specifies the authorization to update.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

In the request body, provide the authorization properties to update.

+
description
string

A description of the token.

+
status
string
Default: "active"
Enum: "active" "inactive"

Status of the token. If inactive, InfluxDB rejects requests that use the token.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "links": {
    },
  • "org": "string",
  • "orgID": "string",
  • "permissions": [
    ],
  • "token": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "userID": "string"
}

Bucket Schemas

List measurement schemas of a bucket

Lists explicit +schemas +("schemaType": "explicit") for a bucket.

+

Explicit schemas are used to enforce column names, tags, fields, and data +types for your data.

+

By default, buckets have an implicit schema-type ("schemaType": "implicit") +that conforms to your data.

+ + +
Authorizations:
path Parameters
bucketID
required
string

A bucket ID. +Lists measurement schemas for the specified bucket.

+
query Parameters
name
string

A measurement name. +Only returns measurement schemas with the specified name.

+
org
string

An organization name. +Specifies the organization that owns the schema.

+
orgID
string

An organization ID. +Specifies the organization that owns the schema.

+

Responses

Response samples

Content type
application/json
{
  • "measurementSchemas": [
    ]
}

Create a measurement schema for a bucket

Creates an explicit measurement schema +for a bucket.

+

Explicit schemas are used to enforce column names, tags, fields, and data +types for your data.

+

By default, buckets have an implicit schema-type ("schemaType": "implicit") +that conforms to your data.

+

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

+

Limitations

+
    +
  • Buckets must be created with the "explicit" schemaType in order to use +schemas.
  • +
+ +
Authorizations:
path Parameters
bucketID
required
string

A bucket ID. +Adds a schema for the specified bucket.

+
query Parameters
org
string

An organization name. +Specifies the organization that owns the schema.

+
orgID
string

An organization ID. +Specifies the organization that owns the schema.

+
Request Body schema: application/json
required
Array of objects (MeasurementSchemaColumn)

Ordered collection of column definitions.

+
name
required
string

The measurement +name.

+

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "name": "cpu"
}

Response samples

Content type
application/json
{
  • "bucketID": "ba3c5e7f9b0a0010",
  • "columns": [
    ],
  • "createdAt": "2021-01-21T00:48:40.993Z",
  • "id": "1a3c5e7f9b0a8642",
  • "name": "cpu",
  • "orgID": "0a3c5e7f9b0a0001",
  • "updatedAt": "2021-01-21T00:48:40.993Z"
}

Retrieve a measurement schema

Retrieves an explicit measurement schema.

+
Authorizations:
path Parameters
bucketID
required
string

A bucket ID. +Retrieves schemas for the specified bucket.

+
measurementID
required
string

The measurement schema ID. +Specifies the measurement schema to retrieve.

+
query Parameters
org
string

Organization name. +Specifies the organization that owns the schema.

+
orgID
string

Organization ID. +Specifies the organization that owns the schema.

+

Responses

Response samples

Content type
application/json
{
  • "bucketID": "ba3c5e7f9b0a0010",
  • "columns": [
    ],
  • "createdAt": "2021-01-21T00:48:40.993Z",
  • "id": "1a3c5e7f9b0a8642",
  • "name": "cpu",
  • "orgID": "0a3c5e7f9b0a0001",
  • "updatedAt": "2021-01-21T00:48:40.993Z"
}

Update a measurement schema

Updates a measurement schema.

+

Use this endpoint to update the fields (name, type, and dataType) of a +measurement schema.

+

Limitations

+
    +
  • You can't update the name of a measurement.
  • +
+ + +
Authorizations:
path Parameters
bucketID
required
string

A bucket ID. +Specifies the bucket to retrieve schemas for.

+
measurementID
required
string

A measurement schema ID. +Retrieves the specified measurement schema.

+
query Parameters
org
string

An organization name. +Specifies the organization that owns the schema.

+
orgID
string

An organization ID. +Specifies the organization that owns the schema.

+
Request Body schema: application/json
required
Array of objects (MeasurementSchemaColumn)

An ordered collection of column definitions

+

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ]
}

Response samples

Content type
application/json
{
  • "bucketID": "ba3c5e7f9b0a0010",
  • "columns": [
    ],
  • "createdAt": "2021-01-21T00:48:40.993Z",
  • "id": "1a3c5e7f9b0a8642",
  • "name": "cpu",
  • "orgID": "0a3c5e7f9b0a0001",
  • "updatedAt": "2021-01-21T00:48:40.993Z"
}

Buckets

Store your data in InfluxDB buckets. +A bucket is a named location where time series data is stored. All buckets +have a 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.

+ + +

List buckets

Lists buckets.

+

InfluxDB retrieves buckets owned by the +organization +associated with the authorization +(API token). +To limit which buckets are returned, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all buckets up to the +default limit.

+

InfluxDB OSS

+
    +
  • If you use an operator token +to authenticate your request, InfluxDB retrieves resources for all +organizations in the instance. +To retrieve resources for only a specific organization, use the +org parameter or the orgID parameter to specify the organization.
  • +
+

Required permissions

+ + + + + + + + + + + + + + + +
ActionPermission required
Retrieve user bucketsread-buckets
Retrieve system bucketsread-orgs
+ + +
Authorizations:
query Parameters
after
string

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.

+
id
string

A bucket ID. +Only returns the bucket with the specified ID.

+
limit
integer [ 1 .. 100 ]
Default: 20

Limits the number of records returned. Default is 20.

+
name
string

A bucket name. +Only returns buckets with the specified name.

+
offset
integer >= 0

The offset for pagination. +The number of records to skip.

+

For more information about pagination parameters, see Pagination.

+
org
string

An organization name.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
  • Lists buckets for the organization associated with the authorization (API token).
  • +
+
orgID
string

An organization ID.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
  • Lists buckets for the organization associated with the authorization (API token).
  • +
+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Request samples

curl --request GET "http://localhost:8086/api/v2/buckets?name=_monitoring" \
+  --header "Authorization: Token INFLUX_TOKEN" \
+  --header "Accept: application/json" \
+  --header "Content-Type: application/json"
+

Response samples

Content type
application/json
{
  • "buckets": [
    ],
  • "links": {
    }
}

Create a bucket

Creates a bucket +and returns the bucket resource. +The default data +retention period +is 30 days.

+

InfluxDB OSS

+
    +
  • A single InfluxDB OSS instance supports active writes or queries for +approximately 20 buckets across all organizations at a given time. +Reading or writing to more than 20 buckets at a time can adversely affect +performance.
  • +
+

Limitations

+
    +
  • InfluxDB Cloud Free Plan allows users to create up to two buckets. +Exceeding the bucket quota will result in an HTTP 403 status code. +For additional information regarding InfluxDB Cloud offerings, see +InfluxDB Cloud Pricing.
  • +
+ + +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The bucket to create.

+
description
string

A description of the bucket.

+
name
required
string

The bucket name.

+
orgID
required
string

The organization ID. +Specifies the organization that owns the bucket.

+
Array of objects (RetentionRules)

Retention rules to expire or retain data. +The InfluxDB /api/v2 API uses RetentionRules to configure the retention period.

+

InfluxDB 3 Cloud Serverless

+
    +
  • retentionRules is required.
  • +
+

InfluxDB OSS

+
    +
  • retentionRules isn't required.
  • +
+
rp
string
Default: "0"

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 +is an InfluxDB 1.x concept. +The InfluxDB 2.x and Cloud equivalent is +retention period. +The InfluxDB /api/v2 API uses RetentionRules to configure the retention period.

+
schemaType
string (SchemaType)
Enum: "implicit" "explicit"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "orgID": "string",
  • "retentionRules": [
    ],
  • "rp": "0",
  • "schemaType": "implicit"
}

Response samples

Content type
application/json
{
  • "createdAt": "2022-08-03T23:04:41.073704121Z",
  • "description": "A bucket holding air sensor data",
  • "id": "37407e232b3911d8",
  • "labels": [ ],
  • "links": {
    },
  • "name": "air_sensor",
  • "orgID": "INFLUX_ORG_ID",
  • "retentionRules": [
    ],
  • "schemaType": "implicit",
  • "type": "user",
  • "updatedAt": "2022-08-03T23:04:41.073704228Z"
}

Delete a bucket

Deletes a bucket and all associated records.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Does the following when you send a delete request:

    +
      +
    1. Validates the request and queues the delete.
    2. +
    3. Returns an HTTP 204 status code if queued; error otherwise.
    4. +
    5. Handles the delete asynchronously.
    6. +
    +
  • +
+

Limitations

+
    +
  • Only one bucket can be deleted per request.
  • +
+ + +
Authorizations:
path Parameters
bucketID
required
string

Bucket ID. +The ID of the bucket to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Request samples

curl --request DELETE "http://localhost:8086/api/v2/buckets/BUCKET_ID" \
+  --header "Authorization: Token INFLUX_TOKEN" \
+  --header 'Accept: application/json'
+

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "id must have a length of 16 bytes"
}

Retrieve a bucket

Retrieves a bucket.

+

Use this endpoint to retrieve information for a specific bucket.

+
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to retrieve.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2022-08-03T23:04:41.073704121Z",
  • "description": "bucket for air sensor data",
  • "id": "37407e232b3911d8",
  • "labels": [ ],
  • "links": {
    },
  • "name": "air-sensor",
  • "orgID": "bea7ea952287f70d",
  • "retentionRules": [
    ],
  • "schemaType": "implicit",
  • "type": "user",
  • "updatedAt": "2022-08-03T23:04:41.073704228Z"
}

Update a bucket

Updates a bucket.

+

Use this endpoint to update properties +(name, description, and retentionRules) of a bucket.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Requires the retentionRules property in the request body. If you don't +provide retentionRules, InfluxDB responds with an HTTP 403 status code.
  • +
+ + +
Authorizations:
path Parameters
bucketID
required
string

The bucket ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The bucket update to apply.

+
description
string

A description of the bucket.

+
name
string

The name of the bucket.

+
Array of objects (PatchRetentionRules)

Updates to rules to expire or retain data. No rules means no updates.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "retentionRules": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "2022-08-03T23:04:41.073704121Z",
  • "description": "bucket holding air sensor data",
  • "id": "37407e232b3911d8",
  • "labels": [ ],
  • "links": {
    },
  • "name": "air_sensor",
  • "orgID": "INFLUX_ORG_ID",
  • "retentionRules": [
    ],
  • "schemaType": "implicit",
  • "type": "user",
  • "updatedAt": "2022-08-07T22:49:49.422962913Z"
}

List all labels for a bucket

Lists all labels for a bucket.

+

Labels are objects that contain labelID, name, description, and color +key-value pairs. They may be used for grouping and filtering InfluxDB +resources. +Labels are also capable of grouping across different resources--for example, +you can apply a label named air_sensor to a bucket and a task to quickly +organize resources.

+ + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to retrieve labels for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "links": {
    }
}

Add a label to a bucket

Adds a label to a bucket and returns the new label information.

+

Labels are objects that contain labelID, name, description, and color +key-value pairs. They may be used for grouping and filtering across one or +more kinds of resources--for example, you can apply a label named +air_sensor to a bucket and a task to quickly organize resources.

+

Limitations

+
    +
  • Before adding a label to a bucket, you must create the label if you +haven't already. To create a label with the InfluxDB API, send a POST +request to the /api/v2/labels endpoint).
  • +
+ + +
Authorizations:
path Parameters
bucketID
required
string

Bucket ID. +The ID of the bucket to label.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

An object that contains a labelID to add to the bucket.

+
labelID
required
string

A label ID. +Specifies the label to attach.

+

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{
  • "label": {
    },
  • "links": {
    }
}

Delete a label from a bucket

Authorizations:
path Parameters
bucketID
required
string

The bucket ID.

+
labelID
required
string

The ID of the label to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

List all users with member privileges for a bucket

Lists all users for a bucket.

+

InfluxDB users have +permission to access InfluxDB.

+

Members are users in +an organization with access to the specified resource.

+

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

+ +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to retrieve users for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "users": [
    ]
}

Add a member to a bucket

Add a user to a bucket and return the new user information.

+

InfluxDB users have +permission to access InfluxDB.

+

Members are users in +an organization.

+

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

+ + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to retrieve users for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

A user to add as a member to the bucket.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "09cfb87051cbe000",
  • "links": {
    },
  • "name": "example_user_1",
  • "role": "member",
  • "status": "active"
}

Remove a member from a bucket

Removes a member from a bucket.

+

Use this endpoint to remove a user's member privileges from a bucket. This +removes the user's read and write permissions for the bucket.

+ + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to remove a user from.

+
userID
required
string

The ID of the user to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "unauthorized",
  • "message": "unauthorized access"
}

List all owners of a bucket

Lists all owners +of a bucket.

+

Bucket owners have permission to delete buckets and remove user and member +permissions from the bucket.

+

InfluxDB 3 Cloud Serverless uses /api/v2/authorizations to assign resource permissions; doesn't use owner and member roles.

+

Limitations

+
    +
  • Owner permissions are separate from API token permissions.
  • +
  • Owner permissions are used in the context of the InfluxDB UI.
  • +
+

Required permissions

+
    +
  • read-orgs INFLUX_ORG_ID
  • +
+

INFLUX_ORG_ID is the ID of the organization that you want to retrieve a +list of owners for.

+ + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to retrieve owners for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "users": [
    ]
}

Add an owner to a bucket

Adds an owner to a bucket and returns the owners +with role and user detail.

+

Use this endpoint to create a resource owner for the bucket. +Bucket owners have permission to delete buckets and remove user and member +permissions from the bucket.

+

InfluxDB 3 Cloud Serverless uses /api/v2/authorizations to assign resource permissions; doesn't use owner and member roles.

+

Limitations

+
    +
  • Owner permissions are separate from API token permissions.
  • +
  • Owner permissions are used in the context of the InfluxDB UI.
  • +
+

Required permissions

+
    +
  • write-orgs INFLUX_ORG_ID
  • +
  • INFLUX_ORG_ID* is the ID of the organization that you want to add + an owner for.
  • +
+ + + + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to add an owner for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

A user to add as an owner for the bucket.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "d88d182d91b0950f",
  • "links": {
    },
  • "name": "example-user",
  • "role": "owner",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "role": "owner"
}

Remove an owner from a bucket

Removes an owner from a bucket.

+

Use this endpoint to remove a user's owner role for a bucket.

+

InfluxDB 3 Cloud Serverless uses /api/v2/authorizations to assign resource permissions; doesn't use owner and member roles.

+

Limitations

+
    +
  • Owner permissions are separate from API token permissions.
  • +
  • Owner permissions are used in the context of the InfluxDB UI.
  • +
+

Required permissions

+
    +
  • write-orgs INFLUX_ORG_ID
  • +
+

INFLUX_ORG_ID is the ID of the organization that you want to remove an owner +from.

+ + + + +
Authorizations:
path Parameters
bucketID
required
string

The ID of the bucket to remove an owner from.

+
userID
required
string

The ID of the owner to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "unauthorized",
  • "message": "unauthorized access"
}

Delete

Delete data from an InfluxDB bucket.

+

Delete data

Deletes data from a bucket.

+

NOTE: This endpoint has been disabled for InfluxDB 3 Cloud Serverless organizations. +See how to delete data.

+ + +
Authorizations:
query Parameters
bucket
string

A bucket name or ID. +Specifies the bucket to delete data from. +If you pass both bucket and bucketID, bucketID takes precedence.

+
bucketID
string

A bucket ID. +Specifies the bucket to delete data from. +If you pass both bucket and bucketID, bucketID takes precedence.

+
org
string

An organization name or ID.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
+
orgID
string

An organization ID.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Time range parameters and an optional delete predicate expression.

+

To select points to delete within the specified time range, pass a +delete predicate expression in the predicate property of the request body. +If you don't pass a predicate, InfluxDB deletes all data with timestamps +in the specified time range.

+
predicate
string

An expression in delete predicate syntax.

+
start
required
string <date-time>

A timestamp (RFC3339 date/time format). +The earliest time to delete from.

+
stop
required
string <date-time>

A timestamp (RFC3339 date/time format). +The latest time to delete from.

+

Responses

Request samples

Content type
application/json
{
  • "predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")",
  • "start": "2019-08-24T14:15:22Z",
  • "stop": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

DBRPs

The InfluxDB 1.x data model includes databases +and retention policies. +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.

+ + +

List database retention policy mappings

Lists database retention policy (DBRP) mappings.

+ + +
Authorizations:
query Parameters
bucketID
string

A bucket ID. +Only returns DBRP mappings that belong to the specified bucket.

+
db
string

A database. +Only returns DBRP mappings that belong to the 1.x database.

+
default
boolean

Specifies filtering on default

+
id
string

A DBPR mapping ID. +Only returns the specified DBRP mapping.

+
org
string

An organization name. +Only returns DBRP mappings for the specified organization.

+
orgID
string

An organization ID. +Only returns DBRP mappings for the specified organization.

+
rp
string

A retention policy. +Specifies the 1.x retention policy to filter on.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Add a database retention policy mapping

Creates a database retention policy (DBRP) mapping and returns the mapping.

+

Use this endpoint to add InfluxDB 1.x API compatibility to your +InfluxDB Cloud or InfluxDB OSS 2.x buckets. Your buckets must contain a +DBRP mapping in order to query and write using the InfluxDB 1.x API. +object.

+ + +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The database retention policy mapping to add.

+

Note that retention_policy is a required parameter in the request body. +The value of retention_policy can be any arbitrary string name or +value, with the default value commonly set as autogen. +The value of retention_policy isn't a retention_policy

+
bucketID
required
string

A bucket ID. +Identifies the bucket used as the target for the translation.

+
database
required
string

A database name. +Identifies the InfluxDB v1 database.

+
default
boolean

Set to true to use this DBRP mapping as the default retention policy +for the database (specified by the database property's value).

+
org
string

An organization name. +Identifies the organization that owns the mapping.

+
orgID
string

An organization ID. +Identifies the organization that owns the mapping.

+
retention_policy
required
string

A retention policy name. +Identifies the InfluxDB v1 retention policy mapping.

+

Responses

Request samples

Content type
application/json
{
  • "bucketID": "string",
  • "database": "string",
  • "default": true,
  • "org": "string",
  • "orgID": "string",
  • "retention_policy": "string"
}

Response samples

Content type
application/json
{
  • "bucketID": "4d4d9d5b61dee751",
  • "database": "example_database",
  • "default": true,
  • "id": "0a3cbb5dd526a000",
  • "orgID": "bea7ea952287f70d",
  • "retention_policy": "autogen"
}

Delete a database retention policy

Deletes the specified database retention policy (DBRP) mapping.

+ + +
Authorizations:
path Parameters
dbrpID
required
string

A DBRP mapping ID. +Only returns the specified DBRP mapping.

+
query Parameters
org
string

An organization name. +Specifies the organization that owns the DBRP mapping.

+
orgID
string

An organization ID. +Specifies the organization that owns the DBRP mapping.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json

The query parameters contain invalid values.

+
{
  • "code": "invalid",
  • "message": "invalid ID"
}

Retrieve a database retention policy mapping

Retrieves the specified retention policy (DBRP) mapping.

+ + +
Authorizations:
path Parameters
dbrpID
required
string

A DBRP mapping ID. +Specifies the DBRP mapping.

+
query Parameters
org
string

An organization name. +Specifies the organization that owns the DBRP mapping.

+
orgID
string

An organization ID. +Specifies the organization that owns the DBRP mapping.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "content": {
    }
}

Update a database retention policy mapping

Authorizations:
path Parameters
dbrpID
required
string

A DBRP mapping ID. +Specifies the DBRP mapping.

+
query Parameters
org
string

An organization name. +Specifies the organization that owns the DBRP mapping.

+
orgID
string

An organization ID. +Specifies the organization that owns the DBRP mapping.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Updates the database retention policy (DBRP) mapping and returns the mapping.

+

Use this endpoint to modify the retention policy (retention_policy property) of a DBRP mapping.

+ + +
default
boolean

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.

+
retention_policy
string

A retention policy name. +Identifies the InfluxDB v1 retention policy mapping.

+

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "retention_policy": "string"
}

Response samples

Content type
application/json
{
  • "content": {
    }
}

Invokable Scripts

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 +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.

+ +

List scripts

Lists scripts.

+ +
Authorizations:
query Parameters
limit
integer [ 0 .. 500 ]
Default: 100

The maximum number of scripts to return. Default is 100.

+
name
string

The script name. Lists scripts with the specified name.

+
offset
integer >= 0

The offset for pagination. +The number of records to skip.

+

For more information about pagination parameters, see Pagination.

+

Responses

Request samples

curl --request GET "INFLUX_URL/api/v2/scripts?limit=100&offset=0" \
+  --header "Authorization: Token INFLUX_API_TOKEN" \
+  --header "Accept: application/json" \
+  --header "Content-Type: application/json"
+

Response samples

Content type
application/json
{
  • "scripts": [
    ]
}

Create a script

Creates an invokable script +and returns the script.

+ +
Authorizations:
Request Body schema: application/json

The script to create.

+
description
required
string

Script description. A description of the script.

+
language
required
string (ScriptLanguage)
Enum: "flux" "sql"
name
required
string

Script name. The name must be unique within the organization.

+
script
required
string

The script to execute.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "language": "flux",
  • "name": "string",
  • "script": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2022-07-17T23:43:26.660308Z",
  • "description": "getLastPoint finds the last point in a bucket",
  • "id": "09afa23ff13e4000",
  • "language": "flux",
  • "name": "getLastPoint",
  • "orgID": "bea7ea952287f70d",
  • "script": "from(bucket: params.mybucket) |> range(start: -7d) |> limit(n:1)",
  • "updatedAt": "2022-07-17T23:43:26.660308Z"
}

Delete a script

Deletes a script and all associated records.

+

Limitations

+
    +
  • You can delete only one script per request.
  • +
  • If the script ID you provide doesn't exist for the organization, InfluxDB +responds with an HTTP 204 status code.
  • +
+ +
Authorizations:
path Parameters
scriptID
required
string

A script ID. +Deletes the specified script.

+

Responses

Request samples

curl -X 'DELETE' \
+  "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \
+  --header "Authorization: Token INFLUX_TOKEN" \
+  --header 'Accept: application/json'
+

Response samples

Content type
application/json
{
  • "code": "unauthorized",
  • "message": "unauthorized access"
}

Retrieve a script

Retrieves a script.

+ +
Authorizations:
path Parameters
scriptID
required
string

A script ID. +Retrieves the specified script.

+

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2022-07-17T23:49:45.731237Z",
  • "description": "getLastPoint finds the last point in a bucket",
  • "id": "09afa3b220fe4000",
  • "language": "flux",
  • "name": "getLastPoint",
  • "orgID": "bea7ea952287f70d",
  • "script": "from(bucket: my-bucket) |> range(start: -7d) |> limit(n:1)",
  • "updatedAt": "2022-07-17T23:49:45.731237Z"
}

Update a script

Updates an invokable script.

+

Use this endpoint to modify values for script properties (description and script).

+

To update a script, pass an object that contains the updated key-value pairs.

+

Limitations

+
    +
  • If you send an empty request body, the script will neither update nor +store an empty script, but InfluxDB will respond with an HTTP 200 status +code.
  • +
+ +
Authorizations:
path Parameters
scriptID
required
string

A script ID. +Updates the specified script.

+
Request Body schema: application/json

An object that contains the updated script properties to apply.

+
description
string

A description of the script.

+
script
string

The script to execute.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "script": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2022-07-17T23:49:45.731237Z",
  • "description": "get last point from new bucket",
  • "id": "09afa3b220fe4000",
  • "language": "flux",
  • "name": "getLastPoint",
  • "orgID": "bea7ea952287f70d",
  • "script": "from(bucket: newBucket) |> range(start: -7d) |> limit(n:1)",
  • "updatedAt": "2022-07-19T22:27:23.185436Z"
}

Invoke a script

Runs a script and returns the result. +When the script runs, InfluxDB replaces params keys referenced in the script with +params key-values passed in the request body--for example:

+

The following sample script contains a mybucket parameter :

+
"script": "from(bucket: params.mybucket)
+            |> range(start: -7d)
+            |> limit(n:1)"
+

The following example POST /api/v2/scripts/SCRIPT_ID/invoke request body +passes a value for the mybucket parameter:

+
{
+  "params": {
+    "mybucket": "air_sensor"
+  }
+}
+ +
Authorizations:
path Parameters
scriptID
required
string

A script ID. +Runs the specified script.

+
Request Body schema: application/json
object

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.

+

Responses

Request samples

Content type
application/json
{
  • "params": { }
}

Response samples

Content type
text/csv
,result,table,_start,_stop,_time,_value,_field,_measurement,host
+,_result,0,2019-10-30T01:28:02.52716421Z,2022-07-26T01:28:02.52716421Z,2020-01-01T00:00:00Z,72.01,used_percent,mem,host2
+

Find script parameters.

Analyzes a script and determines required parameters. +Find all params keys referenced in a script and return a list +of keys. If it is possible to determine the type of the value +from the context then the type is also returned -- for example:

+

The following sample script contains a mybucket parameter :

+
"script": "from(bucket: params.mybucket)
+            |> range(start: -7d)
+            |> limit(n:1)"
+

Requesting the parameters using GET /api/v2/scripts/SCRIPT_ID/params +returns the following:

+
{
+  "params": {
+    "mybucket": "string"
+  }
+}
+

The type name returned for a parameter will be one of:

+
    +
  • any
  • +
  • bool
  • +
  • duration
  • +
  • float
  • +
  • int
  • +
  • string
  • +
  • time
  • +
  • uint
  • +
+

The type name any is used when the type of a parameter cannot +be determined from the context, or the type is determined to +be a structured type such as an array or record.

+ +
Authorizations:
path Parameters
scriptID
required
string

A script ID. +The script to analyze for params.

+

Responses

Request samples

curl --request GET "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID/params" \
+          --header "Authorization: Token INFLUX_TOKEN"
+

Response samples

Content type
application/json
{
  • "params": {
    }
}

Limits

Retrieve limits for an organization

Authorizations:
path Parameters
orgID
required
string

The ID of the organization.

+

Responses

Response samples

Content type
application/json
{
  • "limits": {
    },
  • "links": {}
}

Organizations

Manage your 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.

+

List organizations

Lists organizations.

+

InfluxDB 3 Cloud Serverless only returns the organization that owns the token passed in the request.

+ + +
Authorizations:
query Parameters
descending
boolean
Default: false
limit
integer [ 1 .. 100 ]
Default: 20

Limits the number of records returned. Default is 20.

+
offset
integer >= 0

The offset for pagination. +The number of records to skip.

+

For more information about pagination parameters, see Pagination.

+
org
string

An organization name. +Only returns the specified organization.

+
orgID
string

An organization ID. +Only returns the specified organization.

+
userID
string

A user ID. +Only returns organizations where the specified user is a member or owner.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "orgs": [
    ]
}

Create an organization

Creates an organization +and returns the newly created organization.

+

InfluxDB 3 Cloud Serverless doesn't allow you to use this endpoint to create organizations.

+ + +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The organization to create.

+
description
string

The description of the organization.

+
name
required
string

The name of the organization.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2022-08-24T23:05:52.881317Z",
  • "description": "",
  • "id": "INFLUX_ORG_ID",
  • "links": {
    },
  • "name": "INFLUX_ORG",
  • "updatedAt": "2022-08-24T23:05:52.881318Z"
}

Delete an organization

Deletes an organization.

+

Deleting an organization from InfluxDB Cloud can't be undone. +Once deleted, all data associated with the organization is removed.

+

InfluxDB Cloud

+
    +
  • Does the following when you send a delete request:

    +
      +
    1. Validates the request and queues the delete.
    2. +
    3. Returns an HTTP 204 status code if queued; error otherwise.
    4. +
    5. Handles the delete asynchronously.
    6. +
    +
  • +
+

InfluxDB OSS

+
    +
  • Validates the request, handles the delete synchronously, +and then responds with success or failure.
  • +
+

Limitations

+
    +
  • Only one organization can be deleted per request.
  • +
+ + +
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

Retrieve an organization

Retrieves an organization.

+

Use this endpoint to retrieve information for a specific organization.

+ + +
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to retrieve.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "defaultStorageType": "tsm",
  • "description": "string",
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an organization

Updates an organization.

+

Use this endpoint to update properties +(name, description) of an organization.

+

Updating an organizationโ€™s name affects all resources that reference the +organization by name, including the following:

+
    +
  • Queries
  • +
  • Dashboards
  • +
  • Tasks
  • +
  • Telegraf configurations
  • +
  • Templates
  • +
+

If you change an organization name, be sure to update the organization name +in these resources as well.

+ + +
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to update.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The organization update to apply.

+
description
string

The description of the organization.

+
name
string

The name of the organization.

+

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "defaultStorageType": "tsm",
  • "description": "string",
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List all members of an organization

Lists all users that belong to an organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to retrieve users for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "users": [
    ]
}

Add a member to an organization

Add a user to an organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The user to add to the organization.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "09cfb87051cbe000",
  • "links": {
    },
  • "name": "example_user_1",
  • "role": "member",
  • "status": "active"
}

Remove a member from an organization

Removes a member from an organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to remove a user from.

+
userID
required
string

The ID of the user to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "unauthorized",
  • "message": "unauthorized access"
}

List all owners of an organization

Lists all owners of an organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to list owners for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "users": [
    ]
}

Add an owner to an organization

Adds an owner to an organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization that you want to add an owner for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The user to add as an owner of the organization.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "09cfb87051cbe000",
  • "links": {
    },
  • "name": "example_user_1",
  • "role": "owner",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "role": "owner"
}

Remove an owner from an organization

Removes an owner from +the organization.

+

InfluxDB 3 Cloud Serverless doesn't use owner and member roles. +Use /api/v2/authorizations to manage resource permissions.

+
Authorizations:
path Parameters
orgID
required
string

The ID of the organization to remove an owner from.

+
userID
required
string

The ID of the user to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "unauthorized",
  • "message": "unauthorized access"
}

Query

Query data stored in a bucket.

+
    +
  • HTTP clients can query the v1 /query endpoint +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.
  • +
+ + +

Query data Deprecated

Retrieves data from buckets.

+

This endpoint isn't supported in InfluxDB 3 Cloud Serverless.

+

See how to query data.

+
Authorizations:
query Parameters
org
string

An organization name or ID.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
+
orgID
string

An organization ID.

+

InfluxDB 3 Cloud Serverless

+
    +
  • Doesn't use the org parameter or orgID parameter.
  • +
+
header Parameters
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The content encoding (usually a compression algorithm) that the client can understand.

+
Content-Type
string
Enum: "application/json" "application/vnd.flux"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema:

Flux query or specification to execute

+
object (Dialect)

Options for tabular data output. +Default output is annotated CSV with headers.

+

For more information about tabular data dialect, +see W3 metadata vocabulary for tabular data.

+
object (File)

Represents a source from a single file

+
now
string <date-time>

Specifies the time that should be reported as now in the query. +Default is the server now time.

+
object

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:

+
  query: "from(bucket: params.mybucket)\
+              |> range(start: params.rangeStart) |> limit(n:1)"
+

and pass params with the key-value pairs--for example:

+
  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.
  • +
+
query
required
string

The query script to execute.

+
type
string
Value: "flux"

The type of query. Must be "flux".

+

Responses

Request samples

Content type
{
  • "dialect": {
    },
  • "extern": {
    },
  • "now": "2019-08-24T14:15:22Z",
  • "params": { },
  • "query": "string",
  • "type": "flux"
}

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

Analyze a Flux query Deprecated

This endpoint isn't supported in InfluxDB 3 Cloud Serverless. +See how to query data.

+
Authorizations:
header Parameters
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Flux query to analyze

+
object (Dialect)

Options for tabular data output. +Default output is annotated CSV with headers.

+

For more information about tabular data dialect, +see W3 metadata vocabulary for tabular data.

+
object (File)

Represents a source from a single file

+
now
string <date-time>

Specifies the time that should be reported as now in the query. +Default is the server now time.

+
object

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:

+
  query: "from(bucket: params.mybucket)\
+              |> range(start: params.rangeStart) |> limit(n:1)"
+

and pass params with the key-value pairs--for example:

+
  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.
  • +
+
query
required
string

The query script to execute.

+
type
string
Value: "flux"

The type of query. Must be "flux".

+

Responses

Request samples

Content type
application/json
{
  • "dialect": {
    },
  • "extern": {
    },
  • "now": "2019-08-24T14:15:22Z",
  • "params": { },
  • "query": "string",
  • "type": "flux"
}

Response samples

Content type
application/json

Returns an error object if the Flux query is missing a property key.

+

The following sample query is missing the bucket property key:

+
{
+  "query": "from(: \"iot_center\")\
+  ...
+}
+
{
  • "errors": [
    ]
}

Generate a query Abstract Syntax Tree (AST) Deprecated

This endpoint isn't supported in InfluxDB 3 Cloud Serverless. +See how to query data.

+
Authorizations:
header Parameters
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The Flux query to analyze.

+
query
required
string

The Flux query script to be analyzed.

+

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json

If the request body contains a missing property key in from(), +returns invalid and problem detail.

+
{
  • "code": "invalid",
  • "message": "invalid AST: loc 1:6-1:19: missing property key"
}

List Flux query suggestions Deprecated

This endpoint isn't supported in InfluxDB 3 Cloud Serverless. +See how to query data.

+
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Request samples

curl --request GET "INFLUX_URL/api/v2/query/suggestions" \
+  --header "Accept: application/json" \
+  --header "Authorization: Token INFLUX_API_TOKEN"
+

Response samples

Content type
text/html

The URL has been permanently moved. Use /api/v2/query/suggestions.

+
<a href="/api/v2/query/suggestions?orgID=INFLUX_ORG_ID">Moved Permanently</a>
+

Retrieve a query suggestion for a branching suggestion Deprecated

This endpoint isn't supported in InfluxDB 3 Cloud Serverless. +See how to query data.

+
Authorizations:
path Parameters
name
required
string

A Flux function name.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json

The requested function doesn't exist.

+
{
  • "code": "internal error",
  • "message": "An internal error has occurred"
}

Query using the InfluxDB v1 HTTP API

Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats.

+ + +
Authorizations:
query Parameters
db
required
string

The database to query data from. +This is mapped to an InfluxDB bucket. +For more information, see Database and retention policy mapping.

+
epoch
string
Enum: "ns" "u" "ยต" "ms" "s" "m" "h"

A unix timestamp precision. +Formats timestamps as unix (epoch) timestamps the specified precision +instead of RFC3339 timestamps with nanosecond precision.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
q
required
string

The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (;).

+
rp
string

The retention policy to query data from. +This is mapped to an InfluxDB bucket. +For more information, see Database and retention policy mapping.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Media type that the client can understand.

+

Note: With application/csv, query results include unix timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The content encoding (usually a compression algorithm) that the client can understand.

+
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
No sample

Resources

List all known resources

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Routes

List all top level routes

Retrieves all the top level routes for the InfluxDB API.

+

Limitations

+
    +
  • Only returns top level routes--for example, the response contains +"tasks":"/api/v2/tasks", and doesn't contain resource-specific routes +for tasks (/api/v2/tasks/TASK_ID/...).
  • +
+
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{}

Secrets

List all secret keys for an organization

Authorizations:
path Parameters
orgID
required
string

The organization ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "secrets": [
    ],
  • "links": {
    }
}

Update secrets in an organization

Authorizations:
path Parameters
orgID
required
string

The organization ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Secret key value pairs to update/add

+
property name*
string

Responses

Request samples

Content type
application/json
{
  • "apikey": "abc123xyz"
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Delete a secret from an organization

Authorizations:
path Parameters
orgID
required
string

The organization ID.

+
secretID
required
string

The secret ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Delete secrets from an organization Deprecated

Authorizations:
path Parameters
orgID
required
string

The organization ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Secret key to delete

+
secrets
Array of strings

Responses

Request samples

Content type
application/json
{
  • "secrets": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Tasks

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.

+ + +

Properties

+

A task object contains information about an InfluxDB task resource.

+

The following table defines the properties that appear in this object:

+
authorizationID
string

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 to +list authorizations.

+
createdAt
string <date-time>
cron
string

A Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.

+
description
string

A description of the task.

+
every
string <duration>

The interval (duration literal) at which the task runs. every also determines when the task first runs, depending on the specified time.

+
flux
string <flux>

The Flux script that the task executes.

+

Limitations

+
    +
  • If you use the flux property, you can't use the scriptID and scriptParameters properties.
  • +
+
id
required
string
Array of objects (Labels)
lastRunError
string
lastRunStatus
string
Enum: "failed" "success" "canceled"
latestCompleted
string <date-time>

A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

+
object
name
required
string

The name of the task.

+
offset
string <duration>

A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.

+
org
string

An organization name. +Specifies the organization that owns the task.

+
orgID
required
string

An organization ID. +Specifies the organization that owns the task.

+
ownerID
string

A user ID. +Specifies the owner of the task.

+

To find a user ID, you can use the +GET /api/v2/users endpoint to +list users.

+
scriptID
string

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.
  • +
+ +
scriptParameters
object

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.
  • +
+
status
string (TaskStatusType)
Enum: "active" "inactive"

inactive cancels scheduled runs and prevents manual runs of the task.

+
updatedAt
string <date-time>
{
  • "authorizationID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "id": "string",
  • "labels": [
    ],
  • "lastRunError": "string",
  • "lastRunStatus": "failed",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "links": {
    },
  • "name": "string",
  • "offset": "string",
  • "org": "string",
  • "orgID": "string",
  • "ownerID": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}
+

List all tasks

Retrieves a list of tasks.

+

To limit which tasks are returned, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all tasks up to the default limit.

+
Authorizations:
query Parameters
after
string

A task ID. +Only returns tasks created after the specified task.

+
limit
integer [ -1 .. 500 ]
Default: 100
Examples:
  • limit=-1 - Return all tasks, without pagination.
  • limit=50 - Return a maximum of 50 tasks.

The maximum number of tasks to return. +Default is 100. +The minimum is 1 and the maximum is 500.

+

To reduce the payload size, combine type=basic and limit (see Request samples). +For more information about the basic response, see the type parameter.

+
name
string

A task name. +Only returns tasks with the specified name. +Different tasks may have the same name.

+
offset
integer >= 0
Default: 0

The number of records to skip.

+
org
string

An organization name. +Only returns tasks owned by the specified organization.

+
orgID
string

An organization ID. +Only returns tasks owned by the specified organization.

+
scriptID
string

A script ID. +Only returns tasks that use the specified invokable script.

+
sortBy
string
Value: "name"

The sort field. Only name is supported. +Specifies the field used to sort records in the list.

+
status
string
Enum: "active" "inactive"

A task status. +Only returns tasks that have the specified status (active or inactive).

+
type
string
Default: ""
Enum: "basic" "system"

A task type (basic or system). +Default is system. +Specifies the level of detail for tasks in the response. +The default (system) response contains all the metadata properties for tasks. +To reduce the response size, pass basic to omit some task properties (flux, createdAt, updatedAt).

+
user
string

A user ID. +Only returns tasks owned by the specified user.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Request samples

curl INFLUX_URL/api/v2/tasks/?limit=-1&type=basic \
+  --header 'Content-Type: application/json' \
+  --header 'Authorization: Token INFLUX_API_TOKEN'
+

Response samples

Content type
application/json
Example

A sample response body for the ?type=basic parameter. +type=basic omits some task fields (createdAt and updatedAt) +and field values (org, flux) in the response.

+
{
  • "links": {
    },
  • "tasks": [
    ]
}

Create a task

Creates a task and returns the task.

+

Use this endpoint to create a scheduled task that runs a Flux script.

+

InfluxDB Cloud

+
    +
  • You can use either flux or scriptID to provide the task script.

    +
      +
    • flux: a string of "raw" Flux that contains task options and the script--for example:

      +
      {
      +  "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",
      +  "description": "This task downsamples CPU data every hour"
      +}
      +
    • +
    • scriptID: the ID of an invokable script +for the task to run. +To pass task options when using scriptID, pass the options as +properties in the request body--for example:

      +
      {
      +  "name": "CPU Total 1 Hour New",
      +  "description": "This task downsamples CPU data every hour",
      +  "every": "1h",
      +  "scriptID": "SCRIPT_ID",
      +  "scriptParameters":
      +    {
      +      "rangeStart": "-1h",
      +      "bucket": "telegraf",
      +      "filterField": "cpu-total"
      +    }
      +  }
      +
    • +
    +
  • +
+

Limitations:

+
    +
  • You can't use flux and scriptID for the same task.
  • +
+ +
Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

The task to create

+
cron
string

A Cron expression that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time.

+
description
string

The description of the task.

+
every
string

The interval (duration literal)) at which the task runs. +every also determines when the task first runs, depending on the specified time.

+
flux
string

The Flux script that the task runs.

+

Limitations

+
    +
  • If you use the flux property, you can't use the scriptID and scriptParameters properties.
  • +
+
name
string

The name of the task

+
offset
string <duration>

A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.

+
org
string

The name of the organization that owns the task.

+
orgID
string

The ID of the organization that owns the task.

+
scriptID
string

The ID of the script that the task runs.

+

Limitations

+
    +
  • If you use the scriptID property, you can't use the flux property.
  • +
+
scriptParameters
object

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.
  • +
+
status
string (TaskStatusType)
Enum: "active" "inactive"

inactive cancels scheduled runs and prevents manual runs of the task.

+

Responses

Request samples

Content type
application/json
{
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "name": "string",
  • "offset": "string",
  • "org": "string",
  • "orgID": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "authorizationID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "id": "string",
  • "labels": [
    ],
  • "lastRunError": "string",
  • "lastRunStatus": "failed",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "links": {
    },
  • "name": "string",
  • "offset": "string",
  • "org": "string",
  • "orgID": "string",
  • "ownerID": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a task

Deletes a task and associated records.

+

Use this endpoint to delete a task and all associated records (task runs, logs, and labels). +Once the task is deleted, InfluxDB cancels all scheduled runs of the task.

+

If you want to disable a task instead of delete it, update the task status to inactive.

+
Authorizations:
path Parameters
taskID
required
string

A task ID. Specifies the task to delete.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

Retrieve a task

Retrieves a task.

+
Authorizations:
path Parameters
taskID
required
string

A task ID. +Specifies the task to retrieve.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "authorizationID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "id": "string",
  • "labels": [
    ],
  • "lastRunError": "string",
  • "lastRunStatus": "failed",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "links": {
    },
  • "name": "string",
  • "offset": "string",
  • "org": "string",
  • "orgID": "string",
  • "ownerID": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a task

Updates a task, +and then cancels all scheduled runs of the task.

+

Use this endpoint to set, modify, or clear task properties--for example: cron, name, flux, status. +Once InfluxDB applies the update, it cancels all previously scheduled runs of the task.

+

To update a task, pass an object that contains the updated key-value pairs. +To activate or inactivate a task, set the status property. +"status": "inactive" cancels scheduled runs and prevents manual runs of the task.

+

InfluxDB Cloud

+
    +
  • Use either flux or scriptID to provide the task script.

    +
      +
    • flux: a string of "raw" Flux that contains task options and the script--for example:

      +
      {
      +  "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",
      +  "description": "This task downsamples CPU data every hour"
      +}
      +
    • +
    • scriptID: the ID of an invokable script +for the task to run. +To pass task options when using scriptID, pass the options as +properties in the request body--for example:

      +
      {
      +  "name": "CPU Total 1 Hour New",
      +  "description": "This task downsamples CPU data every hour",
      +  "every": "1h",
      +  "scriptID": "SCRIPT_ID",
      +  "scriptParameters":
      +    {
      +      "rangeStart": "-1h",
      +      "bucket": "telegraf",
      +      "filterField": "cpu-total"
      +    }
      +  }
      +
    • +
    +
  • +
+

Limitations:

+
    +
  • You can't use flux and scriptID for the same task.
  • +
+
Authorizations:
path Parameters
taskID
required
string

A task ID. +Specifies the task to update.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

An task update to apply.

+
cron
string

Update the 'cron' option in the flux script.

+
description
string

Update the description of the task.

+
every
string

Update the 'every' option in the flux script.

+
flux
string

Update the Flux script that the task runs.

+
name
string

Update the 'name' option in the flux script.

+
offset
string

Update the 'offset' option in the flux script.

+
scriptID
string

Update the 'scriptID' of the task.

+
scriptParameters
object

Update the 'scriptParameters' of the task.

+
status
string (TaskStatusType)
Enum: "active" "inactive"

inactive cancels scheduled runs and prevents manual runs of the task.

+

Responses

Request samples

Content type
application/json
{
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "name": "string",
  • "offset": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "authorizationID": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "cron": "string",
  • "description": "string",
  • "every": "string",
  • "flux": "string",
  • "id": "string",
  • "labels": [
    ],
  • "lastRunError": "string",
  • "lastRunStatus": "failed",
  • "latestCompleted": "2019-08-24T14:15:22Z",
  • "links": {
    },
  • "name": "string",
  • "offset": "string",
  • "org": "string",
  • "orgID": "string",
  • "ownerID": "string",
  • "scriptID": "string",
  • "scriptParameters": { },
  • "status": "active",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List labels for a task

Retrieves a list of all labels for a task.

+

Labels may be used for grouping and filtering tasks.

+
Authorizations:
path Parameters
taskID
required
string

The ID of the task to retrieve labels for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{}

Add a label to a task

Adds a label to a task.

+

Use this endpoint to add a label that you can use to filter tasks in the InfluxDB UI.

+
Authorizations:
path Parameters
taskID
required
string

The ID of the task to label.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

An object that contains a labelID to add to the task.

+
labelID
required
string

A label ID. +Specifies the label to attach.

+

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a task

Deletes a label from a task.

+
Authorizations:
path Parameters
labelID
required
string

The ID of the label to delete.

+
taskID
required
string

The ID of the task to delete the label from.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

Retrieve all logs for a task

Retrieves a list of all logs for a task.

+

When an InfluxDB task runs, a โ€œrunโ€ record is created in the taskโ€™s history. +Logs associated with each run provide relevant log messages, timestamps, and the exit status of the run attempt.

+

Use this endpoint to retrieve only the log events for a task, +without additional task metadata.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
Example
{
  • "events": [
    ]
}

List all task members Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+

Lists all users that have the member role for the specified task.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a task Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+

Adds a user to members of a task and returns the member.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

A user to add as a member of the task.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "role": "member"
}

Remove a member from a task Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+

Removes a member from a task.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
userID
required
string

The ID of the member to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

List all owners of a task Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+

Retrieves all users that have owner permission for a task.

+
Authorizations:
path Parameters
taskID
required
string

The ID of the task to retrieve owners for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner for a task Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+

Assigns a task owner role to a user.

+

Use this endpoint to create a resource owner for the task. +A resource owner is a user with role: owner for a specific resource.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

A user to add as an owner of the task.

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "0772396d1f411000",
  • "links": {
    },
  • "name": "USER_NAME",
  • "role": "owner",
  • "status": "active"
}

Remove an owner from a task Deprecated

Deprecated: Tasks don't use owner and member roles. +Use /api/v2/authorizations to assign user permissions.

+
Authorizations:
path Parameters
taskID
required
string

The task ID.

+
userID
required
string

The ID of the owner to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

List runs for a task

Retrieves a list of runs for a task.

+

To limit which task runs are returned, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all task runs up to the default limit.

+ +
Authorizations:
path Parameters
taskID
required
string

The ID of the task to get runs for. +Only returns runs for this task.

+
query Parameters
after
string

A task run ID. Only returns runs created after this run.

+
afterTime
string <date-time>

A timestamp (RFC3339 date/time format). +Only returns runs scheduled after this time.

+
beforeTime
string <date-time>

A timestamp (RFC3339 date/time format). +Only returns runs scheduled before this time.

+
limit
integer [ 1 .. 500 ]
Default: 100

Limits the number of task runs returned. Default is 100.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "runs": [
    ]
}

Start a task run, overriding the schedule

Schedules a task run to start immediately, ignoring scheduled runs.

+

Use this endpoint to manually start a task run. +Scheduled runs will continue to run as scheduled. +This may result in concurrently running tasks.

+

To retry a previous run (and avoid creating a new run), +use the POST /api/v2/tasks/{taskID}/runs/{runID}/retry endpoint.

+ +
Authorizations:
path Parameters
taskID
required
string
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json
scheduledFor
string or null <date-time>

The time RFC3339 date/time format +used for the run's now option. +Default is the server now time.

+

Responses

Request samples

Content type
application/json
{
  • "scheduledFor": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "finishedAt": "2006-01-02T15:04:05.999999999Z07:00",
  • "flux": "string",
  • "id": "string",
  • "links": {
    },
  • "log": [
    ],
  • "requestedAt": "2006-01-02T15:04:05.999999999Z07:00",
  • "scheduledFor": "2019-08-24T14:15:22Z",
  • "startedAt": "2006-01-02T15:04:05.999999999Z07:00",
  • "status": "scheduled",
  • "taskID": "string"
}

Cancel a running task

Cancels a running task.

+

Use this endpoint with InfluxDB OSS to cancel a running task.

+

InfluxDB Cloud

+
    +
  • Doesn't support this operation. +
  • +
+
Authorizations:
path Parameters
runID
required
string

The ID of the task run to cancel.

+
taskID
required
string

The ID of the task to cancel.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "failed to decode request body: organization not found"
}

Retrieve a run for a task.

Retrieves a specific run for a task.

+

Use this endpoint to retrieve detail and logs for a specific task run.

+ +
Authorizations:
path Parameters
runID
required
string

The ID of the run to retrieve.

+
taskID
required
string

The ID of the task to retrieve runs for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "finishedAt": "2022-07-18T14:46:07.308254Z",
  • "id": "09b070dadaa7d000",
  • "links": {
    },
  • "log": [
    ],
  • "requestedAt": "2022-07-18T14:46:06Z",
  • "scheduledFor": "2022-07-18T14:46:06Z",
  • "startedAt": "2022-07-18T14:46:07.16222Z",
  • "status": "success",
  • "taskID": "0996e56b2f378000"
}

Retrieve all logs for a run

Retrieves all logs for a task run. +A log is a list of run events with runID, time, and message properties.

+

Use this endpoint to help analyze task performance and troubleshoot failed task runs.

+ +
Authorizations:
path Parameters
runID
required
string

The ID of the run to get logs for.

+
taskID
required
string

The ID of the task to get logs for.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
Example
{
  • "events": [
    ]
}

Retry a task run

Queues a task run to +retry and returns the scheduled run.

+

To manually start a new task run, use the +POST /api/v2/tasks/{taskID}/runs endpoint.

+

Limitations

+
    +
  • The task must be active (status: "active").
  • +
+
Authorizations:
path Parameters
runID
required
string

A task run ID. +Specifies the task run to retry.

+

To find a task run ID, use the +GET /api/v2/tasks/{taskID}/runs endpoint +to list task runs.

+
taskID
required
string

A task ID. +Specifies the task to retry.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json; charset=utf-8
object

Responses

Request samples

Content type
application/json; charset=utf-8
{ }

Response samples

Content type
application/json
{
  • "id": "09d60ffe08738000",
  • "links": {
    },
  • "requestedAt": "2022-08-16T20:05:11.84145Z",
  • "scheduledFor": "2022-08-15T00:00:00Z",
  • "status": "scheduled",
  • "taskID": "09a776832f381000"
}

Telegrafs

List all Telegraf configurations

Authorizations:
query Parameters
orgID
string

The organization ID the Telegraf config belongs to.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "configurations": [
    ]
}

Create a Telegraf configuration

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Telegraf configuration to create

+
config
string
description
string
object
name
string
orgID
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "config": "string",
  • "description": "string",
  • "metadata": {
    },
  • "name": "string",
  • "orgID": "string",
  • "plugins": [
    ]
}

Response samples

Content type
application/json
{
  • "config": "string",
  • "description": "string",
  • "metadata": {
    },
  • "name": "string",
  • "orgID": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {
    }
}

Delete a Telegraf configuration

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf configuration ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Retrieve a Telegraf configuration

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf configuration ID.

+
header Parameters
Accept
string
Default: application/toml
Enum: "application/toml" "application/json" "application/octet-stream"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
{
  • "config": "string",
  • "description": "string",
  • "metadata": {
    },
  • "name": "string",
  • "orgID": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {
    }
}

Update a Telegraf configuration

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Telegraf configuration update to apply

+
config
string
description
string
object
name
string
orgID
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "config": "string",
  • "description": "string",
  • "metadata": {
    },
  • "name": "string",
  • "orgID": "string",
  • "plugins": [
    ]
}

Response samples

Content type
application/json
{
  • "config": "string",
  • "description": "string",
  • "metadata": {
    },
  • "name": "string",
  • "orgID": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {
    }
}

List all labels for a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{}

Add a label to a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Label to add

+
labelID
required
string

A label ID. +Specifies the label to attach.

+

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a Telegraf config

Authorizations:
path Parameters
labelID
required
string

The label ID.

+
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

List all users with member privileges for a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add a member to a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

User to add as member

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "role": "member"
}

Remove a member from a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
userID
required
string

The ID of the member to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

List all owners of a Telegraf configuration

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf configuration ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "links": {},
  • "users": [
    ]
}

Add an owner to a Telegraf configuration

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf configuration ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

User to add as owner

+
id
required
string

The ID of the user to add to the resource.

+
name
string

The name of the user to add to the resource.

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "links": {
    },
  • "name": "string",
  • "status": "active",
  • "role": "owner"
}

Remove an owner from a Telegraf config

Authorizations:
path Parameters
telegrafID
required
string

The Telegraf config ID.

+
userID
required
string

The ID of the owner to remove.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Templates

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.

+ +

List installed stacks

Lists installed InfluxDB stacks.

+

To limit stacks in the response, pass query parameters in your request. +If no query parameters are passed, InfluxDB returns all installed stacks +for the organization.

+ +
Authorizations:
query Parameters
name
string
Examples:
  • name=project-stack-0 - Find stacks with the event name

A stack name. +Finds stack events with this name and returns the stacks.

+

Repeatable. +To filter for more than one stack name, +repeat this parameter with each name--for example:

+
    +
  • INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1
  • +
+
orgID
required
string

An organization ID. +Only returns stacks owned by the specified organization.

+

InfluxDB Cloud

+
    +
  • Doesn't require this parameter; +InfluxDB only returns resources allowed by the API token.
  • +
+
stackID
string
Examples:
  • stackID=09bd87cd33be3000 - Find a stack with the ID

A stack ID. +Only returns the specified stack.

+

Repeatable. +To filter for more than one stack ID, +repeat this parameter with each ID--for example:

+
    +
  • INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000
  • +
+

Responses

Response samples

Content type
application/json
{
  • "stacks": [
    ]
}

Create a stack

Creates or initializes a stack.

+

Use this endpoint to manually initialize a new stack with the following +optional information:

+
    +
  • Stack name
  • +
  • Stack description
  • +
  • URLs for template manifest files
  • +
+

To automatically create a stack when applying templates, +use the /api/v2/templates/apply endpoint.

+

Required permissions

+
    +
  • write permission for the organization
  • +
+ +
Authorizations:
Request Body schema: application/json

The stack to create.

+
description
string
name
string
orgID
string
urls
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "orgID": "string",
  • "urls": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "orgID": "string"
}

Delete a stack and associated resources

Authorizations:
path Parameters
stack_id
required
string

The identifier of the stack.

+
query Parameters
orgID
required
string

The identifier of the organization.

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Retrieve a stack

Authorizations:
path Parameters
stack_id
required
string

The identifier of the stack.

+

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "orgID": "string"
}

Update a stack

Authorizations:
path Parameters
stack_id
required
string

The identifier of the stack.

+
Request Body schema: application/json

The stack to update.

+
Array of objects
description
string or null
name
string or null
templateURLs
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "additionalResources": [
    ],
  • "description": "string",
  • "name": "string",
  • "templateURLs": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "orgID": "string"
}

Uninstall a stack

Authorizations:
path Parameters
stack_id
required
string

The identifier of the stack.

+

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "id": "string",
  • "orgID": "string"
}

Apply or dry-run a template

Applies a template to +create or update a stack of InfluxDB +resources. +The response contains the diff of changes and the stack ID.

+

Use this endpoint to install an InfluxDB template to an organization. +Provide template URLs or template objects in your request. +To customize which template resources are installed, use the actions +parameter.

+

By default, when you apply a template, InfluxDB installs the template to +create and update stack resources and then generates a diff of the changes. +If you pass dryRun: true in the request body, InfluxDB validates the +template and generates the resource diff, but doesnโ€™t make any +changes to your instance.

+

Custom values for templates

+
    +
  • Some templates may contain environment references for custom metadata. +To provide custom values for environment references, pass the envRefs +property in the request body.

    +
  • +
  • Some templates may contain queries that use +secrets. +To provide custom secret values, pass the secrets property +in the request body. +Don't expose secret values in templates.

    +
  • +
+

Required permissions

+
    +
  • write permissions for resource types in the template.
  • +
+

Rate limits (with InfluxDB Cloud)

+ + +
Authorizations:
Request Body schema:

Parameters for applying templates.

+
Array of objects or objects

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.
  • +
+
dryRun
boolean

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.
  • +
+
object

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
  • +
+ +
orgID
string

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.

+
Array of objects

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.

+
object

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:

+
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:

+
{
+  ...
+  "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.

+ +
stackID
string

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 to list stacks.

+ +
object

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.

+
Array of objects

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.

+

Responses

Request samples

Content type
Example
{
  • "actions": [
    ],
  • "orgID": "INFLUX_ORG_ID",
  • "templates": [
    ]
}

Response samples

Content type
application/json
{
  • "diff": {
    },
  • "errors": [
    ],
  • "sources": [
    ],
  • "stackID": "string",
  • "summary": {
    }
}

Export a new template

Authorizations:
Request Body schema: application/json

Export resources as an InfluxDB template.

+
One of
Array of objects
Array of objects
stackID
string

Responses

Request samples

Content type
application/json
Example
{
  • "orgIDs": [
    ],
  • "resources": [
    ],
  • "stackID": "string"
}

Response samples

Content type
[
  • {
    }
]

Usage

Retrieve usage for an organization

Authorizations:
path Parameters
orgID
required
string

The ID of the organization.

+
query Parameters
raw
boolean
Default: false

return raw usage data

+
start
required
integer <unix timestamp>

Earliest time (unix timestamp format) to include in results.

+
stop
integer <unix timestamp>

Latest time (unix timestamp format) to include in results.

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Variables

List all variables

Authorizations:
query Parameters
org
string

The name of the organization.

+
orgID
string

The organization ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "variables": [
    ]
}

Create a variable

Authorizations:
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Variable to create

+
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
description
string
Array of objects (Labels)
name
required
string
orgID
required
string
selected
Array of strings
sort_order
integer
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {},
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Retrieve a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {},
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Variable update to apply

+
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
description
string
Array of objects (Labels)
name
required
string
orgID
required
string
selected
Array of strings
sort_order
integer
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {},
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Variable to replace

+
required
QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt
string <date-time>
description
string
Array of objects (Labels)
name
required
string
orgID
required
string
selected
Array of strings
sort_order
integer
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "labels": [
    ],
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "arguments": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "labels": [
    ],
  • "links": {},
  • "name": "string",
  • "orgID": "string",
  • "selected": [
    ],
  • "sort_order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List all labels for a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{}

Add a label to a variable

Authorizations:
path Parameters
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: application/json

Label to add

+
labelID
required
string

A label ID. +Specifies the label to attach.

+

Responses

Request samples

Content type
application/json
{
  • "labelID": "string"
}

Response samples

Content type
application/json
{}

Delete a label from a variable

Authorizations:
path Parameters
labelID
required
string

The label ID to delete.

+
variableID
required
string

The variable ID.

+
header Parameters
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "err": "string",
  • "message": "string",
  • "op": "string"
}

Write

Write time series data to buckets using InfluxDB v1 or v2 endpoints.

+

Write data

Writes data to a bucket.

+

Use this endpoint to send data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Serverless does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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.
    • +
    • 400 Bad Request: Data from the batch was rejected and not written. The response body indicates if a partial write occurred.
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless.

+ +

Rate limits

+

Write rate limits apply. +For more information, see limits and adjustable quotas.

+ + +
Authorizations:
query Parameters
bucket
required
string

A bucket name or ID. +InfluxDB writes all points in the batch to the specified bucket.

+
org
required
string

An organization name or ID.

+

InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); +doesn't use the org parameter or orgID parameter.

+
orgID
string

An organization ID.

+

InfluxDB 3 Cloud Serverless writes data to the bucket in the organization associated with the authorization (API token); +doesn't use the org parameter or orgID parameter.

+
precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for unix timestamps in the line protocol batch.

+
header Parameters
Accept
string
Default: application/json
Value: "application/json"

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 3 Cloud Serverless

+
    +
  • Returns only application/json for format and limit errors.
  • +
  • Returns only text/html for some quota limit errors.
  • +
+ + +
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

The compression applied to the line protocol in the request payload. +To send a gzip payload, pass Content-Encoding: gzip header.

+
Content-Length
integer

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.

+
Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8"

The format of the data in the request body. +To send a line protocol payload, pass Content-Type: text/plain; charset=utf-8.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

In the request body, provide data in line protocol format.

+

To send compressed data, do the following:

+
    +
  1. Use gzip to compress the line protocol data.
  2. +
  3. In your request, send the compressed data and the +Content-Encoding: gzip header.
  4. +
+ + +
string <byte>

Responses

Request samples

Content type
text/plain
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
+

Response samples

Content type
application/json
Example
{
  • "code": "invalid",
  • "line": 2,
  • "message": "no data written, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}

Write data using the InfluxDB v1 HTTP API

Writes data to a bucket.

+

Use this endpoint for InfluxDB v1 parameter compatibility when sending data in line protocol format to InfluxDB.

+

InfluxDB 3 Cloud Serverless does the following when you send a write request:

+
    +
  1. Validates the request.

    +
  2. +
  3. If successful, attempts to ingest data from the request body; otherwise, responds with an error status.

    +
  4. +
  5. 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: some points in the batch are ingested and queryable, and some points are rejected
    • +
    • 400 Bad Request: all data is rejected
    • +
    +
  6. +
+

The response body contains error details about 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 and /api/v2/write endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Serverless.

+ +

Rate limits

+

Write rate limits apply. +For more information, see limits and adjustable quotas.

+ + +
Authorizations:
query Parameters
db
required
string

Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, indicates that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "line": 2,
  • "message": "failed to parse line protocol: errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}
+ + + + + diff --git a/content/influxdb3/clustered/api/v1-compatibility/_index.html b/content/influxdb3/clustered/api/v1-compatibility/_index.html new file mode 100644 index 000000000..54fc87790 --- /dev/null +++ b/content/influxdb3/clustered/api/v1-compatibility/_index.html @@ -0,0 +1,579 @@ +--- +title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered +description: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database. +layout: api +menu: + influxdb3_clustered: + parent: InfluxDB HTTP API + name: v1 Compatibility API + identifier: api-reference-v1-compatibility +weight: 304 +aliases: + - /influxdb/clustered/api/v1/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB v1 HTTP API for InfluxDB 3 Clustered

License: MIT

The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.

+

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.

+ +

InfluxDB /api/v2 API for InfluxDB 3 Clustered

+

Authentication

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:

+ +

TokenAuthentication

Use the Token authentication +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:

+ +
Security Scheme Type API Key
Header parameter name: Authorization

BasicAuthentication

Use the HTTP Basic authentication +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.

+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuthentication

Use the Querystring authentication +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.

+
Security Scheme Type API Key
Query parameter name: u=&p=

Query

Query using the InfluxDB v1 HTTP API

query Parameters
db
required
string

Bucket to query.

+
p
string

User token.

+
q
string

Defines the influxql query to run.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Specifies how query results should be encoded in the response. Note: With application/csv, query results include epoch timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.

+
Content-Type
string
Value: "application/vnd.influxql"
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

InfluxQL query to execute.

+
string

Responses

Response samples

Content type
No sample

Write

Write time series data into InfluxDB in a V1-compatible format

query Parameters
db
required
string

Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.

+
p
string

User token.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

Username.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, its value indicates to the database that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}
+ + + + + diff --git a/content/influxdb3/clustered/api/v2/_index.html b/content/influxdb3/clustered/api/v2/_index.html new file mode 100644 index 000000000..cd9eca651 --- /dev/null +++ b/content/influxdb3/clustered/api/v2/_index.html @@ -0,0 +1,966 @@ +--- +title: InfluxDB 3 Clustered API Service +description: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database. +layout: api +menu: + influxdb3_clustered: + parent: InfluxDB HTTP API + name: v2 API + identifier: api-reference-v2 +weight: 102 +aliases: + - /influxdb/clustered/api/ +--- + + + + + + + + + + + InfluxDB + + + + + + + + + + + + + + + + +
+
+
+ + +

InfluxDB 3 Clustered API Service

License: MIT

The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.

+

The InfluxDB v2 HTTP API lets you use /api/v2 endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.

+

This documentation is generated from the +InfluxDB OpenAPI specification.

+

Quick start

See the Get Started tutorial +to get up and running authenticating with tokens, writing to databases, and querying data.

+

InfluxDB API client libraries and Flight clients +are available to integrate InfluxDB APIs with your application.

+

Authentication

Use one of the following schemes to authenticate to the InfluxDB API:

+ +

BasicAuthentication

Basic authentication scheme

+

Use the Authorization header with the Basic scheme to authenticate v1 API /write and /query requests. +When authenticating requests, InfluxDB 3 Clustered checks that the password part of the decoded credential is an authorized database token. +InfluxDB 3 Clustered ignores the username part of the decoded credential.

+

Syntax

+
Authorization: Basic <base64-encoded [USERNAME]:DATABASE_TOKEN>
+

Replace the following:

+
    +
  • [USERNAME]: an optional string value (ignored by InfluxDB 3 Clustered).
  • +
  • DATABASE_TOKEN: a database token.
  • +
  • Encode the [USERNAME]:DATABASE_TOKEN credential using base64 encoding, and then append the encoded string to the Authorization: Basic header.
  • +
+

Example

+

The following example shows how to use cURL with the Basic authentication scheme and a database token:

+
#######################################
+# Use Basic authentication with a database token
+# to query the InfluxDB v1 HTTP API
+#######################################
+# Use the --user option with `--user username:DATABASE_TOKEN` syntax
+#######################################
+
+curl --get "http://cluster-id.a.influxdb.io/query" \
+  --user "":"DATABASE_TOKEN" \
+  --data-urlencode "db=DATABASE_NAME" \
+  --data-urlencode "q=SELECT * FROM MEASUREMENT"
+

Replace the following:

+
    +
  • DATABASE_NAME: your InfluxDB 3 Clustered database
  • +
  • DATABASE_TOKEN: a database token with sufficient permissions to the database
  • +
+
Security Scheme Type HTTP
HTTP Authorization Scheme basic

QuerystringAuthentication

Use the Querystring authentication +scheme with InfluxDB 1.x API parameters to provide credentials through the query string.

+

Query string authentication

+

In the URL, pass the p query parameter to authenticate /write and /query requests. +When authenticating requests, InfluxDB 3 Clustered checks that p (password) is an authorized database token and ignores the u (username) parameter.

+

Syntax

+
https://cluster-id.a.influxdb.io/query/?[u=any]&p=DATABASE_TOKEN
+https://cluster-id.a.influxdb.io/write/?[u=any]&p=DATABASE_TOKEN
+

Example

+

The following example shows how to use cURL with query string authentication and a database token.

+
#######################################
+# Use an InfluxDB 1.x compatible username and password
+# to query the InfluxDB v1 HTTP API
+#######################################
+# Use authentication query parameters:
+#   ?p=DATABASE_TOKEN
+#######################################
+
+curl --get "https://cluster-id.a.influxdb.io/query" \
+  --data-urlencode "p=DATABASE_TOKEN" \
+  --data-urlencode "db=DATABASE_NAME" \
+  --data-urlencode "q=SELECT * FROM MEASUREMENT"
+

Replace the following:

+
    +
  • DATABASE_NAME: your InfluxDB 3 Clustered database
  • +
  • DATABASE_TOKEN: a database token with sufficient permissions to the database
  • +
+
Security Scheme Type API Key
Query parameter name: u=&p=

BearerAuthentication

Use the OAuth Bearer authentication +scheme to authenticate to the InfluxDB API.

+

In your API requests, send an Authorization header. +For the header value, provide the word Bearer followed by a space and a database token.

+

Syntax

+
Authorization: Bearer INFLUX_TOKEN
+

Example

+
########################################################
+# Use the Bearer token authentication scheme with /api/v2/write
+# to write data.
+########################################################
+
+curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \
+  --header "Authorization: Bearer DATABASE_TOKEN" \
+  --data-binary 'home,room=kitchen temp=72 1463683075'
+

For examples and more information, see the following:

+ +
Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

TokenAuthentication

Use the Token authentication +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 a database token. +The word Token is case-sensitive.

+

Syntax

+
Authorization: Token INFLUX_API_TOKEN
+

Example

+
########################################################
+# Use the Token authentication scheme with /api/v2/write
+# to write data.
+########################################################
+
+curl --request post "https://cluster-id.a.influxdb.io/api/v2/write?bucket=DATABASE_NAME&precision=s" \
+  --header "Authorization: Token DATABASE_TOKEN" \
+  --data-binary 'home,room=kitchen temp=72 1463683075'
+ + +
Security Scheme Type API Key
Header parameter name: Authorization

Headers

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HeaderValue typeDescription
AcceptstringThe content type that the client can understand.
AuthorizationstringThe authorization scheme and credential.
Content-LengthintegerThe size of the entity-body, in bytes, sent to the database.
Content-TypestringThe format of the data in the request body.
+

Response codes

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 StatusDescription
200Success
204Success. No contentInfluxDB doesn't return data for the request. For example, a successful write request returns 204 status code, acknowledging that data is written and queryable.
400Bad requestInfluxDB 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.
401UnauthorizedMay 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
404Not foundRequested resource was not found. message in the response body provides details about the requested resource.
405Method not allowedThe 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.
413Request entity too largeRequest payload exceeds the size limit.
422Unprocessable entityRequest data is invalid. code and message in the response body provide details about the problem.
429Too many requestsAPI token is temporarily over the request quota. The Retry-After header describes when to try the request again.
500Internal server error
503Service unavailableServer is temporarily unavailable to process the request. The Retry-After header describes when to try the request again.
+

System information endpoints

Ping

Get the status of the instance

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.

+
Authorizations:
None

Responses

Get the status of the instance

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.

+
Authorizations:
None

Responses

Query

Query data stored in a database.

+
    +
  • HTTP clients can query the v1 /query endpoint +using InfluxQL and retrieve data in CSV or JSON format.
  • +
  • The /api/v2/query endpoint can't query InfluxDB 3 Clustered.
  • +
  • Flight + gRPC clients can query using SQL or InfluxQL and retrieve data in Arrow format.
  • +
+ + +

Query using the InfluxDB v1 HTTP API

Queries InfluxDB using InfluxQL with InfluxDB v1 request and response formats.

+
query Parameters
db
required
string

The database to query data from.

+
epoch
string
Enum: "ns" "u" "ยต" "ms" "s" "m" "h"

A unix timestamp precision. +Formats timestamps as unix (epoch) timestamps the specified precision +instead of RFC3339 timestamps with nanosecond precision.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
q
required
string

The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (;).

+
rp
string

The retention policy to query data from. +For more information, see InfluxQL DBRP naming convention.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Accept
string
Default: application/json
Enum: "application/json" "application/csv" "text/csv" "application/x-msgpack"

Media type that the client can understand.

+

Note: With application/csv, query results include unix timestamps instead of RFC3339 timestamps.

+
Accept-Encoding
string
Default: identity
Enum: "gzip" "identity"

The content encoding (usually a compression algorithm) that the client can understand.

+
Content-Type
string
Value: "application/json"
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+

Responses

Response samples

Content type
No sample

Write

Write time series data to databases using InfluxDB v1 or v2 endpoints.

+

Write data

Writes data to a database.

+

Use this endpoint to send data in line protocol format to InfluxDB.

+

InfluxDB does the following when you send a write request:

+
    +
  1. Validates the request
  2. +
  3. If successful, attempts to ingest the data; error otherwise.
  4. +
  5. If successful, responds with success (HTTP 204 status code), acknowledging that the data is written and queryable; error otherwise.
  6. +
+

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.

+ + +
query Parameters
bucket
required
string

A database name or ID. +InfluxDB writes all points in the batch to the specified database.

+
org
required
string

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.

+
orgID
string

Ignored. An organization ID.

+

InfluxDB ignores this parameter; authorizes the request using the specified database token +and writes data to the specified cluster database.

+
precision
string (WritePrecision)
Enum: "ms" "s" "us" "ns"

The precision for unix timestamps in the line protocol batch.

+
header Parameters
Accept
string
Default: application/json
Value: "application/json"

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.
  • +
+ + +
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

The compression applied to the line protocol in the request payload. +To send a gzip payload, pass Content-Encoding: gzip header.

+
Content-Length
integer

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.

+
Content-Type
string
Default: text/plain; charset=utf-8
Enum: "text/plain" "text/plain; charset=utf-8"

The format of the data in the request body. +To send a line protocol payload, pass Content-Type: text/plain; charset=utf-8.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

In the request body, provide data in line protocol format.

+

To send compressed data, do the following:

+
    +
  1. Use gzip to compress the line protocol data.
  2. +
  3. In your request, send the compressed data and the +Content-Encoding: gzip header.
  4. +
+ + +
string <byte>

Responses

Request samples

Content type
text/plain
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
+

Response samples

Content type
application/json
{
  • "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"
}

Write data using the InfluxDB v1 HTTP API

Writes data to a database.

+

Use this InfluxDB v1-compatible endpoint to send data in 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. +
  3. If successful, attempts to ingest the data; error otherwise.
  4. +
  5. If successful, responds with success (HTTP 204 status code), acknowledging that the data is written and queryable; error otherwise.
  6. +
+

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.

+ + +
query Parameters
db
required
string

database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy.

+
p
string

The InfluxDB 1.x password to authenticate the request.

+
precision
string

Write precision.

+
rp
string

Retention policy name.

+
u
string

The InfluxDB 1.x username to authenticate the request.

+
header Parameters
Content-Encoding
string
Default: identity
Enum: "gzip" "identity"

When present, its value indicates to the database that compression is applied to the line protocol body.

+
Zap-Trace-Span
string
Example: baggage,[object Object],span_id,1,trace_id,1

OpenTracing span context

+
Request Body schema: text/plain

Line protocol body

+
string

Responses

Response samples

Content type
application/json
Example
{
  • "code": "invalid",
  • "line": 2,
  • "message": "no data written, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)"
}
+ + + + +