Update content/shared/influxdb3-admin/tokens/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
pull/6069/head
Jameelah Mercer 2025-05-15 15:51:12 -07:00 committed by GitHub
parent a79851db29
commit 956659c8e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 39 additions and 16 deletions

View File

@ -5,41 +5,64 @@ Manage tokens to authenticate and authorize access to resources and data in your
Before running CLI commands or making HTTP API requests, you must provide a valid token to authenticate.
The mechanism for providing your token depends on the client you use to interact with {{% product-name %}}--for example:
{{< code-tabs-wrapper >}}
{{< tabs-wrapper >}}
{{% code-tabs %}}
[CLI](#cli-auth)
[HTTP API](#http-api-auth)
{{% /code-tabs %}}
{{% tabs %}}
[influxdb3 CLI](#influxdb3-cli-auth)
[cURL](#curl-auth)
{{% /tabs %}}
{{% code-tab-content %}}
{{% tab-content %}}
{{% code-placeholders "your-token" %}}
When using the `influxdb3` CLI, you can use the `--token` option to provide your authorization token.
{{% code-placeholders "YOUR_TOKEN" %}}
```bash
# Export your token as an environment variable
export INFLUXDB3_AUTH_TOKEN=your-token
# Include the --token option in your influxdb3 command
influxdb3 query \
--token YOUR_TOKEN \
--database example-db \
"SELECT * FROM 'example-table' WHERE time > now() - INTERVAL '10 minutes'"
```
{{% /code-placeholders %}}
Replace `your-token` with your actual InfluxDB 3 token.
You can also set the `INFLUXDB3_AUTH_TOKEN` environment variable to automatically provide your
authorization token to all `influxdb3` commands.
{{% /code-tab-content %}}
{{% code-placeholders "YOUR_TOKEN" %}}
```bash
# Export your token as an environment variable
export INFLUXDB3_AUTH_TOKEN=YOUR_TOKEN
{{% code-tab-content %}}
# Run an influxdb3 command without the --token option
influxdb3 query \
--database example-db \
"SELECT * FROM 'example-table' WHERE time > now() - INTERVAL '10 minutes'"
```
{{% /code-placeholders %}}
{{% code-placeholders "your-token" %}}
Replace `YOUR_TOKEN` with your authorization token.
{{% /tab-content %}}
{{% tab-content %}}
{{% code-placeholders "AUTH_TOKEN" %}}
```bash
# Add your token to the HTTP Authorization header
--header "Authorization: Bearer your-token"
curl "http://localhost:8181/api/v3/query_sql" \
--header "Authorization: Bearer AUTH_TOKEN" \
--data-urlencode "db=example-db" \
--data-urlencode "q=SELECT * FROM 'example-table' WHERE time > now() - INTERVAL '10 minutes'"
```
{{% /code-placeholders %}}
Replace `your-token` with your actual InfluxDB 3 token.
{{% /code-tab-content %}}
{{% /tab-content %}}
{{< /code-tabs-wrapper >}}
{{< /tabs-wrapper >}}
{{< children hlevel="h2" readmore=true hr=true >}}