Merge branch 'master' into pd/influxdb3-plugins-doc

pull/5830/head
Paul Dix 2025-01-31 10:07:44 -05:00 committed by GitHub
commit 9ed11bc770
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
196 changed files with 18056 additions and 842 deletions

View File

@ -1,5 +1,5 @@
plugins:
- './openapi/plugins/docs-plugin.js'
- './../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all

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'

View File

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

View File

@ -139,93 +139,98 @@ function postProcess() {
}
function updateCloudV2 {
outFile="cloud/v2/ref.yml"
outFile="influxdb/cloud/v2/ref.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
fi
postProcess $outFile 'cloud/.config.yml' v2@2
postProcess $outFile 'influxdb/cloud/.config.yml' v2@2
}
function updateCloudDedicatedManagement {
outFile="cloud-dedicated/management/openapi.yml"
outFile="influxdb3/cloud-dedicated/management/openapi.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS https://raw.githubusercontent.com/influxdata/granite/ab7ee2aceacfae7f415d15ffbcf8c9d0f6f3e015/openapi.yaml -o $outFile
# Clone influxdata/granite and fetch the latest openapi.yaml file.
echo "Fetching the latest openapi.yaml file from influxdata/granite"
tmp_dir=$(mktemp -d)
git clone --depth 1 --branch main https://github.com/influxdata/granite.git "$tmp_dir"
cp "$tmp_dir/openapi.yaml" "$outFile"
rm -rf "$tmp_dir"
fi
postProcess $outFile 'cloud-dedicated/.config.yml' management@0
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' management@0
}
function updateCloudDedicatedV2 {
outFile="cloud-dedicated/v2/ref.yml"
outFile="influxdb3/cloud-dedicated/v2/ref.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
fi
postProcess $outFile 'cloud-dedicated/.config.yml' v2@2
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' v2@2
}
function updateClusteredV2 {
outFile="clustered/v2/ref.yml"
outFile="influxdb3/clustered/v2/ref.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
fi
postProcess $outFile 'clustered/.config.yml' v2@2
postProcess $outFile 'influxdb3/clustered/.config.yml' v2@2
}
function updateCloudServerlessV2 {
outFile="cloud-serverless/v2/ref.yml"
outFile="influxdb3/cloud-serverless/v2/ref.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
fi
postProcess $outFile 'cloud-serverless/.config.yml' v2@2
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' v2@2
}
function updateOSSV2 {
outFile="v2/ref.yml"
outFile="influxdb/v2/ref.yml"
if [[ -z "$baseUrlOSS" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile
fi
postProcess $outFile 'v2/.config.yml' '@2'
postProcess $outFile 'influxdb/v2/.config.yml' '@2'
}
function updateV1Compat {
outFile="cloud/v1-compatibility/swaggerV1Compat.yml"
outFile="influxdb/cloud/v1-compatibility/swaggerV1Compat.yml"
if [[ -z "$baseUrl" ]];
then
echo "Using existing $outFile"
else
curl $UPDATE_OPTIONS ${baseUrl}/contracts/swaggerV1Compat.yml -o $outFile
fi
postProcess $outFile 'cloud/.config.yml' 'v1-compatibility'
postProcess $outFile 'influxdb/cloud/.config.yml' 'v1-compatibility'
outFile="v2/v1-compatibility/swaggerV1Compat.yml"
outFile="influxdb/v2/v1-compatibility/swaggerV1Compat.yml"
cp cloud/v1-compatibility/swaggerV1Compat.yml $outFile
postProcess $outFile 'v2/.config.yml' 'v1-compatibility'
postProcess $outFile 'influxdb/v2/.config.yml' 'v1-compatibility'
outFile="cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'cloud-dedicated/.config.yml' 'v1-compatibility'
outFile="influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' 'v1-compatibility'
outFile="cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'cloud-serverless/.config.yml' 'v1-compatibility'
outFile="influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' 'v1-compatibility'
outFile="clustered/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'clustered/.config.yml' 'v1-compatibility'
outFile="influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml"
postProcess $outFile 'influxdb3/clustered/.config.yml' 'v1-compatibility'
}
UPDATE_OPTIONS="--fail"

View File

@ -1,5 +1,5 @@
plugins:
- '../openapi/plugins/docs-plugin.js'
- '../../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all

View File

@ -1,5 +1,5 @@
plugins:
- '../openapi/plugins/docs-plugin.js'
- '../../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all

View File

@ -1,9 +1,9 @@
plugins:
- '../openapi/plugins/docs-plugin.js'
- '../../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all
x-influxdata-product-name: InfluxDB v3 Cloud Dedicated
x-influxdata-product-name: InfluxDB 3 Cloud Dedicated
apis:
management@0:

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'

View File

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

View File

@ -1,26 +1,26 @@
openapi: 3.1.0
info:
title: InfluxDB Cloud Dedicated Management API
title: InfluxDB 3 Cloud Dedicated Management API
description: |
The InfluxDB v3 Management API lets you manage an InfluxDB Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
This documentation is generated from the
InfluxDB OpenAPI specification.
summary: |
The Management API for InfluxDB Cloud Dedicated provides a programmatic interface for managing an InfluxDB Cloud Dedicated instance.
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: ''
servers:
- url: https://{baseurl}/api/v0
description: InfluxDB Cloud Dedicated Management API URL
description: InfluxDB 3 Cloud Dedicated Management API URL
variables:
baseurl:
enum:
- console.influxdata.com
default: console.influxdata.com
description: InfluxDB Cloud Dedicated Console URL
description: InfluxDB 3 Cloud Dedicated Console URL
security:
- bearerAuthManagementToken: []
bearerAuthJwt: []
@ -30,13 +30,13 @@ tags:
description: |
The InfluxDB Management API endpoints require the following credentials:
- `ACCOUNT_ID`: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
- `CLUSTER_ID`: The ID of the [cluster](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb/cloud-dedicated/admin/tokens/management/).
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
- `Authorization MANAGEMENT_TOKEN`: the `Authorization` HTTP header with a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
See how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/).
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
By default, management tokens in InfluxDB v3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
- name: Database tokens
@ -299,13 +299,13 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [databases](/influxdb/cloud-dedicated/admin/databases/) for
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [databases](/influxdb3/cloud-dedicated/admin/databases/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster to get the [databases](/influxdb/cloud-dedicated/admin/databases/) for
description: The ID of the cluster to get the [databases](/influxdb3/cloud-dedicated/admin/databases/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -320,7 +320,7 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the database belongs to
@ -401,7 +401,7 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -462,7 +462,7 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the database belongs to
@ -571,7 +571,7 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -629,7 +629,7 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the database belongs to
@ -727,7 +727,7 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -783,7 +783,7 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database table for
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database table for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -841,7 +841,7 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database table belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the database table belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the database table belongs to
@ -906,13 +906,13 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) for
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to get the [database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster to get the [database tokens](/influxdb/cloud-dedicated/admin/tokens/database/) for
description: The ID of the cluster to get the [database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -927,10 +927,10 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
id:
description: The ID of the database token
@ -1004,7 +1004,7 @@ paths:
tags:
- Database tokens
description: |
Create a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for a cluster.
Create a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for a cluster.
The token returned on the `accessToken` property in the response can be used to authenticate query and write requests to the cluster.
@ -1019,18 +1019,18 @@ paths:
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
If you lose a token, [delete the token from InfluxDB](/influxdb/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster to create the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) for
description: The ID of the cluster to create the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -1078,10 +1078,10 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
id:
description: The ID of the database token
@ -1190,19 +1190,19 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: tokenId
in: path
description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to get
description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to get
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -1215,10 +1215,10 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
id:
description: The ID of the database token
@ -1304,19 +1304,19 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: tokenId
in: path
description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to update
description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to update
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -1371,10 +1371,10 @@ paths:
type: object
properties:
accountId:
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
clusterId:
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
$ref: '#/components/schemas/UuidV4'
id:
description: The ID of the database token
@ -1500,19 +1500,19 @@ paths:
parameters:
- name: accountId
in: path
description: The ID of the [account](/influxdb/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: clusterId
in: path
description: The ID of the cluster that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) belongs to
description: The ID of the cluster that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) belongs to
required: true
schema:
$ref: '#/components/schemas/UuidV4'
- name: tokenId
in: path
description: The ID of the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) to delete
description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to delete
required: true
schema:
$ref: '#/components/schemas/UuidV4'
@ -1593,7 +1593,7 @@ components:
minLength: 1
ClusterDatabaseRetentionPeriod:
description: |
The retention period of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) in nanoseconds, if applicable
The retention period of the [cluster database](/influxdb3/cloud-dedicated/admin/databases/) in nanoseconds, if applicable
If the retention period is not set or is set to 0, the database will have infinite retention
type: integer
@ -1623,7 +1623,7 @@ components:
minimum: 1
ClusterDatabasePartitionTemplate:
description: |
A template for [partitioning](/influxdb/cloud-dedicated/admin/custom-partitions/) a cluster database.
A template for [partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/) a cluster database.
Each template part is evaluated in sequence, concatinating the final
partition key from the output of each part, delimited by the partition
@ -1667,7 +1667,7 @@ components:
* `time=2023-01-01, a=<long string>` -> `2023|<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
no reserved characters. [`TemplatePart::Bucket`] parts by definition will
always be within the part length limit and contain no restricted characters
@ -1769,7 +1769,7 @@ components:
tagName: c
numberOfBuckets: 10
ClusterDatabaseTableName:
description: The name of the [cluster database](/influxdb/cloud-dedicated/admin/databases/) table
description: The name of the [cluster database](/influxdb3/cloud-dedicated/admin/databases/) table
type: string
examples:
- TableOne
@ -1782,15 +1782,15 @@ components:
- Limited Access Token
- Full Access Token
DatabaseTokenResourceAllDatabases:
description: A resource value for a [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission that refers to all databases
description: A resource value for a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) permission that refers to all databases
type: string
enum:
- '*'
DatabaseTokenPermissionAction:
description: The action the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission allows
description: The action the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) permission allows
type: string
DatabaseTokenPermissionResource:
description: The resource the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) permission applies to
description: The resource the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) permission applies to
anyOf:
- $ref: '#/components/schemas/ClusterDatabaseName'
- $ref: '#/components/schemas/DatabaseTokenResourceAllDatabases'
@ -1814,7 +1814,7 @@ components:
- action: write
resource: '*'
DatabaseTokenPermissions:
description: The list of permissions the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) allows
description: The list of permissions the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) allows
type: array
items:
$ref: '#/components/schemas/DatabaseTokenPermission'
@ -1827,7 +1827,7 @@ components:
resource: '*'
DatabaseTokenCreatedAt:
description: |
The date and time that the [database token](/influxdb/cloud-dedicated/admin/tokens/database/) was created
The date and time that the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) was created
Uses RFC3339 format
$ref: '#/components/schemas/DateTimeRfc3339'

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
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Dedicated database.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database.
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -9,7 +9,7 @@ description: |
#### Related
[InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Cloud Dedicated](/influxdb3/cloud-dedicated/api/v2/)
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'

View File

@ -1,6 +1,6 @@
openapi: 3.0.0
info:
title: InfluxDB v1 HTTP API for InfluxDB Cloud Dedicated
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated
version: ''
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -10,11 +10,11 @@ info:
#### Related
[InfluxDB `/api/v2` API for InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Cloud Dedicated](/influxdb3/cloud-dedicated/api/v2/)
license:
name: MIT
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Dedicated database.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database.
servers:
- url: /
security:
@ -247,9 +247,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: GetPing
@ -285,9 +285,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.

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
summary: The InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Cloud Dedicated database.
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database.
description: |
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance.
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

View File

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

View File

@ -1,25 +1,25 @@
openapi: 3.0.0
info:
title: InfluxDB v2 HTTP API for Cloud Dedicated
title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated
description: |
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance.
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
license:
name: MIT
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Cloud Dedicated database.
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database.
version: ''
servers:
- url: https://{baseurl}
description: InfluxDB Cloud Dedicated API URL
description: InfluxDB 3 Cloud Dedicated API URL
variables:
baseurl:
enum:
- cluster-id.a.influxdb.io
default: cluster-id.a.influxdb.io
description: InfluxDB Cloud Dedicated URL
description: InfluxDB 3 Cloud Dedicated URL
security:
- BearerAuthentication: []
- TokenAuthentication: []
@ -29,32 +29,32 @@ tags:
- description: |
### Write data
InfluxDB Cloud Dedicated provides the following HTTP API endpoints for writing data:
InfluxDB 3 Cloud Dedicated provides the following HTTP API endpoints for writing data:
- **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3.
- [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3.
- **Recommended**: [`/api/v2/write` endpoint](#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3.
- [`/write` endpoint](#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3.
Both endpoints accept the same line protocol format and process data in the same way.
### Query data
InfluxDB Cloud Dedicated provides the following protocols for executing a query:
InfluxDB 3 Cloud Dedicated provides the following protocols for executing a query:
- **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/cloud-dedicated/get-started/query/).
- **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb3/cloud-dedicated/get-started/query/).
- HTTP API [`/query` request](#operation/GetLegacyQuery) that contains an InfluxQL query.
Use this protocol when bringing existing InfluxDB v1 query workloads to v3.
Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3.
### InfluxDB v2 compatibility
The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/cloud-dedicated/write-data/).
The HTTP API [`/api/v2/write` endpoint](#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb3/cloud-dedicated/write-data/).
See how to [use the InfluxDB v2 HTTP API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v2/).
See how to [use the InfluxDB v2 HTTP API with InfluxDB 3 Cloud Dedicated](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
### InfluxDB v1 compatibility
The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
See how to [use the InfluxDB v1 HTTP API with InfluxDB Cloud Dedicated](/influxdb/cloud-dedicated/guides/api-compatibility/v1/).
See how to [use the InfluxDB v1 HTTP API with InfluxDB 3 Cloud Dedicated](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
name: API compatibility
x-traitTag: true
- description: |
@ -102,19 +102,19 @@ tags:
- HTTP clients can query the v1 [`/query` endpoint](#operation/GetLegacyQuery)
using **InfluxQL** and retrieve data in **CSV** or **JSON** format.
- The `/api/v2/query` endpoint can't query InfluxDB Cloud Dedicated.
- The `/api/v2/query` endpoint can't query InfluxDB 3 Cloud Dedicated.
- _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format.
#### Related guides
- [Get started querying InfluxDB](/influxdb/cloud-dedicated/get-started/query/)
- [Execute queries](/influxdb/cloud-dedicated/query-data/execute-queries/)
- [Get started querying InfluxDB](/influxdb3/cloud-dedicated/get-started/query/)
- [Execute queries](/influxdb3/cloud-dedicated/query-data/execute-queries/)
name: Query
- description: |
See the [**Get Started**](/influxdb/cloud-dedicated/get-started/) tutorial
See the [**Get Started**](/influxdb3/cloud-dedicated/get-started/) tutorial
to get up and running authenticating with tokens, writing to databases, and querying data.
[**InfluxDB API client libraries and Flight clients**](/influxdb/cloud-dedicated/reference/client-libraries/)
[**InfluxDB API client libraries and Flight clients**](/influxdb3/cloud-dedicated/reference/client-libraries/)
are available to integrate InfluxDB APIs with your application.
name: Quick start
x-traitTag: true
@ -131,8 +131,8 @@ tags:
| `200` | Success | |
| `201` | Created | One or more resources are created. The response body contains details about the resource. |
| `204` | No content | The request is successful and no data is returned. For example, The [`/write` and `/api/v2/write` endpoints](#tag/Write) return this status code if all data in the batch is written and queryable. |
| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. For _writes_, the error may indicate one of the following problems: <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> |
| `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> |
| `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](/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. |
| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |
| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |
@ -143,7 +143,7 @@ tags:
- name: System information endpoints
- name: Usage
- description: |
Write time series data to [databases](/influxdb/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints.
Write time series data to [databases](/influxdb3/cloud-dedicated/admin/databases/) using InfluxDB v1 or v2 endpoints.
name: Write
paths:
/ping:
@ -153,9 +153,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: GetPing
@ -191,9 +191,9 @@ paths:
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: HeadPing
@ -227,18 +227,18 @@ paths:
description: |
Writes data to a database.
Use this endpoint to send data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB.
Use this endpoint to send data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB.
InfluxDB Cloud Dedicated does the following when you send a write request:
InfluxDB 3 Cloud Dedicated does the following when you send a write request:
1. Validates the request.
2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes).
2. If successful, attempts to [ingest data](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes).
3. Ingests or rejects data in the batch and returns one of the following HTTP status codes:
- `204 No Content`: All data in the batch is ingested.
- `400 Bad Request`: Some (_when **partial writes** are configured for the cluster_) or all of the data has been rejected. Data that has not been rejected is ingested and queryable.
The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
The response body contains error details about [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable.
@ -247,17 +247,17 @@ paths:
#### Write endpoints
The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated.
The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Dedicated.
- Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/).
- Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/).
- Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
- Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
#### Related guides
- [Get started writing data](/influxdb/cloud-dedicated/get-started/write/)
- [Write data](/influxdb/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/)
- [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/)
- [Write data](/influxdb3/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
operationId: PostWrite
parameters:
- $ref: '#/components/parameters/TraceSpan'
@ -309,7 +309,7 @@ paths:
#### Related guides
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/)
- [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
in: header
name: Accept
schema:
@ -364,7 +364,7 @@ paths:
format: byte
type: string
description: |
In the request body, provide data in [line protocol format](/influxdb/cloud-dedicated/reference/syntax/line-protocol/).
In the request body, provide data in [line protocol format](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/).
To send compressed data, do the following:
@ -374,12 +374,12 @@ paths:
#### Related guides
- [Best practices for optimizing writes](/influxdb/cloud-dedicated/write-data/best-practices/optimize-writes/)
- [Best practices for optimizing writes](/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes/)
required: true
responses:
'201':
description: |
Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
Success ("Created"). Some points in the batch are written and queryable, and some points are rejected. The response body contains details about the [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
content:
application/json:
examples:
@ -444,7 +444,7 @@ paths:
description: |
Media type that the client can understand.
**Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
**Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
enum:
- application/json
- application/csv
@ -478,7 +478,7 @@ paths:
schema:
type: string
- description: |
The [database](/influxdb/cloud-dedicated/admin/databases/) to query data from.
The [database](/influxdb3/cloud-dedicated/admin/databases/) to query data from.
in: query
name: db
required: true
@ -486,7 +486,7 @@ paths:
type: string
- description: |
The retention policy to query data from.
For more information, see [InfluxQL DBRP naming convention](/influxdb/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
in: query
name: rp
schema:
@ -499,8 +499,8 @@ paths:
type: string
- description: |
A unix timestamp precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
in: query
name: epoch
schema:
@ -557,9 +557,9 @@ paths:
description: |
#### InfluxDB Cloud:
- returns this error if a **read** or **write** request exceeds your
plan's [adjustable service quotas](/influxdb/cloud-dedicated/account-management/limits/#adjustable-service-quotas)
plan's [adjustable service quotas](/influxdb3/cloud-dedicated/account-management/limits/#adjustable-service-quotas)
or if a **delete** request exceeds the maximum
[global limit](/influxdb/cloud-dedicated/account-management/limits/#global-limits)
[global limit](/influxdb3/cloud-dedicated/account-management/limits/#global-limits)
- returns `Retry-After` header that describes when to try the write again.
headers:
Retry-After:
@ -583,19 +583,19 @@ paths:
description: |
Writes data to a database.
Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB.
Use this endpoint for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/) when sending data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) format to InfluxDB.
InfluxDB Cloud Dedicated does the following when you send a write request:
InfluxDB 3 Cloud Dedicated does the following when you send a write request:
1. Validates the request.
2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes).
2. If successful, attempts to [ingest data](/influxdb3/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb3/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes).
3. Ingests or rejects data in the batch and returns one of the following HTTP status codes:
- `204 No Content`: all data in the batch is ingested
- `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected
- `400 Bad Request`: all data is rejected
The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
The response body contains error details about [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
Writes are synchronous--the response status indicates the final status of the write and all ingested data is queryable.
@ -604,17 +604,17 @@ paths:
#### Write endpoints
The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB Cloud Dedicated.
The [`/write`](#operation/PostLegacyWrite) and [`/api/v2/write`](#operation/PostWrite) endpoints are functionally equivalent for writing data to InfluxDB 3 Cloud Dedicated.
- Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v1/).
- Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb/cloud-dedicated/guides/api-compatibility/v2/).
- Use the [`/write` endpoint](#operation/PostLegacyWrite) for [InfluxDB v1 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
- Use the [`/api/v2/write` endpoint](#operation/PostWrite) for [InfluxDB v2 parameter compatibility](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
#### Related guides
- [Get started writing data](/influxdb/cloud-dedicated/get-started/write/)
- [Write data](/influxdb/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/cloud-dedicated/write-data/troubleshoot/)
- [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/)
- [Write data](/influxdb3/cloud-dedicated/write-data/)
- [Best practices for writing data](/influxdb3/cloud-dedicated/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb3/cloud-dedicated/write-data/troubleshoot/)
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: The InfluxDB 1.x username to authenticate the request.
@ -668,7 +668,7 @@ paths:
Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected.
If a partial write occurred, then some points from the batch are written and queryable.
The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
The response body contains details about the [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
content:
application/json:
examples:
@ -710,7 +710,7 @@ paths:
The request contained data outside the databases retention period. InfluxDB rejected the batch and wrote no data.
The response body contains details about the [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points).
The response body contains details about the [rejected points](/influxdb3/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points).
'429':
description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
headers:
@ -928,7 +928,7 @@ components:
orgID:
description: |
An organization ID.
Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
type: string
retention_policy:
description: |
@ -966,12 +966,12 @@ components:
org:
description: |
An organization name.
Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
type: string
orgID:
description: |
An organization ID.
Identifies the [organization](/influxdb/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/cloud-dedicated/reference/glossary/#organization) that owns the mapping.
type: string
retention_policy:
description: |
@ -1009,7 +1009,7 @@ components:
$ref: '#/components/schemas/DBRP'
type: array
DateTimeLiteral:
description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp).
description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp).
properties:
type:
$ref: '#/components/schemas/NodeType'
@ -1033,18 +1033,18 @@ components:
properties:
predicate:
description: |
An expression in [delete predicate syntax](/influxdb/cloud-dedicated/reference/syntax/delete-predicate/).
An expression in [delete predicate syntax](/influxdb3/cloud-dedicated/reference/syntax/delete-predicate/).
example: tag1="value1" and (tag2="value2" and tag3!="value3")
type: string
start:
description: |
A timestamp ([RFC3339 date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp)).
A timestamp ([RFC3339 date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp)).
The earliest time to delete from.
format: date-time
type: string
stop:
description: |
A timestamp ([RFC3339 date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp)).
A timestamp ([RFC3339 date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp)).
The latest time to delete from.
format: date-time
type: string
@ -1055,7 +1055,7 @@ components:
Dialect:
description: |
Options for tabular data output.
Default output is [annotated CSV](/influxdb/cloud-dedicated/reference/syntax/annotated-csv/#csv-response-format) with headers.
Default output is [annotated CSV](/influxdb3/cloud-dedicated/reference/syntax/annotated-csv/#csv-response-format) with headers.
For more information about tabular data **dialect**,
see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions).
@ -1067,7 +1067,7 @@ components:
#### Related guides
- See [Annotated CSV annotations](/influxdb/cloud-dedicated/reference/syntax/annotated-csv/#annotations) for examples and more information.
- See [Annotated CSV annotations](/influxdb3/cloud-dedicated/reference/syntax/annotated-csv/#annotations) for examples and more information.
For more information about **annotations** in tabular data,
see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns).
@ -1089,7 +1089,7 @@ components:
default: RFC3339
description: |
The format for timestamps in results.
Default is [`RFC3339` date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
Default is [`RFC3339` date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
To include nanoseconds in timestamps, use `RFC3339Nano`.
#### Example formatted date/time values
@ -1629,7 +1629,7 @@ components:
readOnly: true
type: string
time:
description: The time ([RFC3339Nano date/time format](/influxdb/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.
description: The time ([RFC3339Nano date/time format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.
example: 2006-01-02T15:04:05.999999999Z07:00
format: date-time
readOnly: true
@ -1824,7 +1824,7 @@ components:
type: integer
shardGroupDurationSeconds:
description: |
The [shard group duration](/influxdb/cloud-dedicated/reference/glossary/#shard).
The [shard group duration](/influxdb3/cloud-dedicated/reference/glossary/#shard).
The number of seconds that each shard group covers.
#### InfluxDB Cloud
@ -1833,7 +1833,7 @@ components:
#### Related guides
- InfluxDB [shards and shard groups](/influxdb/cloud-dedicated/reference/internals/shards/)
- InfluxDB [shards and shard groups](/influxdb3/cloud-dedicated/reference/internals/shards/)
format: int64
type: integer
type:
@ -1910,7 +1910,7 @@ components:
RetentionRules:
description: |
Retention rules to expire or retain data.
The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/cloud-dedicated/reference/glossary/#retention-period).
The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb3/cloud-dedicated/reference/glossary/#retention-period).
#### InfluxDB Cloud
@ -1977,8 +1977,8 @@ components:
### Basic authentication scheme
Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests.
When authenticating requests, InfluxDB Cloud Dedicated checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/cloud-dedicated/admin/tokens/).
InfluxDB Cloud Dedicated ignores the `username` part of the decoded credential.
When authenticating requests, InfluxDB 3 Cloud Dedicated checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/).
InfluxDB 3 Cloud Dedicated ignores the `username` part of the decoded credential.
### Syntax
@ -1988,13 +1988,13 @@ components:
Replace the following:
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB Cloud Dedicated).
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/).
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Cloud Dedicated).
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/).
- Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header.
### Example
The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb/cloud-dedicated/admin/tokens/):
The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb3/cloud-dedicated/admin/tokens/):
```sh
#######################################
@ -2012,8 +2012,8 @@ components:
Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
- **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
scheme: basic
type: http
QuerystringAuthentication:
@ -2027,7 +2027,7 @@ components:
### Query string authentication
In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests.
When authenticating requests, InfluxDB Cloud Dedicated checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter.
When authenticating requests, InfluxDB 3 Cloud Dedicated checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter.
### Syntax
@ -2038,7 +2038,7 @@ components:
### Example
The following example shows how to use cURL with query string authentication and a [database token](/influxdb/cloud-dedicated/admin/tokens/).
The following example shows how to use cURL with query string authentication and a [database token](/influxdb3/cloud-dedicated/admin/tokens/).
```sh
#######################################
@ -2057,8 +2057,8 @@ components:
Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
- **`DATABASE_NAME`**: your InfluxDB 3 Cloud Dedicated database
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/) with sufficient permissions to the database
BearerAuthentication:
type: http
scheme: bearer
@ -2092,8 +2092,8 @@ components:
```
For examples and more information, see the following:
- [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/)
- [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/)
TokenAuthentication:
description: |
Use the Token authentication
@ -2124,8 +2124,8 @@ components:
### Related guides
- [Authenticate API requests](/influxdb/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/cloud-dedicated/admin/tokens/)
- [Authenticate API requests](/influxdb3/cloud-dedicated/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb3/cloud-dedicated/admin/tokens/)
in: header
name: Authorization
type: apiKey

View File

@ -1,9 +1,9 @@
plugins:
- '../openapi/plugins/docs-plugin.js'
- '../../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all
x-influxdata-product-name: InfluxDB v3 Clustered
x-influxdata-product-name: InfluxDB 3 Serverless
apis:
v2@2:

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
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Serverless bucket.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -9,7 +9,7 @@ description: |
#### Related
[InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Cloud Serverless](/influxdb3/cloud-serverless/api/v2/)
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'

View File

@ -1,6 +1,6 @@
openapi: 3.0.0
info:
title: InfluxDB v1 HTTP API for InfluxDB Cloud Serverless
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless
version: ''
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -10,11 +10,11 @@ info:
#### Related
[InfluxDB `/api/v2` API for InfluxDB Cloud Serverless](/influxdb/cloud-serverless/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Cloud Serverless](/influxdb3/cloud-serverless/api/v2/)
license:
name: MIT
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Cloud Serverless bucket.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
servers:
- url: /
security:

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
summary: |
The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket.
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
description: |
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance.
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

View File

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

View File

@ -1,9 +1,9 @@
plugins:
- '../openapi/plugins/docs-plugin.js'
- '../../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all
x-influxdata-product-name: InfluxDB v3 Serverless
x-influxdata-product-name: InfluxDB 3 Clustered
apis:
v2@2:

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
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Clustered database.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -9,7 +9,7 @@ description: |
#### Related
[InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Clustered](/influxdb3/clustered/api/v2/)
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'

View File

@ -1,6 +1,6 @@
openapi: 3.0.0
info:
title: InfluxDB v1 HTTP API for InfluxDB Clustered
title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered
version: ''
description: |
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
@ -10,11 +10,11 @@ info:
#### Related
[InfluxDB `/api/v2` API for InfluxDB Clustered](/influxdb/clustered/api/v2/)
[InfluxDB `/api/v2` API for InfluxDB 3 Clustered](/influxdb3/clustered/api/v2/)
license:
name: MIT
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB v3 Clustered database.
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
servers:
- url: /
security:

View File

@ -1,8 +1,8 @@
title: InfluxDB Clustered API Service
title: InfluxDB 3 Clustered API Service
x-influxdata-short-title: v2 API
summary: The InfluxDB v2 HTTP API for InfluxDB Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Clustered database.
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
description: |
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance.
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).

View File

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

View File

@ -1,25 +1,25 @@
openapi: 3.0.0
info:
title: InfluxDB Clustered API Service
title: InfluxDB 3 Clustered API Service
version: ''
description: |
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB v3 instance.
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
license:
name: MIT
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v2 HTTP API for InfluxDB Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Clustered database.
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
servers:
- url: https://{baseurl}
description: InfluxDB Clustered API URL
description: InfluxDB 3 Clustered API URL
variables:
baseurl:
enum:
- cluster-host.com
default: cluster-host.com
description: InfluxDB Clustered URL
description: InfluxDB 3 Clustered URL
security:
- BearerAuthentication: []
- TokenAuthentication: []
@ -29,32 +29,32 @@ tags:
- description: |
### Write data
InfluxDB Clustered provides the following HTTP API endpoints for writing data:
InfluxDB 3 Clustered provides the following HTTP API endpoints for writing data:
- **Recommended**: [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to v3.
- [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to v3.
- **Recommended**: [`/api/v2/write` endpoint](/influxdb3/clustered/api/#operation/PostWrite) for new write workloads or for bringing existing InfluxDB v2 write workloads to InfluxDB 3.
- [`/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite) for bringing existing InfluxDB v1 write workloads to InfluxDB 3.
Both endpoints accept the same line protocol format and process data in the same way.
### Query data
InfluxDB Clustered provides the following protocols for executing a query:
InfluxDB 3 Clustered provides the following protocols for executing a query:
- **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb/clustered/get-started/query/).
- HTTP API [`/query` request](/influxdb/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL query.
Use this protocol when bringing existing InfluxDB v1 query workloads to v3.
- **Recommended**: _Flight+gRPC_ request that contains an SQL or InfluxQL query. See how to [get started querying InfluxDB using Flight and SQL](/influxdb3/clustered/get-started/query/).
- HTTP API [`/query` request](/influxdb3/clustered/api/#operation/GetLegacyQuery) that contains an InfluxQL query.
Use this protocol when bringing existing InfluxDB v1 query workloads to InfluxDB 3.
### InfluxDB v2 compatibility
The HTTP API [`/api/v2/write` endpoint](/influxdb/clustered/api/#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb/clustered/write-data/).
The HTTP API [`/api/v2/write` endpoint](/influxdb3/clustered/api/#operation/PostWrite) works with the [`Bearer`](#section/Authentication/BearerAuthentication) and [`Token`](#section/Authentication/TokenAuthentication) authentication schemes and existing InfluxDB 2.x tools and code for [writing data](/influxdb3/clustered/write-data/).
See how to [use the InfluxDB v2 HTTP API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v2/).
See how to [use the InfluxDB v2 HTTP API with InfluxDB 3 Clustered ](/influxdb3/clustered/guides/api-compatibility/v2/).
### InfluxDB v1 compatibility
The HTTP API [`/write` endpoint](/influxdb/clustered/api/#operation/PostLegacyWrite) and [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
The HTTP API [`/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite) and [`/query` endpoint](/influxdb3/clustered/api/#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
See how to [use the InfluxDB v1 HTTP API with InfluxDB Clustered ](/influxdb/clustered/guides/api-compatibility/v1/).
See how to [use the InfluxDB v1 HTTP API with InfluxDB 3 Clustered ](/influxdb3/clustered/guides/api-compatibility/v1/).
name: API compatibility
x-traitTag: true
- description: |
@ -100,21 +100,21 @@ tags:
- description: |
Query data stored in a database.
- HTTP clients can query the v1 [`/query` endpoint](/influxdb/clustered/api/#operation/GetLegacyQuery)
- HTTP clients can query the v1 [`/query` endpoint](/influxdb3/clustered/api/#operation/GetLegacyQuery)
using **InfluxQL** and retrieve data in **CSV** or **JSON** format.
- The `/api/v2/query` endpoint can't query InfluxDB Clustered.
- The `/api/v2/query` endpoint can't query InfluxDB 3 Clustered.
- _Flight + gRPC_ clients can query using **SQL** or **InfluxQL** and retrieve data in **Arrow** format.
#### Related guides
- [Get started querying InfluxDB](/influxdb/clustered/get-started/query/)
- [Execute queries](/influxdb/clustered/query-data/execute-queries/)
- [Get started querying InfluxDB](/influxdb3/clustered/get-started/query/)
- [Execute queries](/influxdb3/clustered/query-data/execute-queries/)
name: Query
- description: |
See the [**Get Started**](/influxdb/clustered/get-started/) tutorial
See the [**Get Started**](/influxdb3/clustered/get-started/) tutorial
to get up and running authenticating with tokens, writing to databases, and querying data.
[**InfluxDB API client libraries and Flight clients**](/influxdb/clustered/reference/client-libraries/)
[**InfluxDB API client libraries and Flight clients**](/influxdb3/clustered/reference/client-libraries/)
are available to integrate InfluxDB APIs with your application.
name: Quick start
x-traitTag: true
@ -131,7 +131,7 @@ tags:
| `200` | Success | |
| `204` | Success. No content | InfluxDB doesn't return data for the request. For example, a successful write request returns `204` status code, acknowledging that data is written and queryable. |
| `400` | Bad request | InfluxDB can't parse the request due to an incorrect parameter or bad syntax. If line protocol in the request body is malformed. The response body contains the first malformed line and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. |
| `401` | Unauthorized | May indicate one of the following: <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. |
| `405` | Method not allowed | The API path doesn't support the HTTP method used in the request--for example, you send a `POST` request to an endpoint that only allows `GET`. |
| `413` | Request entity too large | Request payload exceeds the size limit. |
@ -144,7 +144,7 @@ tags:
- name: System information endpoints
- name: Usage
- description: |
Write time series data to [databases](/influxdb/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints.
Write time series data to [databases](/influxdb3/clustered/admin/databases/) using InfluxDB v1 or v2 endpoints.
name: Write
paths:
/ping:
@ -222,12 +222,12 @@ paths:
description: |
Writes data to a database.
Use this endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB.
Use this endpoint to send data in [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) format to InfluxDB.
InfluxDB does the following when you send a write request:
1. Validates the request
2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise.
2. If successful, attempts to [ingest the data](/influxdb3/clustered/reference/internals/durability/#data-ingest); _error_ otherwise.
3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise.
To ensure that InfluxDB Cloud handles writes in the order you request them,
@ -235,10 +235,10 @@ paths:
#### Related guides
- [Get started writing data](/influxdb/clustered/get-started/write/)
- [Write data](/influxdb/clustered/write-data/)
- [Best practices for writing data](/influxdb/clustered/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/)
- [Get started writing data](/influxdb3/clustered/get-started/write/)
- [Write data](/influxdb3/clustered/write-data/)
- [Best practices for writing data](/influxdb3/clustered/write-data/best-practices/)
- [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
operationId: PostWrite
parameters:
- $ref: '#/components/parameters/TraceSpan'
@ -288,7 +288,7 @@ paths:
#### Related guides
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/)
- [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
in: header
name: Accept
schema:
@ -343,7 +343,7 @@ paths:
format: byte
type: string
description: |
In the request body, provide data in [line protocol format](/influxdb/clustered/reference/syntax/line-protocol/).
In the request body, provide data in [line protocol format](/influxdb3/clustered/reference/syntax/line-protocol/).
To send compressed data, do the following:
@ -353,7 +353,7 @@ paths:
#### Related guides
- [Best practices for optimizing writes](/influxdb/clustered/write-data/best-practices/optimize-writes/)
- [Best practices for optimizing writes](/influxdb3/clustered/write-data/best-practices/optimize-writes/)
required: true
responses:
'204':
@ -415,8 +415,8 @@ paths:
#### InfluxDB Cloud
- Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas)
or if a **delete** request exceeds the maximum [global limit](/influxdb/clustered/account-management/limits/#global-limits).
- Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas)
or if a **delete** request exceeds the maximum [global limit](/influxdb3/clustered/account-management/limits/#global-limits).
- For rate limits that reset automatically, returns a `Retry-After` header that describes when to try the write again.
- For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header.
@ -462,7 +462,7 @@ paths:
description: |
Media type that the client can understand.
**Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb/clustered/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp).
**Note**: With `application/csv`, query results include [**unix timestamps**](/influxdb3/clustered/reference/glossary/#unix-timestamp) instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp).
enum:
- application/json
- application/csv
@ -496,7 +496,7 @@ paths:
schema:
type: string
- description: |
The [database](/influxdb/clustered/admin/databases/) to query data from.
The [database](/influxdb3/clustered/admin/databases/) to query data from.
in: query
name: db
required: true
@ -504,7 +504,7 @@ paths:
type: string
- description: |
The retention policy to query data from.
For more information, see [InfluxQL DBRP naming convention](/influxdb/clustered/admin/databases/create/#influxql-dbrp-naming-convention).
For more information, see [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention).
in: query
name: rp
schema:
@ -517,8 +517,8 @@ paths:
type: string
- description: |
A unix timestamp precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb/clustered/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
Formats timestamps as [unix (epoch) timestamps](/influxdb3/clustered/reference/glossary/#unix-timestamp) the specified precision
instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
in: query
name: epoch
schema:
@ -575,9 +575,9 @@ paths:
description: |
#### InfluxDB Cloud:
- returns this error if a **read** or **write** request exceeds your
plan's [adjustable service quotas](/influxdb/clustered/account-management/limits/#adjustable-service-quotas)
plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas)
or if a **delete** request exceeds the maximum
[global limit](/influxdb/clustered/account-management/limits/#global-limits)
[global limit](/influxdb3/clustered/account-management/limits/#global-limits)
- returns `Retry-After` header that describes when to try the write again.
headers:
Retry-After:
@ -649,7 +649,7 @@ paths:
description: |
Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected.
If a partial write occurred, then some points from the batch are written and queryable.
The response body contains details about the [rejected points](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
The response body contains details about the [rejected points](/influxdb3/clustered/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
content:
application/json:
examples:
@ -710,12 +710,12 @@ paths:
description: |
Writes data to a database.
Use this InfluxDB v1-compatible endpoint to send data in [line protocol](/influxdb/clustered/reference/syntax/line-protocol/) format to InfluxDB using v1 API parameters and authorization.
Use this InfluxDB v1-compatible endpoint to send data in [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) format to InfluxDB using v1 API parameters and authorization.
InfluxDB does the following when you send a write request:
1. Validates the request
2. If successful, attempts to [ingest the data](/influxdb/clustered/reference/internals/durability/#data-ingest); _error_ otherwise.
2. If successful, attempts to [ingest the data](/influxdb3/clustered/reference/internals/durability/#data-ingest); _error_ otherwise.
3. If successful, responds with _success_ (HTTP `204` status code), acknowledging that the data is written and queryable; _error_ otherwise.
To ensure that InfluxDB handles writes in the order you request them,
@ -723,9 +723,9 @@ paths:
#### Related guides
- [Write data with the InfluxDB API](/influxdb/clustered/get-started/write/)
- [Optimize writes to InfluxDB](/influxdb/clustered/write-data/best-practices/optimize-writes/)
- [Troubleshoot issues writing data](/influxdb/clustered/write-data/troubleshoot/)
- [Write data with the InfluxDB API](/influxdb3/clustered/get-started/write/)
- [Optimize writes to InfluxDB](/influxdb3/clustered/write-data/best-practices/optimize-writes/)
- [Troubleshoot issues writing data](/influxdb3/clustered/write-data/troubleshoot/)
summary: Write data using the InfluxDB v1 HTTP API
tags:
- Write
@ -920,7 +920,7 @@ components:
orgID:
description: |
An organization ID.
Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping.
type: string
retention_policy:
description: |
@ -958,12 +958,12 @@ components:
org:
description: |
An organization name.
Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping.
type: string
orgID:
description: |
An organization ID.
Identifies the [organization](/influxdb/clustered/reference/glossary/#organization) that owns the mapping.
Identifies the [organization](/influxdb3/clustered/reference/glossary/#organization) that owns the mapping.
type: string
retention_policy:
description: |
@ -1001,7 +1001,7 @@ components:
$ref: '#/components/schemas/DBRP'
type: array
DateTimeLiteral:
description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp).
description: Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp).
properties:
type:
$ref: '#/components/schemas/NodeType'
@ -1025,18 +1025,18 @@ components:
properties:
predicate:
description: |
An expression in [delete predicate syntax](/influxdb/clustered/reference/syntax/delete-predicate/).
An expression in [delete predicate syntax](/influxdb3/clustered/reference/syntax/delete-predicate/).
example: tag1="value1" and (tag2="value2" and tag3!="value3")
type: string
start:
description: |
A timestamp ([RFC3339 date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp)).
A timestamp ([RFC3339 date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp)).
The earliest time to delete from.
format: date-time
type: string
stop:
description: |
A timestamp ([RFC3339 date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp)).
A timestamp ([RFC3339 date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp)).
The latest time to delete from.
format: date-time
type: string
@ -1047,7 +1047,7 @@ components:
Dialect:
description: |
Options for tabular data output.
Default output is [annotated CSV](/influxdb/clustered/reference/syntax/annotated-csv/#csv-response-format) with headers.
Default output is [annotated CSV](/influxdb3/clustered/reference/syntax/annotated-csv/#csv-response-format) with headers.
For more information about tabular data **dialect**,
see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions).
@ -1059,7 +1059,7 @@ components:
#### Related guides
- See [Annotated CSV annotations](/influxdb/clustered/reference/syntax/annotated-csv/#annotations) for examples and more information.
- See [Annotated CSV annotations](/influxdb3/clustered/reference/syntax/annotated-csv/#annotations) for examples and more information.
For more information about **annotations** in tabular data,
see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns).
@ -1081,7 +1081,7 @@ components:
default: RFC3339
description: |
The format for timestamps in results.
Default is [`RFC3339` date/time format](/influxdb/clustered/reference/glossary/#rfc3339-timestamp).
Default is [`RFC3339` date/time format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp).
To include nanoseconds in timestamps, use `RFC3339Nano`.
#### Example formatted date/time values
@ -1621,7 +1621,7 @@ components:
readOnly: true
type: string
time:
description: The time ([RFC3339Nano date/time format](/influxdb/clustered/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.
description: The time ([RFC3339Nano date/time format](/influxdb3/clustered/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.
example: 2006-01-02T15:04:05.999999999Z07:00
format: date-time
readOnly: true
@ -1816,7 +1816,7 @@ components:
type: integer
shardGroupDurationSeconds:
description: |
The [shard group duration](/influxdb/clustered/reference/glossary/#shard).
The [shard group duration](/influxdb3/clustered/reference/glossary/#shard).
The number of seconds that each shard group covers.
#### InfluxDB Cloud
@ -1825,7 +1825,7 @@ components:
#### Related guides
- InfluxDB [shards and shard groups](/influxdb/clustered/reference/internals/shards/)
- InfluxDB [shards and shard groups](/influxdb3/clustered/reference/internals/shards/)
format: int64
type: integer
type:
@ -1902,7 +1902,7 @@ components:
RetentionRules:
description: |
Retention rules to expire or retain data.
The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb/clustered/reference/glossary/#retention-period).
The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](/influxdb3/clustered/reference/glossary/#retention-period).
#### InfluxDB Cloud
@ -1969,8 +1969,8 @@ components:
### Basic authentication scheme
Use the `Authorization` header with the `Basic` scheme to authenticate v1 API `/write` and `/query` requests.
When authenticating requests, InfluxDB Clustered checks that the `password` part of the decoded credential is an authorized [database token](/influxdb/clustered/admin/tokens/#database-tokens).
InfluxDB Clustered ignores the `username` part of the decoded credential.
When authenticating requests, InfluxDB 3 Clustered checks that the `password` part of the decoded credential is an authorized [database token](/influxdb3/clustered/admin/tokens/#database-tokens).
InfluxDB 3 Clustered ignores the `username` part of the decoded credential.
### Syntax
@ -1980,13 +1980,13 @@ components:
Replace the following:
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB Clustered).
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens).
- **`[USERNAME]`**: an optional string value (ignored by InfluxDB 3 Clustered).
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens).
- Encode the `[USERNAME]:DATABASE_TOKEN` credential using base64 encoding, and then append the encoded string to the `Authorization: Basic` header.
### Example
The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb/clustered/admin/tokens/#database-tokens):
The following example shows how to use cURL with the `Basic` authentication scheme and a [database token](/influxdb3/clustered/admin/tokens/#database-tokens):
```sh
#######################################
@ -2004,8 +2004,8 @@ components:
Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
- **`DATABASE_NAME`**: your InfluxDB 3 Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
scheme: basic
type: http
QuerystringAuthentication:
@ -2019,7 +2019,7 @@ components:
### Query string authentication
In the URL, pass the `p` query parameter to authenticate `/write` and `/query` requests.
When authenticating requests, InfluxDB Clustered checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter.
When authenticating requests, InfluxDB 3 Clustered checks that `p` (_password_) is an authorized database token and ignores the `u` (_username_) parameter.
### Syntax
@ -2030,7 +2030,7 @@ components:
### Example
The following example shows how to use cURL with query string authentication and a [database token](/influxdb/clustered/admin/tokens/#database-tokens).
The following example shows how to use cURL with query string authentication and a [database token](/influxdb3/clustered/admin/tokens/#database-tokens).
```sh
#######################################
@ -2049,8 +2049,8 @@ components:
Replace the following:
- **`DATABASE_NAME`**: your InfluxDB Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
- **`DATABASE_NAME`**: your InfluxDB 3 Clustered database
- **`DATABASE_TOKEN`**: a [database token](/influxdb3/clustered/admin/tokens/#database-tokens) with sufficient permissions to the database
BearerAuthentication:
type: http
scheme: bearer
@ -2084,8 +2084,8 @@ components:
```
For examples and more information, see the following:
- [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/clustered/admin/tokens/)
- [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb3/clustered/admin/tokens/)
TokenAuthentication:
description: |
Use the Token authentication
@ -2116,8 +2116,8 @@ components:
### Related guides
- [Authenticate API requests](/influxdb/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb/clustered/admin/tokens/)
- [Authenticate API requests](/influxdb3/clustered/primers/api/v2/#authenticate-api-requests)
- [Manage tokens](/influxdb3/clustered/admin/tokens/)
in: header
name: Authorization
type: apiKey

View File

@ -131,7 +131,7 @@ function updateTimestamps (newStartDate) {
oldDatePart = datePart(x.rfc3339.replace(/T.*$/, ''));
newDatePart = datePart(x.rfc3339_new.replace(/T.*$/, ''));
rfc3339Regex = new RegExp(
`${oldDatePart.year}(.*)${oldDatePart.month}(.*)${oldDatePart.day}`,
`${oldDatePart.year}(.*?)${oldDatePart.month}(.*?)${oldDatePart.day}`,
'g'
);
rfc3339Repl = `${newDatePart.year}$1${newDatePart.month}$2${newDatePart.day}`;

View File

@ -56,6 +56,10 @@ a.btn {
margin-right: -.65rem;
}
&.small {
padding: .4rem 1rem;
}
&.small-plus {
padding: .25em;
line-height: .65rem;

View File

@ -141,6 +141,7 @@ The `/api/v2/write` endpoint maps the supplied version 1.x database and retentio
to access the platform and all its capabilities.
InfluxDB v1.x uses a username and password combination when accessing the HTTP APIs.
Use the Token schema to provide your InfluxDB 1.x username and password separated by a colon (`:`).
The `Token` scheme is the word `Token`, a space, and your credentials (all case-sensitive).
For example: `Authorization: Token username:password`.
{{< code-tabs-wrapper >}}

View File

@ -36,6 +36,7 @@ Token authentication requires the following credential:
- **token**: InfluxDB [API token](/influxdb/v2/admin/tokens/)
Use the `Authorization` header with the `Token` scheme to provide your token to InfluxDB.
The `Token` scheme is the word `Token`, a space, and your token (all case-sensitive).
#### Syntax

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -68,7 +68,7 @@ With the InfluxDB v1 API, you can use database tokens in InfluxDB 1.x username a
schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Authorization: Bearer` scheme.
- [Authenticate with a username and password scheme](#authenticate-with-a-username-and-password-scheme)
- [Authenticate with a token scheme](#authenticate-with-a-token)
- [Authenticate with a token scheme](#authenticate-with-a-token-scheme)
### Authenticate with a username and password scheme
@ -158,6 +158,8 @@ The `Token` scheme is used in the InfluxDB 2.x API.
`Bearer` is defined by the [OAuth 2.0 Framework](https://www.rfc-editor.org/rfc/rfc6750#page-14).
Support for one or the other may vary across InfluxDB API clients.
Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive).
#### Syntax
```http

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -54,7 +54,7 @@ With the InfluxDB v1 API, you can use API tokens in InfluxDB 1.x username and pa
schemes or in the InfluxDB v2 `Authorization: Token` scheme.
- [Authenticate with a username and password scheme](#authenticate-with-a-username-and-password-scheme)
- [Authenticate with a token scheme](#authenticate-with-a-token)
- [Authenticate with a token scheme](#authenticate-with-a-token-scheme)
### Authenticate with a username and password scheme
@ -151,6 +151,8 @@ Replace the following:
Use the `Authorization: Token` scheme to pass a [token](/influxdb3/cloud-serverless/admin/tokens/) for authenticating
v1 API `/write` and `/query` requests.
Include the word `Token`, a space, and your **token** value (all case-sensitive).
#### Syntax
```http

View File

@ -4,7 +4,7 @@ seotitle: InfluxDB schema design recommendations and best practices
description: >
Design your schema for simpler and more performant queries.
menu:
influxdb_cloud_serverless:
influxdb3_cloud_serverless:
name: Schema design
weight: 201
parent: write-best-practices

View File

@ -69,7 +69,7 @@ The only way to revoke the token is to do the following:
kubectl delete secret rsa-keys admin-token --namespace INFLUXDB_NAMESPACE
```
2. Rerun the `key-gen` and `create-amin-token` jobs:
2. Rerun the `key-gen` and `create-admin-token` jobs:
1. List the jobs in your InfluxDB namespace to find the key-gen job pod:

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -450,7 +450,9 @@ Include the following with your request:
With the {{% product-name %}}
[v1 API `/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite),
`Authorization: Bearer` and `Authorization: Token` are equivalent and you can
use either scheme to pass a database token in your request. For more information
use either scheme to pass a database token in your request.
Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive).
For more information
about HTTP API token schemes, see how to
[authenticate API requests](/influxdb3/clustered/guides/api-compatibility/v1/).
{{% /note %}}

View File

@ -67,7 +67,7 @@ With the InfluxDB v1 API, you can use database tokens in InfluxDB 1.x username a
schemes, in the InfluxDB v2 `Authorization: Token` scheme, or in the OAuth `Authorization: Bearer` scheme.
- [Authenticate with a username and password scheme](#authenticate-with-a-username-and-password-scheme)
- [Authenticate with a token scheme](#authenticate-with-a-token)
- [Authenticate with a token scheme](#authenticate-with-a-token-scheme)
### Authenticate with a username and password scheme
@ -155,6 +155,8 @@ The `Token` scheme is used in the InfluxDB 2.x API.
`Bearer` is defined by the [OAuth 2.0 Framework](https://www.rfc-editor.org/rfc/rfc6750#page-14).
Support for one or the other may vary across InfluxDB API clients.
Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive).
#### Syntax
```http

View File

@ -4,7 +4,7 @@ seotitle: InfluxDB schema design recommendations and best practices
description: >
Design your schema for simpler and more performant queries.
menu:
influxdb_clustered:
influxdb3_clustered:
name: Schema design
weight: 201
parent: write-best-practices

View File

@ -2,8 +2,9 @@
title: InfluxDB 3 Core documentation
description: >
InfluxDB 3 Core is an open source time series database designed and optimized
for real-time and recent data (last 72 hours).
Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events.
for real-time and recent data.
Learn how to use and leverage InfluxDB 3 in use cases such as edge data
collection, IoT data, and events.
menu:
influxdb3_core:
name: InfluxDB 3 Core

View File

@ -2,8 +2,9 @@
title: Get started with InfluxDB 3 Core
description: >
InfluxDB 3 Core is an open source time series database designed and optimized
for real-time and recent data (last 72 hours).
Learn how to use and leverage InfluxDB 3 in use cases such as edge data collection, IoT data, and events.
for real-time and recent data.
Learn how to use and leverage InfluxDB 3 in use cases such as edge data
collection, IoT data, and events.
menu:
influxdb3_core:
name: Get started

View File

@ -25,8 +25,9 @@ InfluxDB 3 Core runs on **Linux**, **macOS**, and **Windows**.
A key feature of InfluxDB 3 is its use of object storage to store time series
data in Apache Parquet format. You can choose to store these files on your local
file system, however, we recommend using an object store for the best overall
performance. {{< product-name >}} natively supports Amazon S3,
file system. Performance on your local filesystem will likely be better, but
object storage has the advantage of not running out of space and being accessible
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
Azure Blob Storage, and Google Cloud Storage.
You can also use many local object storage implementations that provide an
S3-compatible API, such as [Minio](https://min.io/).

View File

@ -0,0 +1,15 @@
---
title: Query data in {{< product-name >}}
description: >
Learn to query data stored in InfluxDB using SQL and InfluxQL.
menu:
influxdb3_core:
name: Query data
weight: 4
influxdb3/core/tags: [query]
source: /shared/influxdb3-query-guides/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/_index.md
-->

View File

@ -0,0 +1,20 @@
---
title: Execute queries
description: >
Use tools and libraries to query data stored in {{< product-name >}}.
weight: 101
menu:
influxdb3_core:
name: Execute queries
parent: Query data
influxdb3/core/tags: [query, sql, influxql]
aliases:
- /influxdb3/core/query-data/tools/
- /influxdb3/core/query-data/sql/execute-queries/
- /influxdb3/core/query-data/influxql/execute-queries/
source: /shared/influxdb3-query-guides/execute-queries/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/execute-queries/_index.md
-->

View File

@ -0,0 +1,31 @@
---
title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
seotitle: Use InfluxQL and InfluxDB v1 HTTP query API
list_title: Use the v1 query API and InfluxQL
description: >
Use the InfluxDB v1 HTTP query API to query data in {{< product-name >}}
with InfluxQL.
weight: 302
menu:
influxdb3_core:
parent: Execute queries
name: Use the v1 query API
influxdb3/core/tags: [query, influxql, python]
metadata: [InfluxQL]
related:
- /influxdb3/core/api-compatibility/v1/
aliases:
- /influxdb3/core/query-data/influxql/execute-queries/influxdb-v1-api/
list_code_example: |
```sh
curl --get http://{{< influxdb/host >}}/query \
--header "Authorization: Token DATABASE_TOKEN" \
--data-urlencode "db=DATABASE_NAME" \
--data-urlencode "q=SELECT * FROM home"
```
source: /shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md
-->

View File

@ -0,0 +1,28 @@
---
title: Use the influxdb3 CLI to query data
list_title: Use the influxdb3 CLI
description: >
Use the `influxdb3 query` command to query data in {{< product-name >}} with SQL.
weight: 301
menu:
influxdb3_core:
parent: Execute queries
name: Use the influxdb3 CLI
influxdb3/core/tags: [query, sql, influxql, influxdb3, CLI]
related:
- /influxdb3/core/reference/cli/influxdb3/query/
- /influxdb3/core/reference/sql/
- /influxdb3/core/reference/influxql/
# - /influxdb3/core/get-started/query/#execute-an-sql-query, Get started querying data
list_code_example: |
```sh
influxdb3 query \
--database DATABASE_NAME \
"SELECT * FROM home"
```
source: /shared/influxdb3-query-guides/execute-queries/influxdb3-cli.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/execute-queries/influxdb3-cli.md
-->

View File

@ -0,0 +1,16 @@
---
title: Query data with InfluxQL
description: >
Learn to use InfluxQL to query data stored in {{< product-name >}}.
menu:
influxdb3_core:
name: Query with InfluxQL
parent: Query data
weight: 102
influxdb3/core/tags: [query, influxql]
source: /shared/influxdb3-query-guides/influxql/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/_index.md
-->

View File

@ -0,0 +1,41 @@
---
title: Aggregate data with InfluxQL
seotitle: Aggregate or apply selector functions to data with InfluxQL
description: >
Use InfluxQL aggregate and selector functions to perform aggregate operations
on your time series data.
menu:
influxdb3_core:
name: Aggregate data
parent: Query with InfluxQL
identifier: query-influxql-aggregate
weight: 203
influxdb3/core/tags: [query, influxql]
related:
- /influxdb3/core/reference/influxql/functions/aggregates/
- /influxdb3/core/reference/influxql/functions/selectors/
list_code_example: |
##### Aggregate fields by groups
```sql
SELECT
MEAN(temp) AS mean,
FIRST(hum) as first,
FROM home
GROUP BY tag
```
##### Aggregate by time-based intervals
```sql
SELECT
MEAN(temp),
sum(hum),
FROM home
WHERE time >= now() - 24h
GROUP BY time(1h),room
```
source: /shared/influxdb3-query-guides/influxql/aggregate-select.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/aggregate-select.md
-->

View File

@ -0,0 +1,23 @@
---
title: Perform a basic InfluxQL query
seotitle: Perform a basic InfluxQL query in {{< product-name >}}
description: >
A basic InfluxQL query that queries data from InfluxDB most commonly includes
`SELECT`, `FROM`, and `WHERE` clauses.
menu:
influxdb3_core:
name: Basic query
parent: Query with InfluxQL
identifier: query-influxql-basic
weight: 202
influxdb3/core/tags: [query, influxql]
list_code_example: |
```sql
SELECT temp, room FROM home WHERE time >= now() - 1d
```
source: /shared/influxdb3-query-guides/influxql/basic-query.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/basic-query.md
-->

View File

@ -0,0 +1,39 @@
---
title: Explore your schema with InfluxQL
description: >
Use InfluxQL `SHOW` statements to return information about your data schema.
menu:
influxdb3_core:
name: Explore your schema
parent: Query with InfluxQL
identifier: query-influxql-schema
weight: 201
influxdb3/core/tags: [query, influxql]
related:
- /influxdb3/core/reference/influxql/show/
list_code_example: |
##### List measurements
```sql
SHOW MEASUREMENTS
```
##### List field keys in a measurement
```sql
SHOW FIELD KEYS FROM "measurement"
```
##### List tag keys in a measurement
```sql
SHOW TAG KEYS FROM "measurement"
```
##### List tag values for a specific tag key
```sql
SHOW TAG VALUES FROM "measurement" WITH KEY = "tag-key" WHERE time > now() - 1d
```
source: /shared/influxdb3-query-guides/influxql/explore-schema.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/explore-schema.md
-->

View File

@ -0,0 +1,45 @@
---
title: Use parameterized queries with InfluxQL
description: >
Use parameterized queries to prevent injection attacks and make queries more reusable.
weight: 404
menu:
influxdb3_core:
name: Parameterized queries
parent: Query with InfluxQL
identifier: parameterized-queries-influxql
influxdb3/core/tags: [query, security, influxql]
list_code_example: |
##### Using Go and the influxdb3-go client
```go
// Use the $parameter syntax to reference parameters in a query.
// The following InfluxQL query contains $room and $min_time parameters.
query := `
SELECT * FROM home
WHERE time >= $min_time
AND temp >= $min_temp
AND room = $room`
// Assign parameter names to input values.
parameters := influxdb3.QueryParameters{
"room": "Kitchen",
"min_temp": 20.0,
"min_time": "2024-03-18 00:00:00.00",
}
// Call the client's function to query InfluxDB with parameters and the
// the InfluxQL QueryType.
iterator, err := client.QueryWithParameters(context.Background(),
query,
parameters,
influxdb3.WithQueryType(influxdb3.InfluxQL))
```
# Leaving in draft until tested
draft: true
source: /shared/influxdb3-query-guides/influxql/parameterized-queries.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/parameterized-queries.md
-->

View File

@ -0,0 +1,15 @@
---
title: Troubleshoot InfluxQL errors
description: >
Learn how to troubleshoot and fix common InfluxQL errors.
menu:
influxdb3_core:
name: Troubleshoot errors
parent: Query with InfluxQL
weight: 230
source: /shared/influxdb3-query-guides/influxql/troubleshoot.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/influxql/troubleshoot.md
-->

View File

@ -0,0 +1,17 @@
---
title: Query data with SQL
seotitle: Query data with SQL
description: >
Learn to query data stored in {{< product-name >}} using SQL.
menu:
influxdb3_core:
name: Query with SQL
parent: Query data
weight: 101
influxdb3/core/tags: [query, sql]
source: /shared/influxdb3-query-guides/sql/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/_index.md
-->

View File

@ -0,0 +1,43 @@
---
title: Aggregate data with SQL
description: >
Use aggregate and selector functions to perform aggregate operations on your
time series data.
menu:
influxdb3_core:
name: Aggregate data
parent: Query with SQL
identifier: query-sql-aggregate
weight: 203
influxdb3/core/tags: [query, sql]
related:
- /influxdb3/core/reference/sql/functions/aggregate/
- /influxdb3/core/reference/sql/functions/selector/
- /influxdb3/core/reference/sql/group-by/
list_code_example: |
##### Aggregate fields by groups
```sql
SELECT
mean(field1) AS mean,
selector_first(field2)['value'] as first,
tag1
FROM home
GROUP BY tag
```
##### Aggregate by time-based intervals
```sql
SELECT
DATE_BIN(INTERVAL '1 hour', time, '2022-01-01T00:00:00Z'::TIMESTAMP) AS time,
mean(field1),
sum(field2),
tag1
FROM home
GROUP BY 1, tag1
```
source: /shared/influxdb3-query-guides/sql/aggregate-select.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/aggregate-select.md
-->

View File

@ -0,0 +1,23 @@
---
title: Perform a basic SQL query
seotitle: Perform a basic SQL query in InfluxDB 3 Core
description: >
A basic SQL query that queries data from {{< product-name >}} most commonly
includes `SELECT`, `FROM`, and `WHERE` clauses.
menu:
influxdb3_core:
name: Basic query
parent: Query with SQL
identifier: query-sql-basic
weight: 202
influxdb3/core/tags: [query, sql]
list_code_example: |
```sql
SELECT temp, room FROM home WHERE time >= now() - INTERVAL '1 day'
```
source: /shared/influxdb3-query-guides/sql/basic-query.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/basic-query.md
-->

View File

@ -0,0 +1,29 @@
---
title: Cast values to different types
seotitle: Cast values to different data types in SQL
description: >
Use the `CAST` function or double-colon `::` casting shorthand syntax to cast
a value to a specific type.
menu:
influxdb3_core:
name: Cast types
parent: Query with SQL
identifier: query-sql-cast-types
weight: 205
influxdb3/core/tags: [query, sql]
related:
- /influxdb3/core/reference/sql/data-types/
list_code_example: |
```sql
-- CAST clause
SELECT CAST(1234.5 AS BIGINT)
-- Double-colon casting shorthand
SELECT 1234.5::BIGINT
```
source: /shared/influxdb3-query-guides/sql/cast-types.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/cast-types.md
-->

View File

@ -0,0 +1,27 @@
---
title: Explore your schema with SQL
description: >
Use SQL to explore your data schema in your {{< product-name >}} database.
menu:
influxdb3_core:
name: Explore your schema
parent: Query with SQL
identifier: query-sql-schema
weight: 201
influxdb3/core/tags: [query, sql]
list_code_example: |
##### List tables
```sql
SHOW TABLES
```
##### List columns in a table
```sql
SHOW COLUMNS IN table
```
source: /shared/influxdb3-query-guides/sql/explore-schema.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/explore-schema.md
-->

View File

@ -0,0 +1,30 @@
---
title: Fill gaps in data
seotitle: Fill gaps in data with SQL
description: >
Use [`date_bin_gapfill`](/influxdb3/core/reference/sql/functions/time-and-date/#date_bin_gapfill)
with [`interpolate`](/influxdb3/core/reference/sql/functions/misc/#interpolate)
or [`locf`](/influxdb3/core/reference/sql/functions/misc/#locf) to
fill gaps of time where no data is returned.
menu:
influxdb3_core:
parent: Query with SQL
weight: 206
list_code_example: |
```sql
SELECT
date_bin_gapfill(INTERVAL '30 minutes', time) as time,
room,
interpolate(avg(temp))
FROM home
WHERE
time >= '2022-01-01T08:00:00Z'
AND time <= '2022-01-01T10:00:00Z'
GROUP BY 1, room
```
source: /shared/influxdb3-query-guides/sql/fill-gaps.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/fill-gaps.md
-->

View File

@ -0,0 +1,42 @@
---
title: Use parameterized queries with SQL
description: >
Use parameterized queries to prevent injection attacks and make queries more reusable.
weight: 404
menu:
influxdb3_core:
name: Parameterized queries
parent: Query with SQL
identifier: parameterized-queries-sql
influxdb3/core/tags: [query, security, sql]
list_code_example: |
##### Using Go and the influxdb3-go client
```go
// Use the $parameter syntax to reference parameters in a query.
// The following SQL query contains $room and $min_temp placeholders.
query := `
SELECT * FROM home
WHERE time >= $min_time
AND temp >= $min_temp
AND room = $room`
// Assign parameter names to input values.
parameters := influxdb3.QueryParameters{
"room": "Kitchen",
"min_temp": 20.0,
"min_time": "2024-03-18 00:00:00.00",
}
// Call the client's function to query InfluxDB with parameters.
iterator, err := client.QueryWithParameters(context.Background(), query, parameters)
```
# Leaving in draft until tested
draft: true
source: /shared/influxdb3-query-guides/sql/parameterized-queries.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/sql/parameterized-queries.md
-->

View File

@ -7,6 +7,8 @@ menu:
parent: influxdb3
name: influxdb3 serve
weight: 300
related:
- /influxdb3/core/reference/config-options/
---
The `influxdb3 serve` command starts the {{< product-name >}} server.
@ -16,7 +18,7 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
<!--pytest.mark.skip-->
```bash
influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
```
## Options
@ -79,7 +81,7 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ |
| {{< req "\*" >}} | `--writer-id` | _See [configuration options](/influxdb3/core/reference/config-options/#writer-id)_ |
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ |
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ |
@ -88,6 +90,7 @@ influxdb3 serve [OPTIONS] --writer-id <HOST_IDENTIFIER_PREFIX>
| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#distinct-cache-eviction-interval)_ |
| | `--plugin-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#plugin-dir)_ |
| | `--force-snapshot-mem-threshold` | _See [configuration options](/influxdb3/core/reference/config-options/#force-snapshot-mem-threshold)_ |
| | `--query-file-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#query-file-limit)_ |
{{< caption >}}
{{< req text="\* Required options" >}}
@ -119,7 +122,7 @@ with a unique identifier for your {{< product-name >}} server.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
### Run the InfluxDB 3 server with extra verbose logging
@ -131,7 +134,7 @@ influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
### Run InfluxDB 3 with debug logging using LOG_FILTER
@ -142,7 +145,7 @@ influxdb3 serve \
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id MY_HOST_ID
--node-id MY_HOST_ID
```
{{% /code-placeholders %}}

View File

@ -0,0 +1,16 @@
---
title: influxdb3 show system
description: >
The `influxdb3 show system` command displays data from {{< product-name >}}
system tables.
menu:
influxdb3_core:
parent: influxdb3 show
name: influxdb3 show system
weight: 400
source: /shared/influxdb3-cli/show/system/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-cli/show/system/_index.md
-->

View File

@ -0,0 +1,16 @@
---
title: influxdb3 show system summary
description: >
The `influxdb3 show system summary` command returns a summary various types of
system table data.
menu:
influxdb3_core:
parent: influxdb3 show system
name: influxdb3 show system summary
weight: 401
source: /shared/influxdb3-cli/show/system/summary.md
---
<!--
The content for this page is at content/shared/influxdb3-cli/show/system/summary.md
-->

View File

@ -0,0 +1,15 @@
---
title: influxdb3 show system table-list
description: >
The `influxdb3 show system table-list` command lists available system tables.
menu:
influxdb3_core:
parent: influxdb3 show system
name: influxdb3 show system table-list
weight: 401
source: /shared/influxdb3-cli/show/system/table-list.md
---
<!--
The content for this page is at content/shared/influxdb3-cli/show/system/table-list.md
-->

View File

@ -0,0 +1,15 @@
---
title: influxdb3 show system table
description: >
The `influxdb3 show system table` command queries data from a system table.
menu:
influxdb3_core:
parent: influxdb3 show system
name: influxdb3 show system table
weight: 401
source: /shared/influxdb3-cli/show/system/table.md
---
<!--
The content for this page is at content/shared/influxdb3-cli/show/system/table.md
-->

View File

@ -1,5 +1,5 @@
---
title: InfluxDB 3 Core configuration options
title: '{{< product-name >}} configuration options'
description: >
InfluxDB 3 Core lets you customize your server configuration by using
`influxdb3 serve` command options or by setting environment variables.
@ -27,7 +27,7 @@ environment variables.
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--writer-id my-host \
--node-id my-host \
--log-filter info \
--max-http-request-size 20971520 \
--aws-allow-http
@ -53,7 +53,8 @@ influxdb3 serve
- [General](#general)
- [object-store](#object-store)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
- [query-file-limit](#query-file-limit)
- [AWS](#aws)
- [aws-access-key-id](#aws-access-key-id)
- [aws-secret-access-key](#aws-secret-access-key)
@ -134,9 +135,9 @@ influxdb3 serve
### General
- [object-store](#object-store)
- [bucket](#bucket)
- [data-dir](#data-dir)
- [writer-id](#writer-id)
- [node-id](#node-id)
- [query-file-limit](#query-file-limit)
#### object-store
@ -166,15 +167,49 @@ Defines the location {{< product-name >}} uses to store files locally.
---
#### writer-id
#### node-id
Specifies the writer identifier used as a prefix in all object store file paths.
Specifies the node identifier used as a prefix in all object store file paths.
This should be unique for any hosts sharing the same object store
configuration--for example, the same bucket.
| influxdb3 serve option | Environment variable |
| :--------------------- | :----------------------------------- |
| `--writer-id` | `INFLUXDB3_WRITER_IDENTIFIER_PREFIX` |
| :--------------------- | :--------------------------------- |
| `--node-id` | `INFLUXDB3_NODE_IDENTIFIER_PREFIX` |
---
#### query-file-limit
Limits the number of Parquet files a query can access.
**Default:** `432`
With the default `432` setting and the default [`gen1-duration`](#`gen1-duration`)
setting of 10 minutes, queries can access up to a 72 hours of data, but
potentially less depending on whether all data for a given 10 minute block of
time was ingested during the same period.
You can increase this limit to allow more files to be queried, but be aware of
the following side-effects:
- Degraded query performance for queries that read more Parquet files
- Increased memory usage
- Your system potentially killing the `influxdb3` process due to Out-of-Memory
(OOM) errors
- If using object storage to store data, many GET requests to access the data
(as many as 2 per file)
> [!Note]
> We recommend keeping the default setting and querying smaller time ranges.
> If you need to query longer time ranges or faster query performance on any query
> that accesses an hour or more of data, [InfluxDB 3 Enterprise](/influxdb3/enterprise/)
> optimizes data storage by compacting and rearranging Parquet files to achieve
> faster query performance.
| influxdb3 serve option | Environment variable |
| :--------------------- | :--------------------------- |
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
---

View File

@ -0,0 +1,17 @@
---
title: Sample data
description: >
Sample datasets are used throughout the the {{< product-name >}} documentation
to demonstrate functionality.
Use the following sample datasets to replicate provided examples.
menu:
influxdb3_core:
name: Sample data
parent: Reference
weight: 182
source: /shared/influxdb3-sample-data/sample-data.md
---
<!--
The content for this page is at content/shared/influxdb3-sample-data/sample-data.md
-->

View File

@ -0,0 +1,16 @@
---
title: Write data to {{% product-name %}}
list_title: Write data
description: >
Collect and write time series data to {{% product-name %}}.
weight: 3
menu:
influxdb3_core:
name: Write data
influxdb3/core/tags: [write, line protocol]
source: /shared/influxdb3-write-guides/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/_index.md
-->

View File

@ -0,0 +1,17 @@
---
title: Best practices for writing data
seotitle: Best practices for writing data to {{< product-name >}}
description: >
Learn about the recommendations and best practices for writing data to {{< product-name >}}.
weight: 105
menu:
influxdb3_core:
name: Best practices
identifier: write-best-practices
parent: Write data
source: /shared/influxdb3-write-guides/best-practices/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/best-practices/_index.md
-->

View File

@ -0,0 +1,20 @@
---
title: Optimize writes to {{< product-name >}}
description: >
Tips and examples to optimize performance and system overhead when writing
data to {{< product-name >}}.
weight: 203
menu:
influxdb3_core:
name: Optimize writes
parent: write-best-practices
influxdb/cloud/tags: [best practices, write]
related:
- /resources/videos/ingest-data/, How to Ingest Data in InfluxDB (Video)
- /influxdb3/core/write-data/use-telegraf/
source: /shared/influxdb3-write-guides/best-practices/optimize-writes.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/best-practices/optimize-writes.md
-->

View File

@ -0,0 +1,20 @@
---
title: InfluxDB schema design recommendations
seotitle: InfluxDB schema design recommendations and best practices
description: >
Design your schema for simpler and more performant queries.
menu:
influxdb3_core:
name: Schema design
weight: 201
parent: write-best-practices
related:
- /influxdb3/core/admin/databases/
- /influxdb3/core/reference/cli/influxdb3/
- /influxdb3/core/query-data/troubleshoot-and-optimize/
source: /shared/influxdb3-write-guides/best-practices/schema-design.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/best-practices/schema-design.md
-->

View File

@ -0,0 +1,20 @@
---
title: Use InfluxDB client libraries to write data
description: >
Use InfluxDB API clients to write points as line protocol data to InfluxDB
Clustered.
menu:
influxdb3_core:
name: Use client libraries
parent: Write data
identifier: write-client-libs
weight: 103
related:
- /influxdb3/core/reference/syntax/line-protocol/
- /influxdb3/core/get-started/write/
source: /shared/influxdb3-write-guides/client-libraries.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/client-libraries.md
-->

View File

@ -0,0 +1,23 @@
---
title: Use the influxdb3 CLI to write data
description: >
Use the [`influxdb3` CLI](/influxdb3/core/reference/cli/influxdb3/)
to write line protocol data to InfluxDB Clustered.
menu:
influxdb3_core:
name: Use the influxdb3 CLI
parent: Write data
identifier: write-influxdb3
weight: 101
related:
- /influxdb3/core/reference/cli/influxdb3/write/
- /influxdb3/core/reference/syntax/line-protocol/
- /influxdb3/core/get-started/write/
alt_links:
cloud-serverless: /influxdb3/cloud-serverless/write-data/line-protocol/
source: /shared/influxdb3-write-guides/influxdb3-cli.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/influxdb3-cli.md
-->

View File

@ -0,0 +1,24 @@
---
title: Troubleshoot issues writing data
seotitle: Troubleshoot issues writing data to InfluxDB
weight: 106
description: >
Troubleshoot issues writing data.
Find response codes for failed writes.
Discover how writes fail, from exceeding rate or payload limits, to syntax
errors and schema conflicts.
menu:
influxdb3_core:
name: Troubleshoot issues
parent: Write data
influxdb3/core/tags: [write, line protocol, errors]
related:
- /influxdb3/core/reference/syntax/line-protocol/
- /influxdb3/core/write-data/best-practices/
- /influxdb3/core/reference/internals/durability/
source: /shared/influxdb3-write-guides/troubleshoot.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/troubleshoot.md
-->

View File

@ -0,0 +1,22 @@
---
title: Use Telegraf to write data
seotitle: Use the Telegraf agent to collect and write data
weight: 102
description: >
Use Telegraf to collect and write data to {{< product-name >}}.
aliases:
- /influxdb3/core/collect-data/advanced-telegraf
- /influxdb3/core/collect-data/use-telegraf
- /influxdb3/core/write-data/no-code/use-telegraf/
menu:
influxdb3_core:
name: Use Telegraf
parent: Write data
alt_links:
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/
source: /shared/influxdb3-write-guides/use-telegraf/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/use-telegraf/_index.md
-->

View File

@ -0,0 +1,23 @@
---
title: Configure Telegraf to write to {{< product-name >}}
seotitle: Configure Telegraf to write data to {{< product-name >}}
description: >
Update existing or create new Telegraf configurations to use the `influxdb_v2`
output plugin to write to {{< product-name >}}.
Start Telegraf using the custom configuration.
menu:
influxdb3_core:
name: Configure Telegraf
parent: Use Telegraf
weight: 101
influxdb3/core/tags: [telegraf]
related:
- /telegraf/v1/plugins/, Telegraf plugins
alt_links:
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/manual-config/
source: /shared/influxdb3-write-guides/use-telegraf/configure.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/use-telegraf/configure.md
-->

View File

@ -0,0 +1,21 @@
---
title: Use Telegraf to write CSV data
description: >
Use the Telegraf `file` input plugin to read and parse CSV data into
[line protocol](/influxdb3/core/reference/syntax/line-protocol/)
and write it to {{< product-name >}}.
menu:
influxdb3_core:
parent: Use Telegraf
name: Write CSV
identifier: write-csv-telegraf
weight: 203
related:
- /telegraf/v1/data_formats/input/csv/
- /influxdb3/core/write-data/use-telegraf/
source: /shared/influxdb3-write-guides/use-telegraf/csv.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/use-telegraf/csv.md
-->

View File

@ -0,0 +1,18 @@
---
title: Use Telegraf to dual write to InfluxDB
description: >
Configure Telegraf to write data to multiple InfluxDB instances or clusters
simultaneously.
menu:
influxdb3_core:
name: Dual write to InfluxDB
parent: Use Telegraf
weight: 203
alt_links:
cloud: /influxdb/cloud/write-data/no-code/use-telegraf/dual-write/
source: /shared/influxdb3-write-guides/use-telegraf/dual-write.md
---
<!--
The content for this page is at content/shared/influxdb3-write-guides/use-telegraf/dual-write.md
-->

View File

@ -25,8 +25,9 @@ InfluxDB 3 Enterprise runs on **Linux**, **macOS**, and **Windows**.
A key feature of InfluxDB 3 is its use of object storage to store time series
data in Apache Parquet format. You can choose to store these files on your local
file system, however, we recommend using an object store for the best overall
performance. {{< product-name >}} natively supports Amazon S3,
file system. Performance on your local filesystem will likely be better, but
object storage has the advantage of not running out of space and being accessible
by other systems over the network. {{< product-name >}} natively supports Amazon S3,
Azure Blob Storage, and Google Cloud Storage.
You can also use many local object storage implementations that provide an
S3-compatible API, such as [Minio](https://min.io/).

View File

@ -0,0 +1,15 @@
---
title: Query data in {{< product-name >}}
description: >
Learn to query data stored in InfluxDB using SQL and InfluxQL.
menu:
influxdb3_enterprise:
name: Query data
weight: 4
influxdb3/enterprise/tags: [query]
source: /shared/influxdb3-query-guides/_index.md
---
<!--
The content for this page is at content/shared/influxdb3-query-guides/_index.md
-->

Some files were not shown because too many files have changed in this diff Show More