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

Change "authentication token" to "API token" in InfluxDB 2 docs (#2929) 

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Russ Savage <russorat@users.noreply.github.com>
pull/3001/head
pierwill 2021-08-10 12:08:35 -05:00 committed by GitHub
parent 94445ea114
commit f056f8bef3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
154 changed files with 551 additions and 551 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/influxdb/cloud/influxdb-templates/create.md
View File

@ -46,7 +46,7 @@ use the `influx export all` command.
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.
@ -97,7 +97,7 @@ use the `influx export` with resource flags for each resource to include.
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.
@ -126,7 +126,7 @@ To export a stack and all its associated resources as a template, use the
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.

2
content/influxdb/cloud/monitor-alert/notification-endpoints/create.md
View File

@ -34,7 +34,7 @@ To send notifications about changes in your data, start by creating a notificati
5. In the **Name** and **Description** fields, enter a name and description for the endpoint.
6. Enter enter information to connect to the endpoint:
- For HTTP, enter the **URL** to send the notification. Select the **auth method** to use: **None** for no authentication. To authenticate with a username and password, select **Basic** and then enter credentials in the **Username** and **Password** fields. To authenticate with a token, select **Bearer**, and then enter the authentication token in the **Token** field.
- For HTTP, enter the **URL** to send the notification. Select the **auth method** to use: **None** for no authentication. To authenticate with a username and password, select **Basic** and then enter credentials in the **Username** and **Password** fields. To authenticate with a token, select **Bearer**, and then enter the API token in the **Token** field.
- For Slack, create an [Incoming WebHook](https://api.slack.com/incoming-webhooks#posting_with_webhooks) in Slack, and then enter your webHook URL in the **Slack Incoming WebHook URL** field.

2
content/influxdb/cloud/monitor-alert/templates/infrastructure/raspberry-pi.md
View File

@ -37,7 +37,7 @@ The Raspberry Pi template includes the following:
3. Add the following environment variables to your Telegraf environment:
- `INFLUX_HOST`: Your [InfluxDB Cloud region URL](/influxdb/cloud/reference/regions/)
- `INFLUX_TOKEN`: Your InfluxDB Cloud [authentication token](/influxdb/cloud/security/tokens/)
- `INFLUX_TOKEN`: Your InfluxDB Cloud [API token](/influxdb/cloud/security/tokens/)
- `INFLUX_ORG`: Your InfluxDB Cloud organization name.
```sh

2
content/influxdb/cloud/organizations/buckets/create-bucket.md
View File

@ -97,7 +97,7 @@ Use the `POST` request method and include the following in your request:
| Organization | Use `orgID` in the JSON payload. |
| Bucket | Use `name` in the JSON payload. |
| Retention Rules | Use `retentionRules` in the JSON payload. |
| Authentication token | Use the `Authorization: Token` header. |
| API token | Use the `Authorization: Token` header. |
#### Example

4
content/influxdb/cloud/query-data/influxql.md
View File

@ -46,7 +46,7 @@ Include the following:
- **Request method:** `GET`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/cloud/security/tokens/)
- **Authorization:** `Token` schema with your InfluxDB [API token](/influxdb/cloud/security/tokens/)
- **Query parameters:**
{{< req type="key" >}}
- {{< req "\*" >}} **organization_id:** [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id)
@ -86,7 +86,7 @@ Include the following:
- **Request method:** `POST`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/cloud/security/tokens/)
- **Authorization:** `Token` schema with your InfluxDB [API token](/influxdb/cloud/security/tokens/)
- **Content-type:** `application/json`
- **Request body:** JSON object with the following fields:
{{< req type="key" >}}

2
content/influxdb/cloud/reference/api/_index.md
View File

@ -16,7 +16,7 @@ Access the InfluxDB API using the `/api/v2/` endpoint.
## Authentication
{{% cloud-token-auth %}}
Include your authentication token as an `Authorization` header in each request.
Include your API token as an `Authorization` header in each request.
```sh
curl --request POST https://cloud2.influxdata.com/api/v2/write \

8
content/influxdb/cloud/reference/api/influxdb-1x/_index.md
View File

@ -24,10 +24,10 @@ like [Grafana](https://grafana.com) and others.
{{% cloud %}}
InfluxDB Cloud requires all query and write requests to be authenticated using
[InfluxDB authentication tokens](/influxdb/cloud/security/tokens/).
[InfluxDB API tokens](/influxdb/cloud/security/tokens/).
{{% /cloud %}}
Use InfluxDB authentication tokens with the following authentication schemes:
Use InfluxDB API tokens with the following authentication schemes:
* [Authenticate with the Token scheme](#authenticate-with-the-token-scheme)
* [Authenticate with a username and password scheme](#authenticate-with-a-username-and-password-scheme)
@ -35,7 +35,7 @@ Use InfluxDB authentication tokens with the following authentication schemes:
### Authenticate with the Token scheme
Token authentication requires the following credential:
- **token**: InfluxDB [authentication token](/influxdb/cloud/security/tokens/)
- **token**: InfluxDB [API token](/influxdb/cloud/security/tokens/)
Use the `Authorization` header with the `Token` scheme to provide your
token to InfluxDB.
@ -75,7 +75,7 @@ Use the following schemes with clients that support the InfluxDB 1.x convention
Username and password schemes require the following credentials:
- **username**: InfluxDB Cloud username
- **password**: InfluxDB Cloud [authentication token](/influxdb/cloud/security/tokens/)
- **password**: InfluxDB Cloud [API token](/influxdb/cloud/security/tokens/)
#### Basic authentication
Use the `Authorization` header with the `Basic` scheme to provide username and password credentials to InfluxDB.

2
content/influxdb/cloud/reference/api/influxdb-1x/query.md
View File

@ -44,7 +44,7 @@ to query that bucket with the `/query` compatibility API.
_See [query string authentication](/influxdb/cloud/reference/api/influxdb-1x/#query-string-authentication)._
### p
(Optional) The InfluxDB Cloud **authentication token** to authenticate the request.
(Optional) The InfluxDB Cloud **API token** to authenticate the request.
_See [query string authentication](/influxdb/cloud/reference/api/influxdb-1x/#query-string-authentication)._
### db

2
content/influxdb/cloud/reference/api/influxdb-1x/write.md
View File

@ -49,7 +49,7 @@ encode the line protocol.
_See [query string authentication](/influxdb/cloud/reference/api/influxdb-1x/#query-string-authentication)._
### p
(Optional) The InfluxDB Cloud **authentication token** to authenticate the request.
(Optional) The InfluxDB Cloud **API token** to authenticate the request.
_See [query string authentication](/influxdb/cloud/reference/api/influxdb-1x/#query-string-authentication)._
### db

4
content/influxdb/cloud/reference/cli/influx/_index.md
View File

@ -25,7 +25,7 @@ influx [command]
```
### Provide required authentication credentials
To avoid having to pass your InfluxDB **host**, **authentication token**, and **organization**
To avoid having to pass your InfluxDB **host**, **API token**, and **organization**
with each command, store them in an `influx` CLI configuration (config).
`influx` commands that require these credentials automatically retrieve these
credentials from the active config.
@ -49,7 +49,7 @@ For more information about managing CLI configurations, see the
| Command | Description |
|:------- |:----------- |
| [apply](/influxdb/cloud/reference/cli/influx/apply) | Apply an InfluxDB template |
| [auth](/influxdb/cloud/reference/cli/influx/auth) | Authentication token management commands |
| [auth](/influxdb/cloud/reference/cli/influx/auth) | API token management commands |
| [backup](/influxdb/cloud/reference/cli/influx/backup) | Back up data |
| [bucket](/influxdb/cloud/reference/cli/influx/bucket) | Bucket management commands |
| [completion](/influxdb/cloud/reference/cli/influx/completion) | Generate completion scripts |

2
content/influxdb/cloud/reference/cli/influx/auth/_index.md
View File

@ -1,6 +1,6 @@
---
title: influx auth
description: The `influx auth` command and its subcommands manage authentication tokens in InfluxDB.
description: The `influx auth` command and its subcommands manage API tokens in InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth

2
content/influxdb/cloud/reference/cli/influx/auth/active.md
View File

@ -1,7 +1,7 @@
---
title: influx auth active
description: >
The `influx auth active` command activates an authentication token in InfluxDB.
The `influx auth active` command activates an API token in InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth active

2
content/influxdb/cloud/reference/cli/influx/auth/create.md
View File

@ -1,6 +1,6 @@
---
title: influx auth create
description: The `influx auth create` creates an authentication token in InfluxDB.
description: The `influx auth create` creates an API token in InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth create

2
content/influxdb/cloud/reference/cli/influx/auth/delete.md
View File

@ -1,6 +1,6 @@
---
title: influx auth delete
description: The `influx auth delete` command deletes an authentication token from InfluxDB.
description: The `influx auth delete` command deletes an API token from InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth delete

2
content/influxdb/cloud/reference/cli/influx/auth/inactive.md
View File

@ -1,6 +1,6 @@
---
title: influx auth inactive
description: The `influx auth inactive` command inactivates an authentication token in InfluxDB.
description: The `influx auth inactive` command inactivates an API token in InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth inactive

2
content/influxdb/cloud/reference/cli/influx/auth/list.md
View File

@ -1,6 +1,6 @@
---
title: influx auth list
description: The `influx auth list` command lists authentication tokens in InfluxDB.
description: The `influx auth list` command lists API tokens in InfluxDB.
menu:
influxdb_cloud_ref:
name: influx auth list

2
content/influxdb/cloud/reference/cli/influx/bucket-schema/create.md
View File

@ -37,7 +37,7 @@ influx bucket-schema create [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/cloud/reference/cli/influx/bucket-schema/list.md
View File

@ -36,7 +36,7 @@ influx bucket-schema list [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/cloud/reference/cli/influx/bucket-schema/update.md
View File

@ -46,7 +46,7 @@ influx bucket-schema update [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/cloud/reference/cli/influx/restore/index.md
View File

@ -54,7 +54,7 @@ influx restore [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/cloud/reference/flux/stdlib/contrib/influxdb/select.md
View File

@ -109,7 +109,7 @@ Organization name.
_**Data type:** String_
### token
InfluxDB [authentication token](/influxdb/cloud/security/tokens/).
InfluxDB [API token](/influxdb/cloud/security/tokens/).
_**Data type:** String_

4
content/influxdb/cloud/reference/flux/stdlib/influxdb/cardinality.md
View File

@ -74,7 +74,7 @@ _See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions) or
_**Data type:** String_
### token
InfluxDB [authentication token](/influxdb/cloud/security/tokens/).
InfluxDB [API token](/influxdb/cloud/security/tokens/).
_**Data type:** String_
@ -135,4 +135,4 @@ influxdb.cardinality(
start: -1y,
predicate: (r) => r.exampleTag == "foo"
)
```
```

4
content/influxdb/cloud/reference/internals/security.md
View File

@ -211,9 +211,9 @@ Users can configure the following security controls:
We use [Auth0](https://auth0.com/) for InfluxDB Cloud authentication.
User accounts can be created directly on the InfluxDB Cloud system via Auth0.
Users also have the option to use “social sign-on” with their existing Google or Microsoft accounts for authentication.
API access within custom applications requires an authentication token.
API access within custom applications requires an API token.
Tokens belong to an organization and are mapped to InfluxDB permissions within the organization as defined when the token is created.
For more information on the types of tokens and ways to create them, see [Manage authentication tokens](/influxdb/cloud/security/tokens/).
For more information on the types of tokens and ways to create them, see [Manage API tokens](/influxdb/cloud/security/tokens/).
### Role-based access controls (RBAC)

2
content/influxdb/cloud/security/secrets/manage-secrets/add.md
View File

@ -38,7 +38,7 @@ add a new secret to your organization.
**Include the following:**
- Your [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- Your [API token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- The secret key-value pair in the request body
<!-- -->

2
content/influxdb/cloud/security/secrets/manage-secrets/delete.md
View File

@ -30,7 +30,7 @@ to delete one or more secrets.
**Include the following:**
- Your [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- Your [API token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- An array of secret keys to delete in the request body
<!-- -->

2
content/influxdb/cloud/security/secrets/manage-secrets/update.md
View File

@ -38,7 +38,7 @@ to update a secret in your organization.
**Include the following:**
- Your [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- Your [API token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- The updated secret key-value pair in the request body
<!-- -->

2
content/influxdb/cloud/security/secrets/manage-secrets/view.md
View File

@ -25,7 +25,7 @@ to view your organization's secrets keys.
**Include the following:**
- Your [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id) in the request URL
- Your [authentication token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
- Your [API token](/influxdb/cloud/security/tokens/view-tokens/) in the `Authorization` header
<!-- -->
```sh

12
content/influxdb/cloud/security/tokens/_index.md
View File

@ -1,7 +1,7 @@
---
title: Manage authentication tokens
seotitle: Manage authentication tokens in InfluxDB
description: Manage authentication tokens in InfluxDB using the InfluxDB UI or the influx CLI.
title: Manage API tokens
seotitle: Manage API tokens in InfluxDB
description: Manage API tokens in InfluxDB using the InfluxDB UI or the influx CLI.
aliases:
- /influxdb/cloud/users/tokens
influxdb/cloud/tags: [tokens, authentication, security]
@ -12,12 +12,12 @@ menu:
weight: 103
---
InfluxDB **authentication tokens** ensure secure interaction between users and data.
InfluxDB **API tokens** ensure secure interaction between users and data.
A token belongs to an organization and identifies InfluxDB permissions within the organization.
Learn how to create, view, update, or delete an authentication token.
Learn how to create, view, update, or delete an API token.
## Authentication token types
## API token types
- [All-Access token](#all-access-token)
- [Read/Write token](#readwrite-token)

6
content/influxdb/cloud/security/tokens/create-token.md
View File

@ -1,7 +1,7 @@
---
title: Create a token
seotitle: Create an authentication token in InfluxDB
description: Create an authentication token in InfluxDB using the InfluxDB UI or the `influx` CLI.
seotitle: Create an API token in InfluxDB
description: Create an API token in InfluxDB using the InfluxDB UI or the `influx` CLI.
menu:
influxdb_cloud:
name: Create a token
@ -9,4 +9,4 @@ menu:
weight: 201
---
{{< duplicate-oss >}}
{{< duplicate-oss >}}

4
content/influxdb/cloud/security/tokens/delete-token.md
View File

@ -1,7 +1,7 @@
---
title: Delete a token
seotitle: Delete an authentication token from InfluxDB
description: Delete an authentication token from InfluxDB using the InfluxDB UI or the `influx` CLI.
seotitle: Delete an API token from InfluxDB
description: Delete an API token from InfluxDB using the InfluxDB UI or the `influx` CLI.
menu:
influxdb_cloud:
name: Delete a token

6
content/influxdb/cloud/security/tokens/update-tokens.md
View File

@ -1,7 +1,7 @@
---
title: Update a token
seotitle: Update authentication tokens in InfluxDB
description: Update authentication tokens' descriptions in InfluxDB using the InfluxDB UI.
seotitle: Update API tokens in InfluxDB
description: Update API tokens' descriptions in InfluxDB using the InfluxDB UI.
menu:
influxdb_cloud:
name: Update a token
@ -9,4 +9,4 @@ menu:
weight: 203
---
{{< duplicate-oss >}}
{{< duplicate-oss >}}

4
content/influxdb/cloud/security/tokens/use-tokens.md
View File

@ -1,7 +1,7 @@
---
title: Use tokens
seotitle: Use an authentication token in InfluxDB
description: Use an authentication token in InfluxDB using the InfluxDB UI, `influx` CLI, or InfluxDB API
seotitle: Use an API token in InfluxDB
description: Use an API token in InfluxDB using the InfluxDB UI, `influx` CLI, or InfluxDB API
menu:
influxdb_cloud:
name: Use tokens

4
content/influxdb/cloud/security/tokens/view-tokens.md
View File

@ -1,7 +1,7 @@
---
title: View tokens
seotitle: View authentication tokens in InfluxDB
description: View authentication tokens in InfluxDB using the InfluxDB UI or the `influx` CLI.
seotitle: View API tokens in InfluxDB
description: View API tokens in InfluxDB using the InfluxDB UI or the `influx` CLI.
aliases:
- /influxdb/cloud/users/tokens/view-tokens
menu:

4
content/influxdb/cloud/sign-up.md
View File

@ -146,7 +146,7 @@ If running `influx` on macOS Catalina, you must manually authorize the
#### Step 5: Set up a configuration profile
To avoid having to pass your InfluxDB [authentication token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials.
To avoid having to pass your InfluxDB [API token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials.
In a terminal, run the following command:
@ -206,7 +206,7 @@ If you rename the binary, all references to `influx` in this documentation refer
#### Step 4: Set up a configuration profile
To avoid having to pass your InfluxDB [authentication token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials.
To avoid having to pass your InfluxDB [API token](/influxdb/cloud/security/tokens/) with each `influx` command, set up a configuration profile that stores your credentials.
In a terminal, run the following command:

10
content/influxdb/cloud/tools/grafana.md
View File

@ -56,7 +56,7 @@ configure your InfluxDB connection:
```
- **Organization**: Your InfluxDB [organization name **or** ID](/influxdb/cloud/organizations/view-orgs/).
- **Token**: Your InfluxDB [authentication token](/influxdb/cloud/security/tokens/).
- **Token**: Your InfluxDB [API token](/influxdb/cloud/security/tokens/).
- **Default Bucket**: The default [bucket](/influxdb/cloud/organizations/buckets/) to use in Flux queries.
- **Min time interval**: The [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval).
@ -80,13 +80,13 @@ To query InfluxDB Cloud from Grafana using InfluxQL:
1. [Download the latest version of the `influx` CLI](/influxdb/cloud/sign-up/#optional-download-install-and-use-the-influx-cli)
appropriate for your local operating system.
2. Create a CLI configuration that provides the required InfluxDB Cloud **host**,
**organization**, and **authentication token** to all CLI commands.
**organization**, and **API token** to all CLI commands.
Use the [`influx config create` command](/influxdb/cloud/reference/cli/influx/config/create/)
and provide the following:
- [InfluxDB Cloud URL](/influxdb/cloud/reference/regions/)
- [organization name](/influxdb/cloud/organizations/) _(by default, your email address)_
- [authentication token](/influxdb/cloud/security/tokens/)
- [API token](/influxdb/cloud/security/tokens/)
```sh
influx config create \
@ -177,10 +177,10 @@ With **InfluxQL** selected as the query language in your InfluxDB data source se
```
- **Access**: Server (default)
2. Under **Custom HTTP Headers**, select **Add Header**. Provide your InfluxDB Cloud authentication token:
2. Under **Custom HTTP Headers**, select **Add Header**. Provide your InfluxDB Cloud API token:
- **Header**: Enter `Authorization`
- **Value**: Use the `Token` schema and provide your [InfluxDB authentication token](/influxdb/v2.0/security/tokens/).
- **Value**: Use the `Token` schema and provide your [InfluxDB API token](/influxdb/v2.0/security/tokens/).
For example:
```

10
content/influxdb/cloud/upgrade/v1-to-cloud/_index.md
View File

@ -15,7 +15,7 @@ related:
To upgrade from **InfluxDB OSS 1.x** to **InfluxDB Cloud**:
1. [Create an InfluxDB Cloud account](#create-an-influxdb-cloud-account)
2. [Create an All-Access authentication token](#create-an-all-access-authentication-token)
2. [Create an All-Access API token](#create-an-all-access-authentication-token)
3. [Download and install the `influx` CLI](#download-and-install-the-influx-cli)
4. [Create DBRP mappings](#create-dbrp-mappings)
5. [Dual write to InfluxDB 1.x and InfluxDB Cloud](#dual-write-to-influxdb-1x-and-influxdb-cloud)
@ -29,7 +29,7 @@ Do one of the following to create an InfluxDB Cloud account:
- [Subscribe through InfluxData](/influxdb/cloud/sign-up/#subscribe-through-influxdata) and start for free.
- [Subscribe through your cloud provider](/influxdb/cloud/sign-up/#subscribe-through-a-cloud-provider).
## Create an All-Access authentication token
## Create an All-Access API token
{{% cloud-token-auth %}}
Create an **All-Access** token in your InfluxDB Cloud user interface (UI) to use
for the upgrade process.
@ -74,7 +74,7 @@ _For more information about managing tokens and token types, see [Manage tokens]
{{% note %}}
#### Required InfluxDB Cloud credentials
All `influx` CLI examples below assume the required InfluxDB Cloud **host**,
**organization**, and **authentication token** credentials are provided by your
**organization**, and **API token** credentials are provided by your
[`influx` CLI configuration](/influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials).
{{% /note %}}
@ -158,7 +158,7 @@ Update external clients to write to your InfluxDB Cloud instance.
finish [migrating your existing time series data](#migrate-time-series-data)**.
Configure external clients with your InfluxDB Cloud **host**, **organization**,
and **authentication token**.
and **API token**.
### Update Telegraf configurations
If using Telegraf to collect and write metrics to InfluxDB 1.x, update your
@ -184,7 +184,7 @@ Telegraf configuration to write to both InfluxDB 1.x and InfluxDB Cloud:
```
2. Add the `INFLUX_TOKEN` environment variable to your Telegraf environment(s)
and set the value to your InfluxDB Cloud authentication token.
and set the value to your InfluxDB Cloud API token.
3. Restart Telegraf with the updated configuration and begin writing to both
InfluxDB 1.x and InfluxDB Cloud.

18
content/influxdb/cloud/upgrade/v2-to-cloud.md
View File

@ -13,7 +13,7 @@ weight: 11
To upgrade from **InfluxDB OSS 2.x** to **InfluxDB Cloud**:
1. [Create an InfluxDB Cloud account](#create-an-influxdb-cloud-account)
2. [Create an All-Access authentication token](#create-an-all-access-authentication-token)
2. [Create an All-Access API token](#create-an-all-access-authentication-token)
3. [Set up influx CLI connection configurations](#set-up-influx-cli-connection-configurations)
4. [Use templates to migrate InfluxDB resources](#use-templates-to-migrate-influxdb-resources)
5. [Migrate DBRP mappings](#migrate-dbrp-mappings)
@ -23,7 +23,7 @@ To upgrade from **InfluxDB OSS 2.x** to **InfluxDB Cloud**:
{{% note %}}
#### Consider when upgrading
- InfluxDB Cloud requires token authentication, and you must create all new authentication tokens.
- InfluxDB Cloud requires token authentication, and you must create all new API tokens.
- InfluxDB Cloud does not support:
- Multiple [organizations](http://localhost:1313/influxdb/cloud/reference/glossary/#organization) per account.
Upgrade a single InfluxDB OSS 2.x organization to an InfluxDB Cloud organization.
@ -39,8 +39,8 @@ Do one of the following to create an InfluxDB Cloud account:
- [Subscribe through InfluxData](/influxdb/cloud/sign-up/#subscribe-through-influxdata) and start for free.
- [Subscribe through your cloud provider](/influxdb/cloud/sign-up/#subscribe-through-a-cloud-provider).
## Create an All-Access authentication token
InfluxDB authentication tokens are unique to each organization.
## Create an All-Access API token
InfluxDB API tokens are unique to each organization.
Create an **All-Access** token in your InfluxDB Cloud user interface (UI) to use
for the upgrade process.
@ -60,7 +60,7 @@ _For more information about managing tokens and token types, see [Manage tokens]
## Set up influx CLI connection configurations
The `influx` command line interface (CLI) lets you create connection configurations
that automatically provides **host**, **organization**, and **authentication token**
that automatically provides **host**, **organization**, and **API token**
credentials to CLI commands.
Use the `influx` CLI packaged with InfluxDB 2.x and the
[`influx config create` command](/influxdb/cloud/reference/cli/influx/config/create/)
@ -78,7 +78,7 @@ Include the following flags for each configuration:
- **-\-org**:
InfluxDB organization name.
The default organization name in InfluxDB Cloud is the email address associated with your account.
- **-\-token**: Authentication token to use to connect to InfluxDB.
- **-\-token**: API token to use to connect to InfluxDB.
Provide an **All-Access** token (or an [Operator token](/{{< latest "influxdb" >}}/security/tokens/#operator-token) for 2.x).
##### Create an InfluxDB Cloud connection configuration
@ -211,7 +211,7 @@ Update external clients to write to your InfluxDB Cloud instance.
finish [migrating your existing time series data](#migrate-time-series-data)**.
Configure external clients with your InfluxDB Cloud **host**, **organization**,
and **authentication token**.
and **API token**.
### Update Telegraf configurations
If using Telegraf configurations migrated to or stored in InfluxDB Cloud,
@ -240,8 +240,8 @@ If using Telegraf configurations migrated to or stored in InfluxDB Cloud,
2. Add the following environment variables to your Telegraf environment(s):
- `INFLUX_TOKEN`: InfluxDB 2.x authentication token
- `INFLUX_CLOUD_TOKEN`: InfluxDB Cloud authentication token
- `INFLUX_TOKEN`: InfluxDB 2.x API token
- `INFLUX_CLOUD_TOKEN`: InfluxDB Cloud API token
3. Use the command provided in your [Telegraf Setup Instructions](/influxdb/cloud/telegraf-configs/#use-influxdb-telegraf-configurations)
to restart Telegraf with the updated configuration and begin writing to both

4
content/influxdb/cloud/write-data/_index.md
View File

@ -39,8 +39,8 @@ To write data into InfluxDB, you need the following:
for instructions on viewing your organization ID._
- **bucket** – _See [View buckets](/influxdb/cloud/organizations/buckets/view-buckets/) for
instructions on viewing your bucket ID._
- **authentication token** – _See [View tokens](/influxdb/cloud/security/tokens/view-tokens/)
for instructions on viewing your authentication token._
- **API token** – _See [View tokens](/influxdb/cloud/security/tokens/view-tokens/)
for instructions on viewing your API token._
- **InfluxDB Cloud region URL** – _See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)_.
Use _line protocol_ format to write data into InfluxDB.

2
content/influxdb/cloud/write-data/developer-tools/api.md
View File

@ -16,7 +16,7 @@ Use the `POST` request method and include the following in your request:
| Organization | Use the `org` query parameter in your request URL. |
| Bucket | Use the `bucket` query parameter in your request URL. |
| Precision | Use the `precision` query parameter in your request URL. |
| Authentication token | Use the `Authorization: Token` header. |
| API token | Use the `Authorization: Token` header. |
| Line protocol | Pass as plain text in your request body. |
#### Example

2
content/influxdb/cloud/write-data/developer-tools/influx-cli.md
View File

@ -19,7 +19,7 @@ Include the following in your command:
| Organization | Use the `-o`,`--org`, or `--org-id` flags. |
| Bucket | Use the `-b`, `--bucket`, or `--bucket-id` flags. |
| Precision | Use the `-p`, `--precision` flag. |
| Authentication token | Set the `INFLUX_TOKEN` environment variable or use the `t`, `--token` flag. |
| API token | Set the `INFLUX_TOKEN` environment variable or use the `t`, `--token` flag. |
| Data | Write data using **line protocol** or **annotated CSV**. Pass a file with the `-f`, `--file` flag. |
_See [Line protocol](/influxdb/cloud/reference/syntax/line-protocol/) and [Annotated CSV](/influxdb/cloud/reference/syntax/annotated-csv)_

2
content/influxdb/cloud/write-data/no-code/third-party.md
View File

@ -71,7 +71,7 @@ To configure Apache JMeter, complete the following steps in InfluxDB and JMeter.
https://cloud2.influxdata.com/api/v2/write?org=my-org&bucket=jmeter
```
- **application**: `InfluxDB2`
- **influxdbToken**: _your InfluxDB authentication token_
- **influxdbToken**: _your InfluxDB API token_
- Include additional parameters as needed.
4. Click **Add** to add the _**InfluxDBBackendListenerClient**_ implementation.

4
content/influxdb/cloud/write-data/no-code/use-telegraf/auto-config.md
View File

@ -76,12 +76,12 @@ If you plan to monitor a Windows host using the System plugin, you must complete
## Start Telegraf
Requests to the [InfluxDB v2 API](/influxdb/cloud/reference/api/) must include an authentication token.
Requests to the [InfluxDB v2 API](/influxdb/cloud/reference/api/) must include an API token.
A token identifies specific permissions to the InfluxDB instance.
### Configure your token as an environment variable
1. Find your authentication token. _For information about viewing tokens, see [View tokens](/influxdb/cloud/security/tokens/view-tokens/)._
1. Find your API token. _For information about viewing tokens, see [View tokens](/influxdb/cloud/security/tokens/view-tokens/)._
2. To configure your token as the `INFLUX_TOKEN` environment variable, run the command appropriate for your operating system and command-line tool:

6
content/influxdb/v2.0/api-guide/api_intro.md
View File

@ -32,10 +32,10 @@ an [InfluxDB Cloud account](/influxdb/cloud/sign-up).
### Authentication
Before diving into the API, use the InfluxDB UI to
[create an initial authentication token](/influxdb/v2.0/security/tokens/create-token/) for your application.
[create an initial API token](/influxdb/v2.0/security/tokens/create-token/) for your application.
InfluxDB uses [authentication tokens](/influxdb/v2.0/security/tokens/) to authorize API requests.
Include your authentication token as an `Authorization` header in each request.
InfluxDB uses [API tokens](/influxdb/v2.0/security/tokens/) to authorize API requests.
Include your API token as an `Authorization` header in each request.
#### Example

6
content/influxdb/v2.0/influxdb-templates/create.md
View File

@ -60,7 +60,7 @@ use the `influx export all` command.
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.
@ -114,7 +114,7 @@ To export specific resources within an organization to a template manifest, use
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.
@ -154,7 +154,7 @@ To export a stack and all its associated resources as a template, use the
Provide the following:
- **Organization name** or **ID**
- **Authentication token** with read access to the organization
- **API token** with read access to the organization
- **Destination path and filename** for the template manifest.
The filename extension determines the template format—both **YAML** (`.yml`) and
**JSON** (`.json`) are supported.

8
content/influxdb/v2.0/install.md
View File

@ -585,7 +585,7 @@ to collect and send data to:
## Set up InfluxDB
The initial setup process for InfluxDB walks through creating a default organization,
user, bucket, and Admin authentication token.
user, bucket, and Operator API token.
The setup process is available in both the InfluxDB user interface (UI) and in
the `influx` command line interface (CLI).
@ -624,7 +624,7 @@ You are ready to [write or collect data](/influxdb/v2.0/write-data).
### (Optional) Set up and use the influx CLI
If you set up InfluxDB through the UI and want to use the [`influx` CLI](/influxdb/v2.0/reference/cli/influx), we recommend setting up a configuration profile. This lets you avoid having to pass your InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) with each `influx` command. Complete the following steps to set up a configuration profile that stores your credentials.
If you set up InfluxDB through the UI and want to use the [`influx` CLI](/influxdb/v2.0/reference/cli/influx), we recommend setting up a configuration profile. This lets you avoid having to pass your InfluxDB [API token](/influxdb/v2.0/security/tokens/) with each `influx` command. Complete the following steps to set up a configuration profile that stores your credentials.
1. In a terminal, run the following command:
@ -661,9 +661,9 @@ influx setup
6. Enter a **retention period** for your primary bucket—valid units are nanoseconds (`ns`), microseconds (`us` or `µs`), milliseconds (`ms`), seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). Enter nothing for an infinite retention period.
7. Confirm the details for your primary user, organization, and bucket.
InfluxDB is now initialized with a primary user, organization, bucket, and authentication token. InfluxDB also creates a configuration profile for you so that you don't have to add organization and token to every command. To view that config profile, use the [`influx config list`](/influxdb/v2.0/reference/cli/influx/config) command.
InfluxDB is now initialized with a primary user, organization, bucket, and API token. InfluxDB also creates a configuration profile for you so that you don't have to add organization and token to every command. To view that config profile, use the [`influx config list`](/influxdb/v2.0/reference/cli/influx/config) command.
To continue to use InfluxDB via the CLI, you need the authentication token created during setup. To view the token, log into the UI with the credentials created above. (For instructions, see [View tokens in the InfluxDB UI](/influxdb/v2.0/security/tokens/view-tokens/#view-tokens-in-the-influxdb-ui).)
To continue to use InfluxDB via the CLI, you need the API token created during setup. To view the token, log into the UI with the credentials created above. (For instructions, see [View tokens in the InfluxDB UI](/influxdb/v2.0/security/tokens/view-tokens/#view-tokens-in-the-influxdb-ui).)
You are ready to [write or collect data](/influxdb/v2.0/write-data).

2
content/influxdb/v2.0/monitor-alert/notification-endpoints/create.md
View File

@ -26,7 +26,7 @@ To send notifications about changes in your data, start by creating a notificati
5. In the **Name** and **Description** fields, enter a name and description for the endpoint.
6. Enter information to connect to the endpoint:
- For HTTP, enter the **URL** to send the notification. Select the **auth method** to use: **None** for no authentication. To authenticate with a username and password, select **Basic** and then enter credentials in the **Username** and **Password** fields. To authenticate with a token, select **Bearer**, and then enter the authentication token in the **Token** field.
- For HTTP, enter the **URL** to send the notification. Select the **auth method** to use: **None** for no authentication. To authenticate with a username and password, select **Basic** and then enter credentials in the **Username** and **Password** fields. To authenticate with an API token, select **Bearer**, and then enter the API token in the **Token** field.
- **For Slack**, create an [Incoming WebHook](https://api.slack.com/incoming-webhooks#posting_with_webhooks) in Slack, and then enter your webHook URL in the **Slack Incoming WebHook URL** field.

2
content/influxdb/v2.0/organizations/buckets/create-bucket.md
View File

@ -93,7 +93,7 @@ Use the `POST` request method and include the following in your request:
| Organization | Use `orgID` in the JSON payload. |
| Bucket | Use `name` in the JSON payload. |
| Retention Rules | Use `retentionRules` in the JSON payload. |
| Authentication token | Use the `Authorization: Token` header. |
| API token | Use the `Authorization: Token` header. |
#### Example

2
content/influxdb/v2.0/query-data/execute-queries/influx-api.md
View File

@ -17,7 +17,7 @@ The [InfluxDB v2 API](/influxdb/v2.0/reference/api) provides a programmatic inte
In your request, set the following:
- Your organization via the `org` or `orgID` URL parameters.
- `Authorization` header to `Token ` + your authentication token.
- `Authorization` header to `Token ` + your API token.
- `Accept` header to `application/csv`.
- `Content-type` header to `application/vnd.flux` (Flux only) or `application/json` (Flux or InfluxQL).
- Query in Flux or InfluxQL with the request's raw data.

2
content/influxdb/v2.0/query-data/flux/sql.md
View File

@ -246,7 +246,7 @@ curl --request PATCH http://localhost:8086/api/v2/orgs/<org-id>/secrets \
**To store secrets, you need:**
- [your organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- [your authentication token](/influxdb/v2.0/security/tokens/view-tokens/)
- [your API token](/influxdb/v2.0/security/tokens/view-tokens/)
{{% /tab-content %}}
{{% tab-content %}}
```sh

8
content/influxdb/v2.0/query-data/influxql.md
View File

@ -54,9 +54,9 @@ to verify the buckets you want to query are mapped to a database and retention p
Use the [`influx v1 dbrp list` command](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/) to list DBRP mappings.
{{% note %}}
The examples below assume that your organization and authentication token are
The examples below assume that your organization and API token are
provided by the active [InfluxDB connection configuration](/influxdb/v2.0/reference/cli/influx/config/) in the `influx` CLI.
If not, include your organization (`--org`) and authentication token (`--token`) with each command.
If not, include your organization (`--org`) and API token (`--token`) with each command.
{{% /note %}}
##### View all DBRP mappings
@ -80,7 +80,7 @@ Include the following:
- **Request method:** `GET`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Authorization:** `Token` schema with your InfluxDB [API token](/influxdb/v2.0/security/tokens/)
- **Query parameters:**
{{< req type="key" >}}
- {{< req "\*" >}} **orgID:** [organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
@ -154,7 +154,7 @@ Include the following:
- **Request method:** `POST`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Authorization:** `Token` schema with your InfluxDB [API token](/influxdb/v2.0/security/tokens/)
- **Content-type:** `application/json`
- **Request body:** JSON object with the following fields:
{{< req type="key" >}}

6
content/influxdb/v2.0/reference/api/influxdb-1x/_index.md
View File

@ -21,7 +21,7 @@ InfluxDB 1.x client libraries and third-party integrations like [Grafana](https:
## Authentication
InfluxDB 2.0 requires all query and write requests to be authenticated with an
[authentication token](/influxdb/v2.0/security/tokens/) or 1.x compatible
[API token](/influxdb/v2.0/security/tokens/) or 1.x compatible
credentials.
* [Authenticate with the Token scheme](#authenticate-with-the-token-scheme)
@ -30,7 +30,7 @@ credentials.
### Authenticate with the Token scheme
Token authentication requires the following credential:
- **token**: InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **token**: InfluxDB [API token](/influxdb/v2.0/security/tokens/)
Use the `Authorization` header with the `Token` scheme to provide your token to InfluxDB.
@ -70,7 +70,7 @@ Use the following authentication schemes with clients that support the InfluxDB
Username and password schemes require the following credentials:
- **username**: 1.x username (this is separate from the UI login username)
- **password**: 1.x password or InfluxDB authentication token.
- **password**: 1.x password or InfluxDB API token.
{{% note %}}
#### Password or Token

4
content/influxdb/v2.0/reference/cli/influx/_index.md
View File

@ -23,7 +23,7 @@ influx [command]
```
### Provide required authentication credentials
To avoid having to pass your InfluxDB **host**, **authentication token**, and **organization**
To avoid having to pass your InfluxDB **host**, **API token**, and **organization**
with each command, store them in an `influx` CLI configuration (config).
`influx` commands that require these credentials automatically retrieve these
credentials from the active config.
@ -47,7 +47,7 @@ For more information about managing CLI configurations, see the
| Command | Description |
|:------- |:----------- |
| [apply](/influxdb/v2.0/reference/cli/influx/apply) | Apply an InfluxDB template |
| [auth](/influxdb/v2.0/reference/cli/influx/auth) | Authentication token management commands |
| [auth](/influxdb/v2.0/reference/cli/influx/auth) | API token management commands |
| [backup](/influxdb/v2.0/reference/cli/influx/backup) | Back up data |
| [bucket](/influxdb/v2.0/reference/cli/influx/bucket) | Bucket management commands |
| [completion](/influxdb/v2.0/reference/cli/influx/completion) | Generate completion scripts |

4
content/influxdb/v2.0/reference/cli/influx/apply/_index.md
View File

@ -25,7 +25,7 @@ influx apply [flags]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
| :--- | :------------------------ | :------------------------------------------------------------------------------------------ | :--------- | :-------------------- |
|:-----|:--------------------------|:--------------------------------------------------------------------------------------------|:-----------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--disable-color` | Disable color in output | | |
@ -46,7 +46,7 @@ influx apply [flags]
| | `--secret` | Secrets to provide with the template (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack ID to associate when applying the template | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples: how to apply a template or stack

14
content/influxdb/v2.0/reference/cli/influx/auth/_index.md
View File

@ -1,6 +1,6 @@
---
title: influx auth
description: The `influx auth` command and its subcommands manage authentication tokens in InfluxDB.
description: The `influx auth` command and its subcommands manage API tokens in InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth
@ -13,7 +13,7 @@ cascade:
- /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
---
The `influx auth` command and its subcommands manage authentication tokens in InfluxDB.
The `influx auth` command and its subcommands manage API tokens in InfluxDB.
## Usage
```
@ -27,11 +27,11 @@ influx auth [command]
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [active](/influxdb/v2.0/reference/cli/influx/auth/active) | Activate authentication token |
| [create](/influxdb/v2.0/reference/cli/influx/auth/create) | Create authentication token |
| [delete](/influxdb/v2.0/reference/cli/influx/auth/delete) | Delete authentication token |
| [list](/influxdb/v2.0/reference/cli/influx/auth/list) | List authentication tokens |
| [inactive](/influxdb/v2.0/reference/cli/influx/auth/inactive) | Inactivate authentication token |
| [active](/influxdb/v2.0/reference/cli/influx/auth/active) | Activate API token |
| [create](/influxdb/v2.0/reference/cli/influx/auth/create) | Create API token |
| [delete](/influxdb/v2.0/reference/cli/influx/auth/delete) | Delete API token |
| [list](/influxdb/v2.0/reference/cli/influx/auth/list) | List API tokens |
| [inactive](/influxdb/v2.0/reference/cli/influx/auth/inactive) | Inactivate API token |
## Flags
| Flag | | Description |

22
content/influxdb/v2.0/reference/cli/influx/auth/active.md
View File

@ -1,6 +1,6 @@
---
title: influx auth active
description: The `influx auth active` command sets an authentication token to active in InfluxDB.
description: The `influx auth active` command sets an API token to active in InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth active
@ -8,7 +8,7 @@ menu:
weight: 201
---
The `influx auth active` command activates an authentication token.
The `influx auth active` command activates an API token.
Only active tokens authorize access to InfluxDB.
## Usage
@ -18,23 +18,23 @@ influx auth active [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `active` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) Authentication token ID | string | |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Example
{{< cli/influx-creds-note >}}
##### Activate an authentication token
##### Activate an API token
```sh
influx auth active --id 06c86c40a9f36000
```
```

34
content/influxdb/v2.0/reference/cli/influx/auth/create.md
View File

@ -1,6 +1,6 @@
---
title: influx auth create
description: The `influx auth create` creates an authentication token in InfluxDB.
description: The `influx auth create` creates an API token in InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth create
@ -8,7 +8,7 @@ menu:
weight: 201
---
The `influx auth create` creates an authentication token in InfluxDB.
The `influx auth create` creates an API token in InfluxDB.
## Usage
```
@ -17,17 +17,17 @@ influx auth create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :------------------------------ | :-------------------------------------------------------------------- | :---------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Authentication token description | string | |
|:-----|:--------------------------------|:----------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | API token description | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--read-bucket` | Grant permission to read a specified bucket ID | stringArray | |
| | `--read-buckets` | Grant permission to read **all** organization buckets | | |
| | `--read-checks` | Grant permission to read checks | | |
@ -40,8 +40,8 @@ influx auth create [flags]
| | `--read-telegrafs` | Grant permission to read Telegraf configurations | | |
| | `--read-user` | Grant permission to read organization users | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--write-bucket` | Grant permission to write to specified a bucket ID | stringArray | |
| | `--write-buckets` | Grant permission to create and update **all** organization buckets | | |
| | `--write-checks` | Grant permission to create checks | | |
@ -58,11 +58,11 @@ influx auth create [flags]
{{< cli/influx-creds-note >}}
- [Create an authentication token with read and write permissions](#create-an-authentication-token-with-read-and-write-permissions)
- [Create an API token with read and write permissions](#create-an-authentication-token-with-read-and-write-permissions)
- [Create a token with read and write access to specific buckets](#create-a-token-with-read-and-write-access-to-specific-buckets)
- [Create a read-only authentication token](#create-a-read-only-authentication-token)
- [Create a read-only API token](#create-a-read-only-authentication-token)
##### Create an authentication token with read and write permissions
##### Create an API token with read and write permissions
```sh
influx auth create \
--read-buckets \
@ -96,7 +96,7 @@ influx auth create \
--write-bucket 0000000000000002
```
##### Create a read-only authentication token
##### Create a read-only API token
```sh
influx auth create \
--read-buckets \
@ -109,4 +109,4 @@ influx auth create \
--read-tasks \
--read-telegrafs \
--read-user
```
```

22
content/influxdb/v2.0/reference/cli/influx/auth/delete.md
View File

@ -1,6 +1,6 @@
---
title: influx auth delete
description: The `influx auth delete` command deletes an authentication token from InfluxDB.
description: The `influx auth delete` command deletes an API token from InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth delete
@ -8,7 +8,7 @@ menu:
weight: 201
---
The `influx auth delete` command deletes an authentication token from InfluxDB.
The `influx auth delete` command deletes an API token from InfluxDB.
## Usage
```
@ -17,23 +17,23 @@ influx auth delete [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Authentication token ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
##### Delete an authentication token
##### Delete an API token
```sh
influx auth delete --id 06c86c40a9f36000
```
```

20
content/influxdb/v2.0/reference/cli/influx/auth/inactive.md
View File

@ -1,6 +1,6 @@
---
title: influx auth inactive
description: The `influx auth inactive` command inactivates an authentication token in InfluxDB.
description: The `influx auth inactive` command inactivates an API token in InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth inactive
@ -8,7 +8,7 @@ menu:
weight: 201
---
The `influx auth inactive` command inactivates an authentication token in InfluxDB.
The `influx auth inactive` command inactivates an API token in InfluxDB.
Inactive tokens **do not** authorize access to InfluxDB.
To temporarily disable client access to InfluxDB, inactivate the authentication
@ -25,23 +25,23 @@ influx auth inactive [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `inactive` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Authentication token ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
{{< cli/influx-creds-note >}}
##### Inactivate an authentication token
##### Inactivate an API token
```sh
influx auth inactive --id 06c86c40a9f36000
```

32
content/influxdb/v2.0/reference/cli/influx/auth/list.md
View File

@ -1,6 +1,6 @@
---
title: influx auth list
description: The `influx auth list` command lists authentication tokens in InfluxDB.
description: The `influx auth list` command lists API tokens in InfluxDB.
menu:
influxdb_2_0_ref:
name: influx auth list
@ -10,7 +10,7 @@ aliases:
- /influxdb/v2.0/reference/cli/influx/auth/find
---
The `influx auth list` command lists and searches authentication tokens in InfluxDB.
The `influx auth list` command lists and searches API tokens in InfluxDB.
## Usage
```
@ -22,32 +22,32 @@ influx auth list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Authentication token ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |
## Examples
{{< cli/influx-creds-note >}}
##### List all authentication tokens
##### List all API tokens
```sh
influx auth list
```
##### List authentication tokens associated with a user
##### List API tokens associated with a user
```sh
influx auth list --user username
```
```

4
content/influxdb/v2.0/reference/cli/influx/backup/_index.md
View File

@ -24,7 +24,7 @@ influx backup [flags] path
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| ---- | ----------------- | ---------------------------------------------------------------------------------------------------------- | ---------- | --------------------- |
|------|-------------------|------------------------------------------------------------------------------------------------------------|------------|-----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-id` | ID of the bucket to back up from (mutually exclusive with `--bucket`) | string | |
| `-b` | `--bucket` | Name of the bucket to back up from (mutually exclusive with `--bucket-id`) | string | |
@ -38,7 +38,7 @@ influx backup [flags] path
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/v2.0/reference/cli/influx/bucket/_index.md
View File

@ -38,4 +38,4 @@ influx bucket [command]
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

2
content/influxdb/v2.0/reference/cli/influx/bucket/create.md
View File

@ -42,7 +42,7 @@ influx bucket create [flags]
| | `--schema-type` | Bucket schema type (`explicit`, default `implicit`) _(Cloud only)_. For more information, see [Manage bucket schema](/influxdb/cloud/organizations/buckets/bucket-schema/). | string | |
| | `--shard-group-duration` | Bucket shard group duration (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

2
content/influxdb/v2.0/reference/cli/influx/bucket/delete.md
View File

@ -36,7 +36,7 @@ influx bucket delete [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

4
content/influxdb/v2.0/reference/cli/influx/bucket/list.md
View File

@ -36,7 +36,7 @@ influx bucket list [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -59,4 +59,4 @@ influx bucket list --name example-bucket
##### List a bucket by ID
```sh
influx bucket list --id 06c86c40a9f36000
```
```

2
content/influxdb/v2.0/reference/cli/influx/bucket/update.md
View File

@ -38,7 +38,7 @@ influx bucket update [flags]
| `-r` | `--retention` | New duration bucket will retain data | duration | |
| | `--shard-group-duration` | Custom shard group duration for the bucket (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

10
content/influxdb/v2.0/reference/cli/influx/config/create.md
View File

@ -18,15 +18,15 @@ influx config create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :----------------------------------------------------------- | :--------: | :-------------------- |
|:-----|:-----------------|:-------------------------------------------------------------|:----------:|:----------------------|
| `-a` | `--active` | Set the specified connection to be the active configuration. | | |
| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | |
| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | |
| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-o` | `--org` | Organization name | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/v2.0/reference/cli/influx/config/list.md
View File

@ -10,7 +10,7 @@ weight: 201
The `influx config list` command lists all InfluxDB connection configurations in
the `configs` file (by default, stored at `~/.influxdbv2/configs`).
Each connection configuration includes a URL, authentication token, and active setting.
Each connection configuration includes a URL, API token, and active setting.
An asterisk (`*`) indicates the active configuration.
## Usage

16
content/influxdb/v2.0/reference/cli/influx/dashboards/_index.md
View File

@ -22,19 +22,19 @@ influx dashboards [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :---------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `dashboards` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `$INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `$INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Dashboard ID to retrieve | stringArray | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

28
content/influxdb/v2.0/reference/cli/influx/delete/_index.md
View File

@ -25,21 +25,21 @@ Running `influx delete` without the `-p` or `--predicate` flag deletes all data
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket` | Name of bucket to remove data from (mutually exclusive with `--bucket-id`) | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket` | Name of bucket to remove data from (mutually exclusive with `--bucket-id`) | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/influxdb/v2.0/reference/syntax/delete-predicate)) | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/influxdb/v2.0/reference/syntax/delete-predicate)) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--start` | ({{< req >}}) Start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| | `--stop` | ({{< req >}}) Stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--start` | ({{< req >}}) Start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| | `--stop` | ({{< req >}}) Stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -73,4 +73,4 @@ influx delete \
--bucket example-bucket \
--start 2020-03-01T00:00:00Z \
--stop 2020-11-14T00:00:00Z
```
```

4
content/influxdb/v2.0/reference/cli/influx/export/_index.md
View File

@ -34,7 +34,7 @@ influx export [command]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
| :--- | :------------------------ | :------------------------------------------------------------------------------- | :--------- | :-------------------- |
|:-----|:--------------------------|:---------------------------------------------------------------------------------|:-----------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-names` | Comma-separated list of bucket names | string | |
| | `--buckets` | Comma-separated list of bucket IDs | string | |
@ -60,7 +60,7 @@ influx export [command]
| | `--tasks` | Comma-separated list of task IDs | string | |
| | `--telegraf-config-names` | Comma-separated list of Telegraf configuration names | string | |
| | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| | `--variable-names` | Comma-separated list of variable names | string | |
| | `--variables` | Comma-separated list of variable IDs | string | |

6
content/influxdb/v2.0/reference/cli/influx/export/all.md
View File

@ -22,7 +22,7 @@ _For detailed examples of exporting InfluxDB templates, see
{{% note %}}
To export resources as a template, you must use the **Operator token** created for
the initial InfluxDB user or an **All-Access token**.
For information about creating an All-Access token, see [Create an authentication token](/influxdb/v2.0/security/tokens/create-token/).
For information about creating an All-Access API token, see [Create an API token](/influxdb/v2.0/security/tokens/create-token/).
{{% /note %}}
## Usage
@ -32,7 +32,7 @@ influx export all [flags]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
| :--- | :---------------- | :---------------------------------------------------------------------------------------------- | :---------- | :-------------------- |
|:-----|:------------------|:------------------------------------------------------------------------------------------------|:------------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
@ -43,7 +43,7 @@ influx export all [flags]
| `-o` | `--org` | Organization name that owns the resources (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

6
content/influxdb/v2.0/reference/cli/influx/export/stack.md
View File

@ -19,7 +19,7 @@ All `metadata.name` fields remain the same.
{{% note %}}
To export resources as a template, you must use the **Operator token** created for
the initial InfluxDB user or an **All-Access token**.
For information about creating an All-Access token, see [Create an authentication token](/influxdb/v2.0/security/tokens/create-token/).
For information about creating an All-Access API token, see [Create an API token](/influxdb/v2.0/security/tokens/create-token/).
{{% /note %}}
## Usage
@ -29,7 +29,7 @@ influx export stack <stack_id> [flags]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
| :--- | :---------------- | :------------------------------------------------------------------------------- | :--------- | :-------------------- |
|:-----|:------------------|:---------------------------------------------------------------------------------|:-----------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
@ -39,7 +39,7 @@ influx export stack <stack_id> [flags]
| `-o` | `--org` | Organization name that owns the resources (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

4
content/influxdb/v2.0/reference/cli/influx/org/create.md
View File

@ -28,7 +28,7 @@ influx org create [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Organization name | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -44,4 +44,4 @@ influx org create --name example-org
influx org create \
--name example-org \
--description "Example organization description"
```
```

16
content/influxdb/v2.0/reference/cli/influx/org/delete.md
View File

@ -17,17 +17,17 @@ influx org delete [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -36,4 +36,4 @@ influx org delete [flags]
##### Delete an organization
```sh
influx org delete --id 0Xx0oox00XXoxxoo1
```
```

18
content/influxdb/v2.0/reference/cli/influx/org/list.md
View File

@ -22,18 +22,18 @@ influx org list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG_ID` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -56,4 +56,4 @@ influx org list --name example-org
##### List a specific organization by ID
```sh
influx org list --id 0Xx0oox00XXoxxoo1
```
```

18
content/influxdb/v2.0/reference/cli/influx/org/members/add.md
View File

@ -16,15 +16,15 @@ influx org members add [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `add` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | User ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:----------------|:-----------------------------------------------------------|:----------:|:---------------------|
| `-h` | `--help` | Help for the `add` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | User ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

14
content/influxdb/v2.0/reference/cli/influx/org/members/list.md
View File

@ -17,16 +17,16 @@ influx org members list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :--------------------------------------------------------- | :--------: | :-------------------- |
|:-----|:-----------------|:-----------------------------------------------------------|:----------:|:----------------------|
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -36,4 +36,4 @@ influx org members list [flags]
```sh
influx org members list \
--name example-org
```
```

4
content/influxdb/v2.0/reference/cli/influx/org/members/remove.md
View File

@ -25,7 +25,7 @@ influx org members remove [flags]
| `-m` | `--member` | Member ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -36,4 +36,4 @@ influx org members remove [flags]
influx org members remove \
--member 00x0oo0X0xxxo000 \
--name example-org
```
```

20
content/influxdb/v2.0/reference/cli/influx/org/update.md
View File

@ -17,19 +17,19 @@ influx org update [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :----------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | New description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:-------------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | New description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New organization name | string | `INFLUX_ORG` |
| `-n` | `--name` | New organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -47,4 +47,4 @@ influx org update \
influx org update \
--id 0Xx0oox00XXoxxoo1
--description "New example organization description"
```
```

2
content/influxdb/v2.0/reference/cli/influx/ping/_index.md
View File

@ -16,7 +16,7 @@ related:
The `influx ping` command checks the health of a running InfluxDB instance by
querying the `/health` endpoint.
It does not require an authentication token.
It does not require an API token.
## Usage
```

22
content/influxdb/v2.0/reference/cli/influx/query/_index.md
View File

@ -37,19 +37,19 @@ drop columns such as `_start` and `_stop` to optimize the download file size.
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `query` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--profilers` | Flux query profilers to enable (comma-separated) | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--profilers` | Flux query profilers to enable (comma-separated) | string | |
| `-r` | `--raw` | Output raw query results (annotated CSV) | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -82,4 +82,4 @@ _For more information about profilers, see [Flux profilers](/influxdb/v2.0/refer
influx query \
--profilers operator,query \
'from(bucket:"example-bucket") |> range(start:-1m)'
```
```

16
content/influxdb/v2.0/reference/cli/influx/repl/_index.md
View File

@ -32,13 +32,13 @@ To use the Flux REPL, you must first authenticate with a [token](/influxdb/v2.0/
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `repl` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

24
content/influxdb/v2.0/reference/cli/influx/restore/index.md
View File

@ -43,23 +43,23 @@ influx restore [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of the bucket to restore (mutually exclusive with `--bucket-id`) | string | |
| | `--bucket-id` | ID of the bucket to restore (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of the bucket to restore (mutually exclusive with `--bucket-id`) | string | |
| | `--bucket-id` | ID of the bucket to restore (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--full` | Fully restore and replace all data on server | | |
| `-h` | `--help` | Help for the `restore` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--new-bucket` | Name of the bucket to restore to | string | |
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--new-bucket` | Name of the bucket to restore to | string | |
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

20
content/influxdb/v2.0/reference/cli/influx/secret/delete.md
View File

@ -18,19 +18,19 @@ influx secret delete [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -39,4 +39,4 @@ influx secret delete [flags]
##### Delete a secret
```sh
influx secret delete --key EXAMPLE_SECRET_KEY
```
```

4
content/influxdb/v2.0/reference/cli/influx/secret/list.md
View File

@ -32,7 +32,7 @@ influx secret list [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -41,4 +41,4 @@ influx secret list [flags]
##### List all secret keys
```sh
influx secret list
```
```

22
content/influxdb/v2.0/reference/cli/influx/secret/update.md
View File

@ -27,20 +27,20 @@ influx secret update [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | ({{< req >}}) Secret value | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | ({{< req >}}) Secret value | string | |
## Examples
@ -58,4 +58,4 @@ influx secret update \
influx secret update \
--key EXAMPLE_KEY \
--value NEW_EXAMPLE_VALUE
```
```

16
content/influxdb/v2.0/reference/cli/influx/stacks/_index.md
View File

@ -35,20 +35,20 @@ influx stacks [command]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :---------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `stacks` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack IDs to filter by | stringArray | |
| | `--stack-name` | Stack names to filter by | stringArray | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

22
content/influxdb/v2.0/reference/cli/influx/stacks/init.md
View File

@ -19,22 +19,22 @@ influx stacks init [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :-------------------- | :-------------------------------------------------------------------- | :-------------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:----------------------|:----------------------------------------------------------------------|:---------------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `init` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-u` | `--template-url` | Template URLs to associate with a stack | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

20
content/influxdb/v2.0/reference/cli/influx/stacks/remove.md
View File

@ -22,21 +22,21 @@ influx stacks remove [flags]
`remove`, `rm`, `uninstall`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :-------------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:---------------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--force` | Skip confirmation prompt. | | |
| `-h` | `--help` | Help for the `remove` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--stack-id` | Stack IDs to remove | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -45,4 +45,4 @@ influx stacks remove [flags]
##### Remove a stack and all of its associated resources
```sh
influx stacks remove --stack-id 0Xx0oox00XXoxxoo1
```
```

24
content/influxdb/v2.0/reference/cli/influx/stacks/update.md
View File

@ -17,23 +17,23 @@ influx stacks update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :-------------------- | :-------------------------------------------------------------------- | :-------------: | :-------------------- |
| | `--addResource` | Associate an existing resource with a stack | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--export-file` | Destination for exported template | string | |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:----------------------|:----------------------------------------------------------------------|:---------------:|:----------------------|
| | `--addResource` | Associate an existing resource with a stack | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--export-file` | Destination for exported template | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--stack-id` | The stack ID to update | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--stack-id` | The stack ID to update | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-u` | `--template-url` | Template URLs to associate with a stack | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
{{% warn %}}
#### Export an updated template

20
content/influxdb/v2.0/reference/cli/influx/task/create.md
View File

@ -17,19 +17,19 @@ influx task create [task literal] [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Example
@ -56,4 +56,4 @@ influx task create $FLUX_TASK
##### Create a task from a file
```sh
influx task create --file /path/to/example-task.flux
```
```

14
content/influxdb/v2.0/reference/cli/influx/task/delete.md
View File

@ -17,17 +17,17 @@ influx task delete [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

24
content/influxdb/v2.0/reference/cli/influx/task/list.md
View File

@ -22,21 +22,21 @@ influx task list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Task ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--limit` | Number of tasks to find (default `100`) | integer | |
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--limit` | Number of tasks to find (default `100`) | integer | |
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-n` | `--user-id` | Task owner ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-n` | `--user-id` | Task owner ID | string | |
## Examples
@ -65,4 +65,4 @@ influx task list --limit 20
##### List all tasks created by a specific user
```sh
influx task list --user-id 0Xx0oox00XXoxxoo1
```
```

16
content/influxdb/v2.0/reference/cli/influx/task/log/list.md
View File

@ -22,18 +22,18 @@ influx task log list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--run-id` | Run ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--run-id` | Run ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

26
content/influxdb/v2.0/reference/cli/influx/task/retry-failed.md
View File

@ -16,24 +16,24 @@ influx task retry-failed [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :------------------------------------------------------------------------ | :--------: | :-------------------- |
| | `--after` | Retry task runs that occurred after this time (RFC3339 timestamp) | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--before` | Retry task runs that occurred before this time (RFC3339 timestamp) | string | |
|:-----|:------------------|:--------------------------------------------------------------------------|:----------:|:----------------------|
| | `--after` | Retry task runs that occurred after this time (RFC3339 timestamp) | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--before` | Retry task runs that occurred before this time (RFC3339 timestamp) | string | |
| | `--dry-run` | Print information about task runs that would be retried | | |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Task ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--run-limit` | Maximum number of failed runs to retry per task (`1-500`, default `100`) | integer | |
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--run-limit` | Maximum number of failed runs to retry per task (`1-500`, default `100`) | integer | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--task-limit` | Maximum number of tasks to retry failed runs for (`1-500`, default `100`) | integer | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--task-limit` | Maximum number of tasks to retry failed runs for (`1-500`, default `100`) | integer | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

22
content/influxdb/v2.0/reference/cli/influx/task/run/list.md
View File

@ -22,21 +22,21 @@ influx task run list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--after` | After-time for filtering | string | |
| | `--before` | Before-time for filtering | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--after` | After-time for filtering | string | |
| | `--before` | Before-time for filtering | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--limit` | Limit the number of results | integer | |
| | `--run-id` | Run ID | string | |
| | `--limit` | Limit the number of results | integer | |
| | `--run-id` | Run ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

18
content/influxdb/v2.0/reference/cli/influx/task/run/retry.md
View File

@ -17,16 +17,16 @@ influx task run retry [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `retry` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-r` | `--run-id` | ({{< req >}}) Run ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-r` | `--run-id` | ({{< req >}}) Run ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-i` | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-i` | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples
@ -37,4 +37,4 @@ influx task run retry [flags]
influx task run retry \
--task-id 0Xx0oox00XXoxxoo1 \
--run-id ox0Xx0ooxx00XXoo2
```
```

20
content/influxdb/v2.0/reference/cli/influx/task/update.md
View File

@ -17,19 +17,19 @@ influx task update [task literal] [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--status` | Update task status (`active` or `inactive`) | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--status` | Update task status (`active` or `inactive`) | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Example
@ -71,4 +71,4 @@ influx task update --status active
##### Disable a task
```sh
influx task update --status inactive
```
```

2
content/influxdb/v2.0/reference/cli/influx/telegrafs/_index.md
View File

@ -44,7 +44,7 @@ influx telegrafs [command]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

2
content/influxdb/v2.0/reference/cli/influx/telegrafs/create.md
View File

@ -32,7 +32,7 @@ influx telegrafs create [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

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