Chore/jts update process clockface (#3387)

* fix: typo.

* fix: clean up auth instructions in Postman.

* fix: Postman test instruction

* fix: typo

* fix: API example for thingworx.

* fix: updates for clockface. Typo fixes. (#3374)

* fix: query sample data typos

* Update content/influxdb/cloud/query-data/execute-queries/query-sample-data.md

* Update content/influxdb/cloud/get-started.md

* Update content/influxdb/cloud/query-data/execute-queries/query-demo-data.md

* Update content/influxdb/cloud/tools/thingworx.md

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/query-data/execute-queries/query-sample-data.md

* Update content/influxdb/v2.1/query-data/execute-queries/data-explorer.md

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.0/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.1/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud/api-guide/postman.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud/get-started.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud/get-started.md

* Update content/influxdb/cloud/visualize-data/explore-metrics.md

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/api-guide/postman.md

* Update content/influxdb/cloud/query-data/execute-queries/query-sample-data.md

* fix: code typo.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
pull/3365/head^2
Jason Stirnaman 2021-11-10 10:54:18 -06:00 committed by GitHub
parent db10f2b79d
commit f9ce94d29a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 117 additions and 138 deletions

View File

@ -20,7 +20,7 @@ Complete the following steps to deploy an InfluxDB Enterprise cluster on Google
After deploying your cluster, see [Getting started with InfluxDB](/platform/introduction/getting-started) for an introduction to InfluxDB database and the InfluxData platform. After deploying your cluster, see [Getting started with InfluxDB](/platform/introduction/getting-started) for an introduction to InfluxDB database and the InfluxData platform.
>**Note:** InfluxDB Enterprise on GCP is a self-managed product. For a fully managed InfluxDB experience, check out [InfluxDB Cloud](/influxdb/cloud/get-started/). >**Note:** InfluxDB Enterprise on GCP is a self-managed product. For a fully managed InfluxDB experience, check out [InfluxDB Cloud](/influxdb/cloud/sign-up/).
## Verify prerequisites ## Verify prerequisites

View File

@ -21,7 +21,7 @@ Complete the following steps to deploy an InfluxDB Enterprise cluster on Google
After deploying your cluster, see [Getting started with InfluxDB](/platform/introduction/getting-started) for an introduction to InfluxDB database and the InfluxData platform. After deploying your cluster, see [Getting started with InfluxDB](/platform/introduction/getting-started) for an introduction to InfluxDB database and the InfluxData platform.
>**Note:** InfluxDB Enterprise on GCP is a self-managed product. For a fully managed InfluxDB experience, check out [InfluxDB Cloud](/influxdb/cloud/get-started/). >**Note:** InfluxDB Enterprise on GCP is a self-managed product. For a fully managed InfluxDB experience, check out [InfluxDB Cloud](/influxdb/cloud/sign-up/).
## Verify prerequisites ## Verify prerequisites

View File

@ -2,7 +2,7 @@
title: Use Postman with the InfluxDB API title: Use Postman with the InfluxDB API
description: > description: >
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, Use [Postman](https://www.postman.com/), a popular tool for exploring APIs,
to interact with the [InfluxDB API](/influxdb/cloud/reference/api). to interact with the [InfluxDB API](/influxdb/cloud/api-guide/).
menu: menu:
influxdb_cloud: influxdb_cloud:
parent: Tools & integrations parent: Tools & integrations
@ -13,37 +13,4 @@ aliases:
- /influxdb/cloud/reference/api/postman/ - /influxdb/cloud/reference/api/postman/
--- ---
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, {{% duplicate-oss %}}
to interact with the [InfluxDB API](/influxdb/cloud/reference/api).
## Install Postman
Download Postman from the [official downloads page](https://www.postman.com/downloads/).
Or to install with Homebrew on macOS, run the following command:
```sh
brew cask install postman
```
## Send authenticated API requests with Postman
All requests to the InfluxDB API must be authenticated.
Postman lets you configure the headers and body of HTTP requests.
Use the **Authorization** tab in Postman to include the credentials required when interacting with the InfluxDB API.
1. If you have not already, [create a token](/influxdb/cloud/security/tokens/create-token/).
2. In the **Authorization** tab, select **API Key** in the **Type** dropdown.
3. For **Key**, enter `Authorization`.
4. For **Value**, enter `Token <token string>`, replacing `<token string>` with the token generated in step 1.
5. Ensure that the **Add to** option is set to **Header**.
#### Test authentication credentials
To test the authentication, enter the root API endpoint of an InfluxDB Cloud URL into the address bar, and click **Send**.
###### InfluxDB API endpoint
```
https://cloud2.influxdata.com/api/v2
```

View File

@ -18,7 +18,7 @@ After you've [signed up for InfluxDB Cloud](/influxdb/cloud/sign-up/), you're re
- Add [sample data](#add-sample-data). - Add [sample data](#add-sample-data).
- [Use your own data](/influxdb/cloud/write-data/) to explore InfluxDB Cloud. - [Use your own data](/influxdb/cloud/write-data/) to explore InfluxDB Cloud.
2. [Create a notebook](#create-a-notebook): 2. [Create a notebook](#create-a-notebook):
1. Clicking **Notebooks** in the navigation menu on the left. 1. Click **Notebooks** in the navigation menu on the left.
{{< nav-icon "books" >}} {{< nav-icon "books" >}}
@ -54,15 +54,17 @@ Use [sample data](/influxdb/cloud/reference/sample-data/) to quickly populate In
### Add sample data with community templates ### Add sample data with community templates
1. Visit the **InfluxDB templates page** in the InfluxDB Cloud UI. Click **Settings** > **Templates** in the navigation menu on the left. 1. In the navigation menu on the left, click **Settings** > **Templates**.
{{< nav-icon "settings" >}} {{< nav-icon "settings" >}}
2. Paste the Sample Data community temple URL in **resource manifest file** field: 2. Paste the [Sample Data community template URL](https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml) in the **resource manifest file** field and click the **{{< caps >}}Lookup Template{{< /caps >}}** button.
``` #### Sample Data community template URL
```
https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml
``` ```
The sample data template installs a task that collects sample data and dashboards to visualize the sample data. The sample data template installs a task that collects sample data and dashboards to visualize the sample data.
After installing the template, sample data is downloaded and stored in the sample data bucket at regular intervals. After installing the template, sample data is downloaded and stored in the sample data bucket at regular intervals.
@ -145,4 +147,3 @@ After processing, send the downsampled data to a new bucket to store and view it
3. Enter a name for your bucket and click **Create**. 3. Enter a name for your bucket and click **Create**.
4. Click **Run** from the **Preview** dropdown list to run the notebook and write to the output bucket a single time. 4. Click **Run** from the **Preview** dropdown list to run the notebook and write to the output bucket a single time.
5. To write continuously, click **Export as Task** in the upper right corner of the **Output to Bucket** cell. For details about working with tasks, see [Manage tasks](/influxdb/cloud/process-data/manage-tasks/). 5. To write continuously, click **Export as Task** in the upper right corner of the **Output to Bucket** cell. For details about working with tasks, see [Manage tasks](/influxdb/cloud/process-data/manage-tasks/).

View File

@ -47,7 +47,7 @@ Choose from the following demo data sets:
Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/) Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/)
to query and visualize data in demo data buckets. to query and visualize data in demo data buckets.
In the navigation menu on the left, click **Explore (Data Explorer)**. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "explore" >}} {{< nav-icon "explore" >}}

View File

@ -38,21 +38,23 @@ Approximate sample dataset sizes are listed for each [sample dataset](/influxdb/
### Add sample data with community template ### Add sample data with community template
1. Visit the **InfluxDB templates page** in the InfluxDB Cloud UI. Click **Settings** > **Templates** in the navigation menu on the left. 1. In the navigation menu on the left, select **Settings** > **Templates**.
{{< nav-icon "settings" >}} {{< nav-icon "settings" >}}
2. Paste the Sample Data community temple URL in **resource manifest file** field: 2. Paste the [Sample Data community template URL](https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml) in the **resource manifest file** field and click the **{{< caps >}}Lookup Template{{< /caps >}}** button.
``` #### Sample Data community template URL
```
https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml https://github.com/influxdata/community-templates/blob/master/sample-data/sample-data.yml
``` ```
## Explore sample data ## Explore sample data
Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/) Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/)
to query and visualize data in sample data buckets. to query and visualize data in sample data buckets.
In the navigation menu on the left, click **Explore (Data Explorer)**. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "explore" >}} {{< nav-icon "explore" >}}
@ -85,5 +87,3 @@ After adding a sample data bucket, create a dashboard specific to the sample dat
5. Copy and paste the `sample.data()` function into the script editor. 5. Copy and paste the `sample.data()` function into the script editor.
6. Click **Submit** to run the query. 6. Click **Submit** to run the query.
6. Define the variables of your sample data. 6. Define the variables of your sample data.

View File

@ -21,7 +21,7 @@ to visualize data from InfluxDB Cloud.
The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**. The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**.
{{% /note %}} {{% /note %}}
1. [Sign up for {{< cloud-name >}}](/influxdb/cloud/get-started/). 1. [Sign up for {{< cloud-name >}}](/influxdb/cloud/sign-up/).
2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or 2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or
[download and install Grafana](https://grafana.com/grafana/download). [download and install Grafana](https://grafana.com/grafana/download).
3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally, 3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally,

View File

@ -14,7 +14,7 @@ influxdb/cloud/tags: [thingworx, ptc, iiot, persistence provider]
InfluxDB Cloud is a built-in component of ThingWorx on PTC Cloud in Azure. Therefore, PTC recommends using ThingWorx on [PTC Cloud](https://www.ptc.com/en/customer-success/cloud). Alternatively, use this guide to configure self-managed ThingWorx to use InfluxDB Cloud as a persistence provider. InfluxDB Cloud is a built-in component of ThingWorx on PTC Cloud in Azure. Therefore, PTC recommends using ThingWorx on [PTC Cloud](https://www.ptc.com/en/customer-success/cloud). Alternatively, use this guide to configure self-managed ThingWorx to use InfluxDB Cloud as a persistence provider.
{{% /note %}} {{% /note %}}
**To use InfluxDB Cloud as persistence provider in ThingWorx** **To use InfluxDB Cloud as a persistence provider in ThingWorx**
1. Set up an [InfluxDB Cloud account compatible with ThingWorx](#set-up-an-influxdb-cloud-account-compatible-with-thingworx) 1. Set up an [InfluxDB Cloud account compatible with ThingWorx](#set-up-an-influxdb-cloud-account-compatible-with-thingworx)
2. [Set up PTC ThingWorx](#set-up-ptc-thingworx) 2. [Set up PTC ThingWorx](#set-up-ptc-thingworx)
@ -22,41 +22,41 @@ InfluxDB Cloud is a built-in component of ThingWorx on PTC Cloud in Azure. There
## Set up an InfluxDB Cloud account compatible with ThingWorx ## Set up an InfluxDB Cloud account compatible with ThingWorx
1. [Sign up for a Cloud account](https://cloud2.influxdata.com/signup), and do the following when signing up: 1. [Sign up for a Cloud account](/influxdb/cloud/sign-up/), and do the following when signing up:
- Select an AWS or Google region to store your data. To deploy on Azure region, see [use PTC Cloud](https://www.ptc.com/en/customer-success/cloud). - Select an AWS or Google region to store your data. To deploy on Azure region, see [use PTC Cloud](https://www.ptc.com/en/customer-success/cloud).
- Select a Usage-based plan by entering credit card information. - Select a Usage-based plan by entering credit card information.
For more information, see [how to sign up for InfluxDB Cloud](/influxdb/cloud/sign-up/).
2. [Create a bucket](/influxdb/cloud/organizations/buckets/create-bucket/) with an infinite retention period (select **Never** for when to **Delete Data**), and then copy the new bucket ID and save for step 4. 2. [Create a bucket](/influxdb/cloud/organizations/buckets/create-bucket/) with an infinite retention period (select **Never** for when to **Delete Data**), and then copy the new bucket ID and save for step 4.
{{% note %}} {{% note %}}
**Tip:** We recommend naming your bucket “thingworx”. In ThingWorx, this bucket name becomes the database name selected for the InfluxDB persistence provider configuration. **Tip:** We recommend naming your bucket “thingworx”. In ThingWorx, this bucket name becomes the database name selected for the InfluxDB persistence provider configuration.
{{% /note %}} {{% /note %}}
3. [Create an All-Access token](/influxdb/v2.0/security/tokens/create-token/) in InfluxDB Cloud, and save the token string for step 4. To access this string in the UI, double-clicking the new token name, and copy the string at the top of the dialog. 3. [Create an All-Access token](/influxdb/cloud/security/tokens/create-token/) in InfluxDB Cloud, and save the token string for step 4. To access this string in the UI, double-clicking the new token name, and copy the string at the top of the dialog.
4. In terminal, create a DBRP mapping for your bucket by running the following command, replacing all parameters within the brackets (`${}`) below: 4. Create a DBRP mapping for your bucket by sending an HTTP `POST` request to the `/api/v2/dbrps/` InfluxDB API endpoint.
```sh ```sh
curl --request POST "${influxdb-cloud-url}/api/v2/dbrps" \ curl --request POST "${influxdb-cloud-url}/api/v2/dbrps" \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header "Authorization: Token ${token}" \ --header "Authorization: Token ${INFLUX_API_TOKEN}" \
--data-raw "{ --data-raw "{
\"bucket_id\": \"${bucket_id}\", \"bucketID\": \"${INFLUX_BUCKET_ID}\",
\"organization_id\": \"${org_id}\", \"orgID\": \"${INFLUX_ORG_ID}\",
\"database\": \"thingworx", \"database\": \"${INFLUX_BUCKET}\",
\"retention_policy\": \"autogen\", \"retention_policy\": \"${INFLUX_RETENTION_PERIOD}\",
\"default\": true \"default\": true
}" }"
``` ```
- `bucket_id` created in step 2 Replace the following:
- `token` created in step 3 - *`INFLUX_BUCKET_ID`*: your [InfluxDB bucket](/influxdb/cloud/reference/glossary/#bucket) ID, created in step 2
- `org-id` in your URL (for example, if your URL includes: `.../orgs/039ax0d07d962000`, the org ID is `039ax0d07d962000`) - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token), created in step 3
- `database` same as bucket name created in step 2 - *`INFLUX_ORG_ID`*: your [InfluxDB organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- `retention_policy` is the retention period, typically "autogen" - *`INFLUX_BUCKET`*: your [InfluxDB bucket](/influxdb/cloud/reference/glossary/#bucket) name (`thingworx`), created in step 2
- *`INFLUX_RETENTION_PERIOD`*: your [InfluxDB retention period](/influxdb/cloud/reference/glossary/#retention-period), typically `autogen`
5. (Optional) We recommend [creating a new Read/Write token](/influxdb/v2.0/security/tokens/create-token/) with read/write access to the bucket that you set up in step 2. A read/write token is useful for non-admin users to access configuration settings in ThingWorx. Copy and save the new token string to [set up PTC ThingWorx](#set-up-ptc-thingworx). (To do this, double-click the token in the UI, and copy the string at the top of the dialog.) 5. (Optional) We recommend [creating a new Read/Write token](/influxdb/cloud/security/tokens/create-token/) with read/write access to the bucket that you set up in step 2. A read/write token is useful for non-admin users to access configuration settings in ThingWorx. Copy and save the new token string to [set up PTC ThingWorx](#set-up-ptc-thingworx). (To do this, double-click the token in the UI, and copy the string at the top of the dialog.)
## Set up PTC ThingWorx ## Set up PTC ThingWorx
1. If you haven't already, [start at step 4 in Using InfluxDB as the Persistence Provider](https://support.ptc.com/help/thingworx_hc/thingworx_8_hc/en/index.html#page/ThingWorx%2FHelp%2FComposer%2FDataStorage%2FPersistenceProviders%2Fusing_influxdb_as_the_persistence_provider.html). (Steps 1-3 are covered being InfluxDB Cloud is already configured.) 1. If you haven't already, [start at step 4 in Using InfluxDB as the Persistence Provider](https://support.ptc.com/help/thingworx_hc/thingworx_8_hc/en/index.html#page/ThingWorx%2FHelp%2FComposer%2FDataStorage%2FPersistenceProviders%2Fusing_influxdb_as_the_persistence_provider.html). (Steps 1-3 are covered in [Set up an InfluxDB Cloud account compatible with ThingWorx](#set-up-an-influxdb-cloud-account-compatible-with-thingworx).)
2. For the persistence provider configuration settings, enter the following values: 2. For the persistence provider configuration settings, enter the following values:
- **Connection URL**: Your [InfluxDB Cloud region URL](/influxdb/cloud/reference/regions) - **Connection URL**: Your [InfluxDB Cloud region URL](/influxdb/cloud/reference/regions)

View File

@ -26,7 +26,7 @@ Flux is InfluxData's functional data scripting language designed for querying,
analyzing, and acting on time series data. analyzing, and acting on time series data.
See [Get started with Flux](/influxdb/cloud/query-data/get-started) to learn more about Flux. See [Get started with Flux](/influxdb/cloud/query-data/get-started) to learn more about Flux.
1. In the navigation menu on the left, select **Explore** (**Data Explorer**). 1. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "data-explorer" >}} {{< nav-icon "data-explorer" >}}

View File

@ -2,7 +2,7 @@
title: Use Postman with the InfluxDB API title: Use Postman with the InfluxDB API
description: > description: >
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, Use [Postman](https://www.postman.com/), a popular tool for exploring APIs,
to interact with the [InfluxDB API](/influxdb/v2.0/reference/api). to interact with the [InfluxDB API](/influxdb/v2.0/api-guide/).
menu: menu:
influxdb_2_0: influxdb_2_0:
parent: Tools & integrations parent: Tools & integrations
@ -14,7 +14,7 @@ aliases:
--- ---
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, Use [Postman](https://www.postman.com/), a popular tool for exploring APIs,
to interact with the [InfluxDB API](/influxdb/v2.0/reference/api). to interact with the [InfluxDB API](/influxdb/v2.0/api-guide/).
## Install Postman ## Install Postman
@ -28,21 +28,30 @@ brew cask install postman
## Send authenticated API requests with Postman ## Send authenticated API requests with Postman
All requests to the InfluxDB API must be authenticated. All requests to the [InfluxDB v2 API](/influxdb/v2.0/api-guide/) must include an [InfluxDB API token](/influxdb/v2.0/security/tokens/).
Postman lets you configure the headers and body of HTTP requests.
Use the **Authorization** tab in Postman to include the credentials required when interacting with the InfluxDB API. {{% note %}}
#### Authenticate with a username and password
If you need to send a username and password (`Authorization: Basic`) to the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/), see how to [authenticate with a username and password scheme](/influxdb/v2.0/reference/api/influxdb-1x/#authenticate-with-the-token-scheme).
{{% /note %}}
To configure Postman to send an [InfluxDB API token](/influxdb/v2.0/security/tokens/) with the `Authorization: Token` HTTP header, do the following:
1. If you have not already, [create a token](/influxdb/v2.0/security/tokens/create-token/). 1. If you have not already, [create a token](/influxdb/v2.0/security/tokens/create-token/).
2. In the **Authorization** tab, select **API Key** in the **Type** dropdown. 2. In the Postman **Authorization** tab, select **API Key** in the **Type** dropdown.
3. For **Key**, enter `Authorization`. 3. For **Key**, enter `Authorization`.
4. For **Value**, enter `Token <token string>`, replacing `<token string>` with the token generated in step 1. 4. For **Value**, enter `Token INFLUX_API_TOKEN`, replacing *`INFLUX_API_TOKEN`* with the token generated in step 1.
5. Ensure that the **Add to** option is set to **Header**. 5. Ensure that the **Add to** option is set to **Header**.
#### Test authentication credentials #### Test authentication credentials
To test the authentication, enter the root endpoint of an InfluxDB OSS instance URL and click **Send**.
###### InfluxDB API endpoint To test the authentication, in Postman, enter your InfluxDB API `/api/v2/` root endpoint URL and click **Send**.
###### InfluxDB v2 API root endpoint
```sh ```sh
http://localhost:8086/api/v2 http://localhost:8086/api/v2
``` ```

View File

@ -21,7 +21,7 @@ Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and
[1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/).
## Create an InfluxDB connection ## Create an InfluxDB connection
1. In Choronograf, click **Configuration** in the left navigation bar, 1. In Chronograf, click **Configuration** in the left navigation bar,
and then click **{{< icon "plus" "v2" >}} Add Connection**. and then click **{{< icon "plus" "v2" >}} Add Connection**.
2. Toggle the **InfluxDB v2 Auth** option at the bottom of the form. 2. Toggle the **InfluxDB v2 Auth** option at the bottom of the form.
@ -94,4 +94,3 @@ To complete administrative tasks, use the following:
### Limited InfluxQL support ### Limited InfluxQL support
InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries. InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries.
For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support). For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support).

View File

@ -2,7 +2,7 @@
title: Use Postman with the InfluxDB API title: Use Postman with the InfluxDB API
description: > description: >
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, Use [Postman](https://www.postman.com/), a popular tool for exploring APIs,
to interact with the [InfluxDB API](/influxdb/v2.1/reference/api). to interact with the [InfluxDB API](/influxdb/v2.1/api-guide/).
menu: menu:
influxdb_2_1: influxdb_2_1:
parent: Tools & integrations parent: Tools & integrations
@ -14,7 +14,7 @@ aliases:
--- ---
Use [Postman](https://www.postman.com/), a popular tool for exploring APIs, Use [Postman](https://www.postman.com/), a popular tool for exploring APIs,
to interact with the [InfluxDB API](/influxdb/v2.1/reference/api). to interact with the [InfluxDB API](/influxdb/v2.1/api-guide/).
## Install Postman ## Install Postman
@ -28,21 +28,30 @@ brew cask install postman
## Send authenticated API requests with Postman ## Send authenticated API requests with Postman
All requests to the InfluxDB API must be authenticated. All requests to the [InfluxDB v2 API](/influxdb/v2.1/api-guide/) must include an [InfluxDB API token](/influxdb/v2.1/security/tokens/).
Postman lets you configure the headers and body of HTTP requests.
Use the **Authorization** tab in Postman to include the credentials required when interacting with the InfluxDB API. {{% note %}}
#### Authenticate with a username and password
If you need to send a username and password (`Authorization: Basic`) to the [InfluxDB 1.x compatibility API](/influxdb/v2.1/reference/api/influxdb-1x/), see how to [authenticate with a username and password scheme](/influxdb/v2.1/reference/api/influxdb-1x/#authenticate-with-the-token-scheme).
{{% /note %}}
To configure Postman to send an [InfluxDB API token](/influxdb/v2.1/security/tokens/) with the `Authorization: Token` HTTP header, do the following:
1. If you have not already, [create a token](/influxdb/v2.1/security/tokens/create-token/). 1. If you have not already, [create a token](/influxdb/v2.1/security/tokens/create-token/).
2. In the **Authorization** tab, select **API Key** in the **Type** dropdown. 2. In the Postman **Authorization** tab, select **API Key** in the **Type** dropdown.
3. For **Key**, enter `Authorization`. 3. For **Key**, enter `Authorization`.
4. For **Value**, enter `Token <token string>`, replacing `<token string>` with the token generated in step 1. 4. For **Value**, enter `Token INFLUX_API_TOKEN`, replacing *`INFLUX_API_TOKEN`* with the token generated in step 1.
5. Ensure that the **Add to** option is set to **Header**. 5. Ensure that the **Add to** option is set to **Header**.
#### Test authentication credentials #### Test authentication credentials
To test the authentication, enter the root endpoint of an InfluxDB OSS instance URL and click **Send**.
###### InfluxDB API endpoint To test the authentication, in Postman, enter your InfluxDB API `/api/v2/` root endpoint URL and click **Send**.
###### InfluxDB v2 API root endpoint
```sh ```sh
http://localhost:8086/api/v2 http://localhost:8086/api/v2
``` ```

View File

@ -31,7 +31,7 @@ The InfluxDB UI provides multiple ways to create a task:
- [Clone a task](#clone-a-task) - [Clone a task](#clone-a-task)
### Create a task from the Data Explorer ### Create a task from the Data Explorer
1. In the navigation menu on the left, select **Explore** (**Data Explorer**). 1. In the navigation menu on the left, select **Data Explorer**.
{{< nav-icon "data-explorer" >}} {{< nav-icon "data-explorer" >}}
@ -52,15 +52,14 @@ The InfluxDB UI provides multiple ways to create a task:
3. Select **New Task**. 3. Select **New Task**.
4. In the left panel, specify the task options. 4. In the left panel, specify the task options.
See [Task options](/influxdb/v2.1/process-data/task-options) for detailed information about each option. See [Task options](/influxdb/v2.1/process-data/task-options) for detailed information about each option.
5. Select a token to use from the **Token** dropdown. 5. In the right panel, enter your task script.
6. In the right panel, enter your task script.
{{% note %}} {{% note %}}
##### Leave out the option tasks assignment ##### Leave out the option tasks assignment
When creating a _new_ task in the InfluxDB Task UI, leave out the `option task` When creating a _new_ task in the InfluxDB Task UI, leave the code editor empty.
assignment that defines [task options](/influxdb/v2.1/process-data/task-options/). When you save the task, the Task UI uses the [task options](/influxdb/v2.1/process-data/task-options/) you specify in the **Task options** form to populate `option task = {task_options}` for you.
The InfluxDB UI injects this code using settings specified in the **Task options**
fields in the left panel when you save the task. When you edit the saved task, you'll see the injected `option task = {task_options}`.
{{% /note %}} {{% /note %}}
7. Click **Save** in the upper right. 7. Click **Save** in the upper right.
@ -71,20 +70,16 @@ fields in the left panel when you save the task.
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" >}}
2. Click **+ Create Task** in the upper right. 2. Click **+ Create Task** in the upper right.
3. Select **Import Task**. 3. Paste a raw Flux task in the code editor to the right of the **Task options** form.
4. Upload a JSON task file using one of the following options: 4. Click **Save** in the upper right.
- Drag and drop a JSON task file in the specified area.
- Click to upload and the area to select the JSON task from from your file manager.
- Select the **JSON** option and paste in raw task JSON.
5. Click **Import JSON as Task**.
### Create a task from a template ### Create a task from a template
1. In the navigation menu on the left, select **Settings** > **Templates**. 1. In the navigation menu on the left, select **Settings** > **Templates**.
{{< nav-icon "Settings" >}} {{< nav-icon "Settings" >}}
2. Select **Templates**. 2. Find the template you want to use and click its **Resources** list to expand the list of resources.
3. Hover over the template to use to create the task and click **Create**. 3. In the **Resources** list, click the task you want to use.
### Clone a task ### Clone a task
@ -92,11 +87,11 @@ fields in the left panel when you save the task.
{{< nav-icon "tasks" >}} {{< nav-icon "tasks" >}}
2. Hover over the task you would like to clone and click the **{{< icon "duplicate" >}}** icon that appears. 2. Find the task you would like to clone and click the **{{< icon "settings" >}}** icon located far right of the task name.
4. Click **Clone**. 4. Click **Clone**.
## Create a task using the influx CLI ## Create a task using the influx CLI
Use `influx task create` command to create a new task. Use the `influx task create` command to create a new task.
It accepts either a file path or raw Flux. It accepts either a file path or raw Flux.
###### Create a task using a file ###### Create a task using a file
@ -129,7 +124,7 @@ Provide the following in your API request:
##### Request headers ##### Request headers
- **Content-Type**: application/json - **Content-Type**: application/json
- **Authorization**: Token _YOURINFLUXDBTOKEN_** - **Authorization**: Token *`INFLUX_API_TOKEN`*
##### Request body ##### Request body
JSON object with the following fields: JSON object with the following fields:
@ -142,10 +137,10 @@ JSON object with the following fields:
```sh ```sh
curl --request POST 'https://us-west-2-1.aws.cloud2.influxdata.com/api/v2/tasks' \ curl --request POST 'https://us-west-2-1.aws.cloud2.influxdata.com/api/v2/tasks' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header 'Authorization: Token <YOURTOKEN>' \ --header 'Authorization: Token INFLUX_API_TOKEN' \
--data-raw '{ --data-raw '{
"flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\n\nfrom(bucket: \"telegraf\")\n\t|> range(start: -1h)\n\t|> filter(fn: (r) =>\n\t\t(r._measurement == \"cpu\"))\n\t|> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))\n\t|> filter(fn: (r) =>\n\t\t(r.cpu == \"cpu-total\"))\n\t|> aggregateWindow(every: 1h, fn: max)\n\t|> to(bucket: \"cpu_usage_user_total_1h\", org: \"<MYORG>\")", "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\n\nfrom(bucket: \"telegraf\")\n\t|> range(start: -1h)\n\t|> filter(fn: (r) =>\n\t\t(r._measurement == \"cpu\"))\n\t|> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))\n\t|> filter(fn: (r) =>\n\t\t(r.cpu == \"cpu-total\"))\n\t|> aggregateWindow(every: 1h, fn: max)\n\t|> to(bucket: \"cpu_usage_user_total_1h\", org: \"<MYORG>\")",
"orgID": "<YOURORGID>", "orgID": "INFLUX_ORG_ID",
"status": "active", "status": "active",
"description": "This task downsamples CPU data every hour" "description": "This task downsamples CPU data every hour"
}' }'

View File

@ -25,7 +25,7 @@ Flux is a functional data scripting language designed for querying,
analyzing, and acting on time series data. analyzing, and acting on time series data.
See [Get started with Flux](/influxdb/v2.1/query-data/get-started) to learn more about Flux. See [Get started with Flux](/influxdb/v2.1/query-data/get-started) to learn more about Flux.
1. In the navigation menu on the left, select **Explore** (**Data Explorer**). 1. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "data-explorer" >}} {{< nav-icon "data-explorer" >}}

View File

@ -54,7 +54,7 @@ If you also want to explore Cloud, we offer a way to explore data without incurr
Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/) Use the [Data Explorer](/influxdb/cloud/visualize-data/explore-metrics/)
to query and visualize data in sample data buckets. to query and visualize data in sample data buckets.
In the navigation menu on the left, click **Explore (Data Explorer)**. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "explore" >}} {{< nav-icon "explore" >}}

View File

@ -21,7 +21,7 @@ Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS {{< curren
[1.x compatibility API](/influxdb/v2.1/reference/api/influxdb-1x/). [1.x compatibility API](/influxdb/v2.1/reference/api/influxdb-1x/).
## Create an InfluxDB connection ## Create an InfluxDB connection
1. In Choronograf, click **Configuration** in the left navigation bar, 1. In Chronograf, click **Configuration** in the left navigation bar,
and then click **{{< icon "plus" >}} Add Connection**. and then click **{{< icon "plus" >}} Add Connection**.
2. Toggle the **InfluxDB v2 Auth** option at the bottom of the form. 2. Toggle the **InfluxDB v2 Auth** option at the bottom of the form.
@ -94,4 +94,3 @@ To complete administrative tasks, use the following:
### Limited InfluxQL support ### Limited InfluxQL support
InfluxDB Cloud and InfluxDB OSS {{< current-version >}} support InfluxQL **read-only** queries. InfluxDB Cloud and InfluxDB OSS {{< current-version >}} support InfluxQL **read-only** queries.
For more information, see [InfluxQL support](/influxdb/v2.1/query-data/influxql/#influxql-support). For more information, see [InfluxQL support](/influxdb/v2.1/query-data/influxql/#influxql-support).