Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content

pull/5809/head
Jason Stirnaman 2025-01-28 10:52:31 -06:00
parent 5e9560d81a
commit f1d82f4b00
47 changed files with 9863 additions and 598 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-docs/cloud-dedicated/management/content/info.yml
View File

@ -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'

147
api-docs/generate-api-docs.sh
View File

@ -36,27 +36,30 @@ while getopts "hc" opt; do
done done
function generateHtml { function generateHtml {
specPath="$1" local specPath="$1"
product="$2" local productVersion="$2"
productName="$3" local productName="$3"
api="$4" local api="$4"
configPath="$5" local configPath="$5"
isDefault=$6 local isDefault=$6
# Use the product name to define the menu for the Hugo template # 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". # 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". # 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. # Use the title and summary defined in the product API's info.yml file.
title=$(yq '.title' $product/$apiName/content/info.yml) local title=$(yq '.title' $productVersion/$apiName/content/info.yml)
menuTitle=$(yq '.x-influxdata-short-title' $product/$apiName/content/info.yml) local menuTitle=$(yq '.x-influxdata-short-title' $productVersion/$apiName/content/info.yml)
description=$(yq '.summary' $product/$apiName/content/info.yml) local description=$(yq '.summary' $productVersion/$apiName/content/info.yml)
# Define the file name for the Redoc HTML output. # 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. # 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" echo "Bundling $specPath"
@ -75,7 +78,7 @@ function generateHtml {
--options.noAutoAuth \ --options.noAutoAuth \
--output=$specbundle \ --output=$specbundle \
--templateOptions.description=$description \ --templateOptions.description=$description \
--templateOptions.product="$product" \ --templateOptions.product="$productVersion" \
--templateOptions.productName="$productName" --templateOptions.productName="$productName"
if [[ $apiName == "v1-compatibility" ]]; then if [[ $apiName == "v1-compatibility" ]]; then
@ -90,10 +93,10 @@ menu:
identifier: api-reference-$apiName identifier: api-reference-$apiName
weight: 304 weight: 304
aliases: aliases:
- /influxdb/$product/api/v1/ - /influxdb/$versionDir/api/v1/
--- ---
" "
elif [[ $version == "0" ]]; then elif [[ $apiVersion == "0" ]]; then
echo $productName $apiName echo $productName $apiName
frontmatter="--- frontmatter="---
title: $title title: $title
@ -119,7 +122,7 @@ menu:
identifier: api-reference-$apiName identifier: api-reference-$apiName
weight: 102 weight: 102
aliases: aliases:
- /influxdb/$product/api/ - /influxdb/$versionDir/api/
--- ---
" "
else else
@ -152,68 +155,74 @@ weight: 102
rm -f $specbundle rm -f $specbundle
# Create the directory and move the file. # Create the directory and move the file.
if [ ! -z "$apiName" ]; then if [ ! -z "$apiName" ]; then
mkdir -p ../content/influxdb/$product/api/$apiName mkdir -p ../content/$productVersion/api/$apiName
mv $tmpfile ../content/influxdb/$product/api/$apiName/_index.html mv $tmpfile ../content/$productVersion/api/$apiName/_index.html
else else
mkdir -p ../content/influxdb/$product/api mkdir -p ../content/$productVersion/api
mv $tmpfile ../content/influxdb/$product/api/_index.html mv $tmpfile ../content/$productVersion/api/_index.html
fi fi
} }
# Use a combination of directory names and configuration files to build the API documentation. # 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. # Each directory represents a product, and each product directory contains a configuration file that defines APIs and their spec file locations.
function build { function build {
# Get the list of products from directory names local versions
products="$(ls -d -- */ | grep -v 'node_modules' | grep -v 'openapi')" versions="$(ls -d -- */* | grep -v 'node_modules' | grep -v 'openapi')"
for version in $versions; do
for product in $products; do # Trim the trailing slash off the directory name
#Trim the trailing slash off the directory name local version="${version%/}"
product="${product%/}" # Get the version API configuration file.
# Get the product API configuration file. local configPath="$version/.config.yml"
configPath="$product/.config.yml" if [ ! -f "$configPath" ]; then
if [ ! -f $configPath ]; then configPath=".config.yml"
configPath=".config.yml"
fi
echo "Checking product config $configPath"
# Get the product name from the configuration.
productName=$(yq e '.x-influxdata-product-name' $configPath)
if [[ -z "$productName" ]]; then
productName=InfluxDB
fi
# Get an array of product API names (keys) from the configuration file
apis=$(yq e '.apis | keys | .[]' $configPath)
# Read each element of the apis array
while IFS= read -r api; do
# Get the spec file path from the configuration.
specRootPath=$(yq e ".apis | .$api | .root" $configPath)
# Check that the YAML spec file exists.
specPath="$product/$specRootPath"
echo "Checking for spec $specPath"
if [ -d "$specPath" ] || [ ! -f "$specPath" ]; then
echo "OpenAPI spec $specPath doesn't exist."
fi fi
# Get default status from the configuration. echo "Using config $configPath"
isDefault=false # Get the product name from the configuration.
defaultStatus=$(yq e ".apis | .$api | .x-influxdata-default" $configPath) local versionName
if [[ $defaultStatus == "true" ]]; then versionName=$(yq e '.x-influxdata-product-name' "$configPath")
isDefault=true if [[ -z "$versionName" ]]; then
versionName=InfluxDB
fi fi
# Get an array of API names (keys) from the configuration file
# If the spec file differs from master, regenerate the HTML. local apis
update=0 apis=$(yq e '.apis | keys | .[]' "$configPath")
if [[ $generate_changed == 0 ]]; then # Read each element of the apis array
diff=$(git diff --name-status master -- ${specPath}) while IFS= read -r api; do
if [[ -z "$diff" ]]; then echo "======Building $version $api======"
update=1 # 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
fi
if [[ $update -eq 0 ]]; then # If the spec file differs from master, regenerate the HTML.
echo "Regenerating $product $api" local update=0
generateHtml "$specPath" "$product" "$productName" "$api" "$configPath" $isDefault if [[ $generate_changed == 0 ]]; then
fi local diff
done <<< "$apis" diff=$(git diff --name-status master -- "${specPath}")
done 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 build

0
api-docs/cloud/.config.yml → api-docs/influxdb/cloud/.config.yml
View File

0
api-docs/cloud/v1-compatibility/content/info.yml → api-docs/influxdb/cloud/v1-compatibility/content/info.yml
View File

0
api-docs/cloud/v1-compatibility/swaggerV1Compat.yml → api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml
View File

0
api-docs/cloud/v2/content/info.yml → api-docs/influxdb/cloud/v2/content/info.yml
View File

0
api-docs/cloud/v2/content/servers.yml → api-docs/influxdb/cloud/v2/content/servers.yml
View File

0
api-docs/cloud/v2/content/tag-groups.yml → api-docs/influxdb/cloud/v2/content/tag-groups.yml
View File

0
api-docs/cloud/v2/ref.yml → api-docs/influxdb/cloud/v2/ref.yml
View File

0
api-docs/v2/.config.yml → api-docs/influxdb/v2/.config.yml
View File

0
api-docs/v2/content/info.yml → api-docs/influxdb/v2/content/info.yml
View File

0
api-docs/v2/content/tag-groups.yml → api-docs/influxdb/v2/content/tag-groups.yml
View File

0
api-docs/v2/ref.yml → api-docs/influxdb/v2/ref.yml
View File

0
api-docs/v2/v1-compatibility/content/info.yml → api-docs/influxdb/v2/v1-compatibility/content/info.yml
View File

0
api-docs/v2/v1-compatibility/swaggerV1Compat.yml → api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml
View File

2
api-docs/cloud-dedicated/.config.yml → api-docs/influxdb3/cloud-dedicated/.config.yml
View File

@ -3,7 +3,7 @@ plugins:
extends: extends:
- recommended - recommended
- docs/all - docs/all
x-influxdata-product-name: InfluxDB v3 Cloud Dedicated x-influxdata-product-name: InfluxDB 3 Cloud Dedicated
apis: apis:
management@0: management@0:

12
api-docs/influxdb3/cloud-dedicated/management/content/info.yml Normal file
View File

@ -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'

4
api-docs/cloud-dedicated/management/content/servers.yml → api-docs/influxdb3/cloud-dedicated/management/content/servers.yml
View File

@ -1,8 +1,8 @@
- url: 'https://{baseurl}/api/v0' - url: 'https://{baseurl}/api/v0'
description: InfluxDB Cloud Dedicated Management API URL description: InfluxDB 3 Cloud Dedicated Management API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- 'console.influxdata.com' - 'console.influxdata.com'
default: 'console.influxdata.com' default: 'console.influxdata.com'
description: InfluxDB Cloud Dedicated Console URL description: InfluxDB 3 Cloud Dedicated Console URL

0
api-docs/cloud-dedicated/management/content/tag-groups.yml → api-docs/influxdb3/cloud-dedicated/management/content/tag-groups.yml
View File

104
api-docs/cloud-dedicated/management/openapi.yml → api-docs/influxdb3/cloud-dedicated/management/openapi.yml
View File

@ -1,26 +1,26 @@
openapi: 3.1.0 openapi: 3.1.0
info: info:
title: InfluxDB Cloud Dedicated Management API title: InfluxDB 3 Cloud Dedicated Management API
description: | 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 This documentation is generated from the
InfluxDB OpenAPI specification. InfluxDB OpenAPI specification.
summary: | 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: license:
name: MIT name: MIT
url: https://opensource.org/licenses/MIT url: https://opensource.org/licenses/MIT
version: '' version: ''
servers: servers:
- url: https://{baseurl}/api/v0 - url: https://{baseurl}/api/v0
description: InfluxDB Cloud Dedicated Management API URL description: InfluxDB 3 Cloud Dedicated Management API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- console.influxdata.com - console.influxdata.com
default: console.influxdata.com default: console.influxdata.com
description: InfluxDB Cloud Dedicated Console URL description: InfluxDB 3 Cloud Dedicated Console URL
security: security:
- bearerAuthManagementToken: [] - bearerAuthManagementToken: []
bearerAuthJwt: [] bearerAuthJwt: []
@ -30,13 +30,13 @@ tags:
description: | description: |
The InfluxDB Management API endpoints require the following credentials: 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). - `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](/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). - `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](/influxdb/cloud-dedicated/admin/tokens/management/). - `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 - name: Database tokens
@ -299,13 +299,13 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -320,7 +320,7 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: clusterId:
description: The ID of the cluster that the database belongs to description: The ID of the cluster that the database belongs to
@ -401,7 +401,7 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -462,7 +462,7 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: clusterId:
description: The ID of the cluster that the database belongs to description: The ID of the cluster that the database belongs to
@ -571,7 +571,7 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -629,7 +629,7 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: clusterId:
description: The ID of the cluster that the database belongs to description: The ID of the cluster that the database belongs to
@ -727,7 +727,7 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -783,7 +783,7 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -841,7 +841,7 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: clusterId:
description: The ID of the cluster that the database table belongs to description: The ID of the cluster that the database table belongs to
@ -906,13 +906,13 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -927,10 +927,10 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: 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' $ref: '#/components/schemas/UuidV4'
id: id:
description: The ID of the database token description: The ID of the database token
@ -1004,7 +1004,7 @@ paths:
tags: tags:
- Database tokens - Database tokens
description: | 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. 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**. 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). 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: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -1078,10 +1078,10 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: 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' $ref: '#/components/schemas/UuidV4'
id: id:
description: The ID of the database token description: The ID of the database token
@ -1190,19 +1190,19 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: tokenId - name: tokenId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -1215,10 +1215,10 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: 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' $ref: '#/components/schemas/UuidV4'
id: id:
description: The ID of the database token description: The ID of the database token
@ -1304,19 +1304,19 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: tokenId - name: tokenId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -1371,10 +1371,10 @@ paths:
type: object type: object
properties: properties:
accountId: 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' $ref: '#/components/schemas/UuidV4'
clusterId: 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' $ref: '#/components/schemas/UuidV4'
id: id:
description: The ID of the database token description: The ID of the database token
@ -1500,19 +1500,19 @@ paths:
parameters: parameters:
- name: accountId - name: accountId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: clusterId - name: clusterId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
- name: tokenId - name: tokenId
in: path 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 required: true
schema: schema:
$ref: '#/components/schemas/UuidV4' $ref: '#/components/schemas/UuidV4'
@ -1593,7 +1593,7 @@ components:
minLength: 1 minLength: 1
ClusterDatabaseRetentionPeriod: ClusterDatabaseRetentionPeriod:
description: | 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 If the retention period is not set or is set to 0, the database will have infinite retention
type: integer type: integer
@ -1623,7 +1623,7 @@ components:
minimum: 1 minimum: 1
ClusterDatabasePartitionTemplate: ClusterDatabasePartitionTemplate:
description: | 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 Each template part is evaluated in sequence, concatinating the final
partition key from the output of each part, delimited by the partition partition key from the output of each part, delimited by the partition
@ -1667,7 +1667,7 @@ components:
* `time=2023-01-01, a=<long string>` -> `2023|<long string>#|!|!` * `time=2023-01-01, a=<long string>` -> `2023|<long string>#|!|!`
* `time=2023-01-01, c=<long string>` -> `2023|!|!|<bucket ID for untruncated long string>` * `time=2023-01-01, c=<long string>` -> `2023|!|!|<bucket ID for untruncated long string>`
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 encoding necessary, as the derived partition key contains a single part, and
no reserved characters. [`TemplatePart::Bucket`] parts by definition will no reserved characters. [`TemplatePart::Bucket`] parts by definition will
always be within the part length limit and contain no restricted characters always be within the part length limit and contain no restricted characters
@ -1769,7 +1769,7 @@ components:
tagName: c tagName: c
numberOfBuckets: 10 numberOfBuckets: 10
ClusterDatabaseTableName: 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 type: string
examples: examples:
- TableOne - TableOne
@ -1782,15 +1782,15 @@ components:
- Limited Access Token - Limited Access Token
- Full Access Token - Full Access Token
DatabaseTokenResourceAllDatabases: 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 type: string
enum: enum:
- '*' - '*'
DatabaseTokenPermissionAction: 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 type: string
DatabaseTokenPermissionResource: 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: anyOf:
- $ref: '#/components/schemas/ClusterDatabaseName' - $ref: '#/components/schemas/ClusterDatabaseName'
- $ref: '#/components/schemas/DatabaseTokenResourceAllDatabases' - $ref: '#/components/schemas/DatabaseTokenResourceAllDatabases'
@ -1814,7 +1814,7 @@ components:
- action: write - action: write
resource: '*' resource: '*'
DatabaseTokenPermissions: 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 type: array
items: items:
$ref: '#/components/schemas/DatabaseTokenPermission' $ref: '#/components/schemas/DatabaseTokenPermission'
@ -1827,7 +1827,7 @@ components:
resource: '*' resource: '*'
DatabaseTokenCreatedAt: DatabaseTokenCreatedAt:
description: | 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 Uses RFC3339 format
$ref: '#/components/schemas/DateTimeRfc3339' $ref: '#/components/schemas/DateTimeRfc3339'

6
api-docs/cloud-dedicated/v1-compatibility/content/info.yml → api-docs/influxdb3/cloud-dedicated/v1-compatibility/content/info.yml
View File

@ -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 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: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: 'https://opensource.org/licenses/MIT' url: 'https://opensource.org/licenses/MIT'

14
api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml → api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
View File

@ -1,6 +1,6 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated
version: '' version: ''
description: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: https://opensource.org/licenses/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: servers:
- url: / - url: /
security: security:
@ -247,9 +247,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available. 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. This endpoint doesn't require authentication.
operationId: GetPing operationId: GetPing
@ -285,9 +285,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available. 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. This endpoint doesn't require authentication.

6
api-docs/cloud-dedicated/v2/content/info.yml → api-docs/influxdb3/cloud-dedicated/v2/content/info.yml
View File

@ -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 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: | 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 This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

4
api-docs/cloud-dedicated/v2/content/servers.yml → api-docs/influxdb3/cloud-dedicated/v2/content/servers.yml
View File

@ -1,8 +1,8 @@
- url: https://{baseurl} - url: https://{baseurl}
description: InfluxDB Cloud Dedicated API URL description: InfluxDB 3 Cloud Dedicated API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- 'cluster-id.a.influxdb.io' - 'cluster-id.a.influxdb.io'
default: 'cluster-id.a.influxdb.io' default: 'cluster-id.a.influxdb.io'
description: InfluxDB Cloud Dedicated URL description: InfluxDB 3 Cloud Dedicated URL

0
api-docs/cloud-dedicated/v2/content/tag-groups.yml → api-docs/influxdb3/cloud-dedicated/v2/content/tag-groups.yml
View File

180
api-docs/cloud-dedicated/v2/ref.yml → api-docs/influxdb3/cloud-dedicated/v2/ref.yml
View File

@ -1,25 +1,25 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: InfluxDB v2 HTTP API for Cloud Dedicated title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated
description: | 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 This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
license: license:
name: MIT name: MIT
url: https://opensource.org/licenses/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: '' version: ''
servers: servers:
- url: https://{baseurl} - url: https://{baseurl}
description: InfluxDB Cloud Dedicated API URL description: InfluxDB 3 Cloud Dedicated API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- cluster-id.a.influxdb.io - cluster-id.a.influxdb.io
default: cluster-id.a.influxdb.io default: cluster-id.a.influxdb.io
description: InfluxDB Cloud Dedicated URL description: InfluxDB 3 Cloud Dedicated URL
security: security:
- BearerAuthentication: [] - BearerAuthentication: []
- TokenAuthentication: [] - TokenAuthentication: []
@ -29,32 +29,32 @@ tags:
- description: | - description: |
### Write data ### 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. - **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 v3. - [`/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. Both endpoints accept the same line protocol format and process data in the same way.
### Query data ### 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. - 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 ### 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 ### 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. 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 name: API compatibility
x-traitTag: true x-traitTag: true
- description: | - description: |
@ -102,19 +102,19 @@ tags:
- HTTP clients can query the v1 [`/query` endpoint](#operation/GetLegacyQuery) - HTTP clients can query the v1 [`/query` endpoint](#operation/GetLegacyQuery)
using **InfluxQL** and retrieve data in **CSV** or **JSON** format. 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. - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format.
#### Related guides #### Related guides
- [Get started querying InfluxDB](/influxdb/cloud-dedicated/get-started/query/) - [Get started querying InfluxDB](/influxdb3/cloud-dedicated/get-started/query/)
- [Execute queries](/influxdb/cloud-dedicated/query-data/execute-queries/) - [Execute queries](/influxdb3/cloud-dedicated/query-data/execute-queries/)
name: Query name: Query
- description: | - 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. 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. are available to integrate InfluxDB APIs with your application.
name: Quick start name: Quick start
x-traitTag: true x-traitTag: true
@ -131,8 +131,8 @@ tags:
| `200` | Success | | | `200` | Success | |
| `201` | Created | One or more resources are created. The response body contains details about the resource. | | `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. | | `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: <ul><li>[Rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points)</li><li>`Authorization` header is missing or malformed or the API token doesn't have permission for the operation.</li></ul> | | `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: <ul><li>[Rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points)</li><li>`Authorization` header is missing or malformed or the API token doesn't have permission for the operation.</li></ul> |
| `401` | Unauthorized | May indicate one of the following: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/)</li></ul> | | `401` | Unauthorized | May indicate one of the following: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/)</li></ul> |
| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | | `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`. | | `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. | | `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: System information endpoints
- name: Usage - name: Usage
- description: | - 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 name: Write
paths: paths:
/ping: /ping:
@ -153,9 +153,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available. 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. This endpoint doesn't require authentication.
operationId: GetPing operationId: GetPing
@ -191,9 +191,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available. 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. This endpoint doesn't require authentication.
operationId: HeadPing operationId: HeadPing
@ -227,18 +227,18 @@ paths:
description: | description: |
Writes data to a database. 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. 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: 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. - `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. - `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. 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 #### 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 [`/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](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
#### Related guides #### Related guides
- [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) - [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/)
- [Write data](/influxdb/cloud-dedicated/write-data/) - [Write data](/influxdb3/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) - [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
operationId: PostWrite operationId: PostWrite
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/TraceSpan'
@ -309,7 +309,7 @@ paths:
#### Related guides #### Related guides
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
in: header in: header
name: Accept name: Accept
schema: schema:
@ -364,7 +364,7 @@ paths:
format: byte format: byte
type: string type: string
description: | 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: To send compressed data, do the following:
@ -374,12 +374,12 @@ paths:
#### Related guides #### 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 required: true
responses: responses:
'201': '201':
description: | 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: content:
application/json: application/json:
examples: examples:
@ -444,7 +444,7 @@ paths:
description: | description: |
Media type that the client can understand. 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: enum:
- application/json - application/json
- application/csv - application/csv
@ -478,7 +478,7 @@ paths:
schema: schema:
type: string type: string
- description: | - 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 in: query
name: db name: db
required: true required: true
@ -486,7 +486,7 @@ paths:
type: string type: string
- description: | - description: |
The retention policy to query data from. 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 in: query
name: rp name: rp
schema: schema:
@ -499,8 +499,8 @@ paths:
type: string type: string
- description: | - description: |
A unix timestamp precision. A unix timestamp precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision. instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
in: query in: query
name: epoch name: epoch
schema: schema:
@ -557,9 +557,9 @@ paths:
description: | description: |
#### InfluxDB Cloud: #### InfluxDB Cloud:
- returns this error if a **read** or **write** request exceeds your - 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 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. - returns `Retry-After` header that describes when to try the write again.
headers: headers:
Retry-After: Retry-After:
@ -583,19 +583,19 @@ paths:
description: | description: |
Writes data to a database. 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. 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: 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 - `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 - `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 - `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. 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 #### 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 [`/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](/influxdb/cloud-dedicated/guides/api-compatibility/v2/). - Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
#### Related guides #### Related guides
- [Get started writing data](/influxdb/cloud-dedicated/get-started/write/) - [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/)
- [Write data](/influxdb/cloud-dedicated/write-data/) - [Write data](/influxdb3/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/) - [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/TraceSpan'
- description: The InfluxDB 1.x username to authenticate the request. - 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. 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. 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: content:
application/json: application/json:
examples: 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 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': '429':
description: Token is temporarily over quota. The Retry-After header describes when to try the write again. description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
headers: headers:
@ -928,7 +928,7 @@ components:
orgID: orgID:
description: | description: |
An organization ID. 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 type: string
retention_policy: retention_policy:
description: | description: |
@ -966,12 +966,12 @@ components:
org: org:
description: | description: |
An organization name. 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 type: string
orgID: orgID:
description: | description: |
An organization ID. 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 type: string
retention_policy: retention_policy:
description: | description: |
@ -1009,7 +1009,7 @@ components:
$ref: '#/components/schemas/DBRP' $ref: '#/components/schemas/DBRP'
type: array type: array
DateTimeLiteral: 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: properties:
type: type:
$ref: '#/components/schemas/NodeType' $ref: '#/components/schemas/NodeType'
@ -1033,18 +1033,18 @@ components:
properties: properties:
predicate: predicate:
description: | 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") example: tag1="value1" and (tag2="value2" and tag3!="value3")
type: string type: string
start: start:
description: | 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. The earliest time to delete from.
format: date-time format: date-time
type: string type: string
stop: stop:
description: | 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. The latest time to delete from.
format: date-time format: date-time
type: string type: string
@ -1055,7 +1055,7 @@ components:
Dialect: Dialect:
description: | description: |
Options for tabular data output. 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**, 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). 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 #### 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, 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). 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 default: RFC3339
description: | description: |
The format for timestamps in results. 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`. To include nanoseconds in timestamps, use `RFC3339Nano`.
#### Example formatted date/time values #### Example formatted date/time values
@ -1629,7 +1629,7 @@ components:
readOnly: true readOnly: true
type: string type: string
time: 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 example: 2006-01-02T15:04:05.999999999Z07:00
format: date-time format: date-time
readOnly: true readOnly: true
@ -1824,7 +1824,7 @@ components:
type: integer type: integer
shardGroupDurationSeconds: shardGroupDurationSeconds:
description: | 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. The number of seconds that each shard group covers.
#### InfluxDB Cloud #### InfluxDB Cloud
@ -1833,7 +1833,7 @@ components:
#### Related guides #### 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 format: int64
type: integer type: integer
type: type:
@ -1910,7 +1910,7 @@ components:
RetentionRules: RetentionRules:
description: | description: |
Retention rules to expire or retain data. 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 #### InfluxDB Cloud
@ -1977,8 +1977,8 @@ components:
### Basic authentication scheme ### Basic authentication scheme
Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. 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/). 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 Cloud Dedicated ignores the `username` part of the decoded credential. InfluxDB 3 Cloud Dedicated ignores the `username` part of the decoded credential.
### Syntax ### Syntax
@ -1988,13 +1988,13 @@ components:
Replace the following: Replace the following:
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB Cloud Dedicated). - **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Cloud Dedicated).
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/). - **`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. - Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header.
### Example ### 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 ```sh
####################################### #######################################
@ -2012,8 +2012,8 @@ components:
Replace the following: Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database - **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
scheme: basic scheme: basic
type: http type: http
QuerystringAuthentication: QuerystringAuthentication:
@ -2027,7 +2027,7 @@ components:
### Query string authentication ### Query string authentication
In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests. 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 ### Syntax
@ -2038,7 +2038,7 @@ components:
### Example ### 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 ```sh
####################################### #######################################
@ -2057,8 +2057,8 @@ components:
Replace the following: Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database - **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database - **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
BearerAuthentication: BearerAuthentication:
type: http type: http
scheme: bearer scheme: bearer
@ -2092,8 +2092,8 @@ components:
``` ```
For examples and more information, see the following: For examples and more information, see the following:
- [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests) - [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/) - [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/)
TokenAuthentication: TokenAuthentication:
description: | description: |
Use the Token authentication Use the Token authentication
@ -2124,8 +2124,8 @@ components:
### Related guides ### Related guides
- [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests) - [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/) - [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/)
in: header in: header
name: Authorization name: Authorization
type: apiKey type: apiKey

2
api-docs/clustered/.config.yml → api-docs/influxdb3/cloud-serverless/.config.yml
View File

@ -3,7 +3,7 @@ plugins:
extends: extends:
- recommended - recommended
- docs/all - docs/all
x-influxdata-product-name: InfluxDB v3 Clustered x-influxdata-product-name: InfluxDB 3 Serverless
apis: apis:
v2@2: v2@2:

6
api-docs/cloud-serverless/v1-compatibility/content/info.yml → api-docs/influxdb3/cloud-serverless/v1-compatibility/content/info.yml
View File

@ -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 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: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: 'https://opensource.org/licenses/MIT' url: 'https://opensource.org/licenses/MIT'

6
api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml → api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
View File

@ -1,6 +1,6 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless
version: '' version: ''
description: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: https://opensource.org/licenses/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: servers:
- url: / - url: /
security: security:

6
api-docs/cloud-serverless/v2/content/info.yml → api-docs/influxdb3/cloud-serverless/v2/content/info.yml
View File

@ -1,9 +1,9 @@
title: InfluxDB Cloud Serverless API Service title: InfluxDB 3 Cloud Serverless API Service
x-influxdata-short-title: v2 API x-influxdata-short-title: v2 API
summary: | 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: | 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 This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

4
api-docs/cloud-serverless/v2/content/servers.yml → api-docs/influxdb3/cloud-serverless/v2/content/servers.yml
View File

@ -1,8 +1,8 @@
- url: https://{baseurl} - url: https://{baseurl}
description: InfluxDB Cloud Serverless API URL description: InfluxDB 3 Cloud Serverless API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- 'us-east-1-1.aws.cloud2.influxdata.com' - 'us-east-1-1.aws.cloud2.influxdata.com'
default: '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

0
api-docs/cloud-serverless/v2/content/tag-groups.yml → api-docs/influxdb3/cloud-serverless/v2/content/tag-groups.yml
View File

512
api-docs/cloud-serverless/v2/ref.yml → api-docs/influxdb3/cloud-serverless/v2/ref.yml
View File

File diff suppressed because it is too large Load Diff

2
api-docs/cloud-serverless/.config.yml → api-docs/influxdb3/clustered/.config.yml
View File

@ -3,7 +3,7 @@ plugins:
extends: extends:
- recommended - recommended
- docs/all - docs/all
x-influxdata-product-name: InfluxDB v3 Serverless x-influxdata-product-name: InfluxDB 3 Clustered
apis: apis:
v2@2: v2@2:

6
api-docs/clustered/v1-compatibility/content/info.yml → api-docs/influxdb3/clustered/v1-compatibility/content/info.yml
View File

@ -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 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: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: 'https://opensource.org/licenses/MIT' url: 'https://opensource.org/licenses/MIT'

6
api-docs/clustered/v1-compatibility/swaggerV1Compat.yml → api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
View File

@ -1,6 +1,6 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: InfluxDB v1 HTTP API for InfluxDB Clustered title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered
version: '' version: ''
description: | description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others. 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 #### 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: license:
name: MIT name: MIT
url: https://opensource.org/licenses/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: servers:
- url: / - url: /
security: security:

6
api-docs/clustered/v2/content/info.yml → api-docs/influxdb3/clustered/v2/content/info.yml
View File

@ -1,8 +1,8 @@
title: InfluxDB Clustered API Service title: InfluxDB 3 Clustered API Service
x-influxdata-short-title: v2 API 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: | 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 This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

4
api-docs/clustered/v2/content/servers.yml → api-docs/influxdb3/clustered/v2/content/servers.yml
View File

@ -1,8 +1,8 @@
- url: https://{baseurl} - url: https://{baseurl}
description: InfluxDB Clustered API URL description: InfluxDB 3 Clustered API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- 'cluster-host.com' - 'cluster-host.com'
default: 'cluster-host.com' default: 'cluster-host.com'
description: InfluxDB Clustered URL description: InfluxDB 3 Clustered URL

0
api-docs/clustered/v2/content/tag-groups.yml → api-docs/influxdb3/clustered/v2/content/tag-groups.yml
View File

154
api-docs/clustered/v2/ref.yml → api-docs/influxdb3/clustered/v2/ref.yml
View File

@ -1,25 +1,25 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: InfluxDB Clustered API Service title: InfluxDB 3 Clustered API Service
version: '' version: ''
description: | 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 This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
license: license:
name: MIT name: MIT
url: https://opensource.org/licenses/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: servers:
- url: https://{baseurl} - url: https://{baseurl}
description: InfluxDB Clustered API URL description: InfluxDB 3 Clustered API URL
variables: variables:
baseurl: baseurl:
enum: enum:
- cluster-host.com - cluster-host.com
default: cluster-host.com default: cluster-host.com
description: InfluxDB Clustered URL description: InfluxDB 3 Clustered URL
security: security:
- BearerAuthentication: [] - BearerAuthentication: []
- TokenAuthentication: [] - TokenAuthentication: []
@ -29,32 +29,32 @@ tags:
- description: | - description: |
### Write data ### 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. - **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](/influxdb/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3. - [`/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. Both endpoints accept the same line protocol format and process data in the same way.
### Query data ### 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/). - **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](/influxdb/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL 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 v3. Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3.
### InfluxDB v2 compatibility ### 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 ### 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 name: API compatibility
x-traitTag: true x-traitTag: true
- description: | - description: |
@ -100,21 +100,21 @@ tags:
- description: | - description: |
Query data stored in a database. 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. 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. - _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format.
#### Related guides #### Related guides
- [Get started querying InfluxDB](/influxdb/clustered/get-started/query/) - [Get started querying InfluxDB](/influxdb3/clustered/get-started/query/)
- [Execute queries](/influxdb/clustered/query-data/execute-queries/) - [Execute queries](/influxdb3/clustered/query-data/execute-queries/)
name: Query name: Query
- description: | - 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. 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. are available to integrate InfluxDB APIs with your application.
name: Quick start name: Quick start
x-traitTag: true x-traitTag: true
@ -131,7 +131,7 @@ tags:
| `200` | Success | | | `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. | | `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. | | `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: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage tokens](/influxdb/clustered/admin/tokens/)</li></ul> | | `401` | Unauthorized | May indicate one of the following: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage tokens](/influxdb3/clustered/admin/tokens/)</li></ul> |
| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. | | `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`. | | `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. | | `413` | Request entity too large | Request payload exceeds the size limit. |
@ -144,7 +144,7 @@ tags:
- name: System information endpoints - name: System information endpoints
- name: Usage - name: Usage
- description: | - 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 name: Write
paths: paths:
/ping: /ping:
@ -222,12 +222,12 @@ paths:
description: | description: |
Writes data to a database. 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: InfluxDB does the following when you send a write request:
1. Validates the 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. 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, To ensure that InfluxDB Cloud handles writes in the order you request them,
@ -235,10 +235,10 @@ paths:
#### Related guides #### Related guides
- [Get started writing data](/influxdb/clustered/get-started/write/) - [Get started writing data](/influxdb3/clustered/get-started/write/)
- [Write data](/influxdb/clustered/write-data/) - [Write data](/influxdb3/clustered/write-data/)
- [Best practices for writing data](/influxdb/clustered/write-data/best-practices/) - [Best practices for writing data](/influxdb3/clustered/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
operationId: PostWrite operationId: PostWrite
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan' - $ref: '#/components/parameters/TraceSpan'
@ -288,7 +288,7 @@ paths:
#### Related guides #### Related guides
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
in: header in: header
name: Accept name: Accept
schema: schema:
@ -343,7 +343,7 @@ paths:
format: byte format: byte
type: string type: string
description: | 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: To send compressed data, do the following:
@ -353,7 +353,7 @@ paths:
#### Related guides #### 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 required: true
responses: responses:
'204': '204':
@ -415,8 +415,8 @@ paths:
#### InfluxDB Cloud #### 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) - 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](/influxdb/clustered/account-management/limits/#global-limits). 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 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. - For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header.
@ -462,7 +462,7 @@ paths:
description: | description: |
Media type that the client can understand. 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: enum:
- application/json - application/json
- application/csv - application/csv
@ -496,7 +496,7 @@ paths:
schema: schema:
type: string type: string
- description: | - description: |
The [database](/influxdb/clustered/admin/databases/) to query data from. The [database](/influxdb3/clustered/admin/databases/) to query data from.
in: query in: query
name: db name: db
required: true required: true
@ -504,7 +504,7 @@ paths:
type: string type: string
- description: | - description: |
The retention policy to query data from. 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 in: query
name: rp name: rp
schema: schema:
@ -517,8 +517,8 @@ paths:
type: string type: string
- description: | - description: |
A unix timestamp precision. A unix timestamp precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb/clustered/reference/glossary/#unix-timestamp) the specified precision Formats timestamps as [unix (epoch) timestamps](/influxdb3/clustered/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision. instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
in: query in: query
name: epoch name: epoch
schema: schema:
@ -575,9 +575,9 @@ paths:
description: | description: |
#### InfluxDB Cloud: #### InfluxDB Cloud:
- returns this error if a **read** or **write** request exceeds your - 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 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. - returns `Retry-After` header that describes when to try the write again.
headers: headers:
Retry-After: Retry-After:
@ -649,7 +649,7 @@ paths:
description: | description: |
Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected. 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. 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: content:
application/json: application/json:
examples: examples:
@ -710,12 +710,12 @@ paths:
description: | description: |
Writes data to a database. 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: InfluxDB does the following when you send a write request:
1. Validates the 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. 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, To ensure that InfluxDB handles writes in the order you request them,
@ -723,9 +723,9 @@ paths:
#### Related guides #### Related guides
- [Write data with the InfluxDB API](/influxdb/clustered/get-started/write/) - [Write data with the InfluxDB API](/influxdb3/clustered/get-started/write/)
- [Optimize writes to InfluxDB](/influxdb/clustered/write-data/best-practices/optimize-writes/) - [Optimize writes to InfluxDB](/influxdb3/clustered/write-data/best-practices/optimize-writes/)
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/) - [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
summary: Write data using the InfluxDB v1 HTTP API summary: Write data using the InfluxDB v1 HTTP API
tags: tags:
- Write - Write
@ -920,7 +920,7 @@ components:
orgID: orgID:
description: | description: |
An organization ID. 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 type: string
retention_policy: retention_policy:
description: | description: |
@ -958,12 +958,12 @@ components:
org: org:
description: | description: |
An organization name. 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 type: string
orgID: orgID:
description: | description: |
An organization ID. 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 type: string
retention_policy: retention_policy:
description: | description: |
@ -1001,7 +1001,7 @@ components:
$ref: '#/components/schemas/DBRP' $ref: '#/components/schemas/DBRP'
type: array type: array
DateTimeLiteral: 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: properties:
type: type:
$ref: '#/components/schemas/NodeType' $ref: '#/components/schemas/NodeType'
@ -1025,18 +1025,18 @@ components:
properties: properties:
predicate: predicate:
description: | 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") example: tag1="value1" and (tag2="value2" and tag3!="value3")
type: string type: string
start: start:
description: | 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. The earliest time to delete from.
format: date-time format: date-time
type: string type: string
stop: stop:
description: | 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. The latest time to delete from.
format: date-time format: date-time
type: string type: string
@ -1047,7 +1047,7 @@ components:
Dialect: Dialect:
description: | description: |
Options for tabular data output. 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**, 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). 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 #### 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, 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). 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 default: RFC3339
description: | description: |
The format for timestamps in results. 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`. To include nanoseconds in timestamps, use `RFC3339Nano`.
#### Example formatted date/time values #### Example formatted date/time values
@ -1621,7 +1621,7 @@ components:
readOnly: true readOnly: true
type: string type: string
time: 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 example: 2006-01-02T15:04:05.999999999Z07:00
format: date-time format: date-time
readOnly: true readOnly: true
@ -1816,7 +1816,7 @@ components:
type: integer type: integer
shardGroupDurationSeconds: shardGroupDurationSeconds:
description: | 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. The number of seconds that each shard group covers.
#### InfluxDB Cloud #### InfluxDB Cloud
@ -1825,7 +1825,7 @@ components:
#### Related guides #### Related guides
- InfluxDB [shards and shard groups](/influxdb/clustered/reference/internals/shards/) - InfluxDB [shards and shard groups](/influxdb3/clustered/reference/internals/shards/)
format: int64 format: int64
type: integer type: integer
type: type:
@ -1902,7 +1902,7 @@ components:
RetentionRules: RetentionRules:
description: | description: |
Retention rules to expire or retain data. 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 #### InfluxDB Cloud
@ -1969,8 +1969,8 @@ components:
### Basic authentication scheme ### Basic authentication scheme
Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests. 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). 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 Clustered ignores the `username` part of the decoded credential. InfluxDB 3 Clustered ignores the `username` part of the decoded credential.
### Syntax ### Syntax
@ -1980,13 +1980,13 @@ components:
Replace the following: Replace the following:
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB Clustered). - **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Clustered).
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens). - **`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. - Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header.
### Example ### 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 ```sh
####################################### #######################################
@ -2004,8 +2004,8 @@ components:
Replace the following: Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Clustered database - **`DATABASE_NAME`**: your InfluxDB 3 Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
scheme: basic scheme: basic
type: http type: http
QuerystringAuthentication: QuerystringAuthentication:
@ -2019,7 +2019,7 @@ components:
### Query string authentication ### Query string authentication
In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests. 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 ### Syntax
@ -2030,7 +2030,7 @@ components:
### Example ### 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 ```sh
####################################### #######################################
@ -2049,8 +2049,8 @@ components:
Replace the following: Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Clustered database - **`DATABASE_NAME`**: your InfluxDB 3 Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database - **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
BearerAuthentication: BearerAuthentication:
type: http type: http
scheme: bearer scheme: bearer
@ -2084,8 +2084,8 @@ components:
``` ```
For examples and more information, see the following: For examples and more information, see the following:
- [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests) - [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/clustered/admin/tokens/) - [Manage tokens](/influxdb3/clustered/admin/tokens/)
TokenAuthentication: TokenAuthentication:
description: | description: |
Use the Token authentication Use the Token authentication
@ -2116,8 +2116,8 @@ components:
### Related guides ### Related guides
- [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests) - [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/clustered/admin/tokens/) - [Manage tokens](/influxdb3/clustered/admin/tokens/)
in: header in: header
name: Authorization name: Authorization
type: apiKey type: apiKey

848
content/influxdb3/cloud-dedicated/api/management/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

609
content/influxdb3/cloud-dedicated/api/v1-compatibility/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

1002
content/influxdb3/cloud-dedicated/api/v2/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

579
content/influxdb3/cloud-serverless/api/v1-compatibility/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

4673
content/influxdb3/cloud-serverless/api/v2/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

579
content/influxdb3/clustered/api/v1-compatibility/_index.html Normal file
View File

File diff suppressed because one or more lines are too long

966
content/influxdb3/clustered/api/v2/_index.html Normal file
View File

File diff suppressed because one or more lines are too long