InfluxDB

https://docs.influxdata.com/influxdb/v2/
Admin
InfluxDB is an open-source time-series database designed for storing, querying, and visualizing...
Tokens:1,684,237
Snippets:14,828
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### influx setup usage

Source: https://docs.influxdata.com/influxdb/v2/reference/cli/influx/setup

Shows the basic command syntax for the `influx setup` command. Use this to start the interactive setup process.

```bash
influx setup [flags]
```

--------------------------------

### Run the example browser app

Source: https://docs.influxdata.com/influxdb/v2/api-guide/client-libraries/browserjs/index.md

Starts the example browser app at http://localhost:3001/examples/index.html. The index.html loads the env_browser.js configuration, the client library ESM modules, and the application.

```bash
npm run browser
```

--------------------------------

### influx setup output

Source: https://docs.influxdata.com/influxdb/v2/get-started/setup

Example output from the influx setup command, showing the created user, organization, and bucket. After setup, InfluxDB stores these values in a default connection configuration.

```text
User        Organization         Bucket
USERNAME    ORGANIZATION_NAME    BUCKET_NAME
```

--------------------------------

### Start a local cluster with minikube

Source: https://docs.influxdata.com/influxdb/v2/install/index.md

Use this command to start a local Kubernetes cluster with minikube. This is the first step in the installation workflow.

```bash
# with minikube
minikube start
```

--------------------------------

### POST /api/v2/setup - Onboard initial user, org, and bucket

Source: https://docs.influxdata.com/influxdb/v2/api/setup/index.md

Posts an onboarding request to set up the initial user, organization, and bucket. The request body requires bucket, org, and username; password, token, and retention periods are optional. The server generates a token if not specified.

```sh
curl --request POST \
  "http://localhost:8086/api/v2/setup" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "bucket": "BUCKET",
  "org": "ORG",
  "password": "PASSWORD",
  "retentionPeriodHrs": 0,
  "retentionPeriodSeconds": 0,
  "token": "TOKEN",
  "username": "USERNAME"
}'
```

--------------------------------

### POST /api/v2/setup

Source: https://docs.influxdata.com/influxdb/v2/api/all-endpoints

Sets up initial user, org and bucket.

```APIDOC
## POST /api/v2/setup

### Description
Sets up initial user, org and bucket.

### Method
POST

### Endpoint
/api/v2/setup
```

--------------------------------

### Group data by _field column

Source: https://docs.influxdata.com/influxdb/v2/get-started/process/index.md

Queries the 'temp' and 'hum' fields and groups by only the '_field' column. This example uses the data written in 'Get started writing to InfluxDB' and demonstrates how grouping by '_field' puts all rows with the same field into one table, ignoring '_measurement' and 'room' columns.

```js
from(bucket: "get-started")
    |> range(start: 2022-01-01T08:00:00Z, stop: 2022-01-01T10:00:01Z)
    |> filter(fn: (r) => r._measurement == "home")
    |> filter(fn: (r) => r._field == "temp" or r._field == "hum")
    |> group(columns: ["_field"])
```

--------------------------------

### Start InfluxDB service

Source: https://docs.influxdata.com/influxdb/v2/install/index.md

Starts the InfluxDB service. Installing the package creates a service file at /lib/systemd/system/influxdb.service to start InfluxDB as a background service on startup.

```bash
sudo service influxdb start
```

--------------------------------

### GET /ready

Source: https://docs.influxdata.com/influxdb/v2/api/all-endpoints/index.md

Gets the readiness of an instance at startup.

```APIDOC
## GET /ready

### Description
Gets the readiness of an instance at startup.

### Method
GET

### Endpoint
/ready

```

--------------------------------

### InfluxDB HTTP API - Quick start

Source: https://docs.influxdata.com/influxdb/v2/tools/postman

Provides a quick start guide for the InfluxDB HTTP API.

```APIDOC
## InfluxDB HTTP API - Quick start

### Description
Provides a quick start guide for the InfluxDB HTTP API.

### Endpoint
Not specified.

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response example provided.
```

--------------------------------

### Navigate to examples directory

Source: https://docs.influxdata.com/influxdb/v2/api-guide/client-libraries/browserjs/index.md

Navigates to the examples directory of the cloned influxdb-client-js repository.

```bash
cd examples
```

--------------------------------

### Start InfluxDB daemon on Windows PowerShell

Source: https://docs.influxdata.com/influxdb/v2/install/index.md

Navigate to the InfluxDB installation directory and start the influxd daemon in PowerShell.

```powershell
cd -Path 'C:\Program Files\InfluxData\influxdb'
./influxd
```

--------------------------------

### GET /api/v2/stacks

Source: https://docs.influxdata.com/influxdb/v2/api/all-endpoints

Lists installed stacks.

```APIDOC
## GET /api/v2/stacks

### Description
Lists installed stacks.

### Method
GET

### Endpoint
/api/v2/stacks
```

--------------------------------

### SHOW DATABASES example

Source: https://docs.influxdata.com/influxdb/v2/reference/syntax/influxql/spec/index.md

Example query that shows all databases.

```sql
-- show all databases
SHOW DATABASES
```

--------------------------------

### Start development server

Source: https://docs.influxdata.com/influxdb/v2/api-guide/tutorials/nodejs

Navigates into the iot-api-js directory and starts the Next.js development server on port 3001.

```bash
cd iot-api-js
yarn dev -p 3001

```

--------------------------------

### Navigate to project and start dev server

Source: https://docs.influxdata.com/influxdb/v2/api-guide/tutorials/nodejs/index.md

Changes into the project directory and starts the development server on port 3001.

```bash
cd iot-api-js
yarn dev -p 3001
```

--------------------------------

### Start latest InfluxDB

Source: https://docs.influxdata.com/influxdb/v2/install/upgrade/v2-beta-to-v2

Starts the latest InfluxDB version. After moving data, the data folder is empty and a setup page is available at http://localhost:8086.

```bash
influxd
```

--------------------------------

### Complete Go write script

Source: https://docs.influxdata.com/influxdb/v2/api-guide/client-libraries/go/index.md

Complete example write script that combines all the boilerplate steps: defines variables, creates the client, writes a point, and closes the client.

```go
func main() {
    bucket := "example-bucket"
    org := "example-org"
    token := "example-token"
    // Store the URL of your InfluxDB instance
    url := "http://localhost:8086"
    // Create new client with default option for server url authenticate by token
    client := influxdb2.NewClient(url, token)
    // User blocking write client for writes to desired bucket
    writeAPI := client.WriteAPIBlocking(org, bucket)
    // Create point using full params constructor
    p := influxdb2.NewPoint("stat",
        map[string]string{"unit": "temperature"},
        map[string]interface{}{"avg": 24.5, "max": 45},
        time.Now())
    // Write point immediately
    writeAPI.WritePoint(context.Background(), p)
    // Ensures background processes finishes
    client.Close()
}
```

--------------------------------

### Create a bucket with influx CLI

Source: https://docs.influxdata.com/influxdb/v2/get-started/setup

Use the influx CLI to create a bucket named get-started. Requires the influx CLI to be installed and configured with connection and authentication credentials.

```bash
influx bucket create --name get-started
```

--------------------------------

### GET /tasks API endpoint

Source: https://docs.influxdata.com/influxdb/v2/process-data/manage-tasks/view-tasks/index.md

Use the `/tasks` InfluxDB API endpoint to return a list of tasks. The example shows a GET request to `http://localhost:8086/api/v2/tasks`.

```http
GET http://localhost:8086/api/v2/tasks
```

--------------------------------

### Define example data variable

Source: https://docs.influxdata.com/influxdb/v2/query-data/flux/index.md

Defines a `data` variable representing a basic query that filters data by measurement and field. Used in many examples in the guides.

```flux
data = from(bucket: "example-bucket")
|> range(start: -1h)
|> filter(fn: (r) => r._measurement == "example-measurement" and r._field == "example-field")
```

--------------------------------

### POST /api/v2/setup

Source: https://docs.influxdata.com/influxdb/v2/api/setup

Set up the initial user, organization, and bucket for a new InfluxDB instance.

```APIDOC
## POST /api/v2/setup

### Description
Post an onboarding request to set up the initial user, organization, and bucket for the InfluxDB instance.

### Method
POST

### Endpoint
/api/v2/setup

### Parameters
#### Header Parameters
- **Zap-Trace-Span** (string) - Optional - OpenTracing span context.

#### Request Body (required)
Content-Type: `application/json`
- **bucket** (string) - Required - The name of the initial bucket.
- **org** (string) - Required - The name of the initial organization.
- **password** (string) - Optional - The password for the initial user.
- **retentionPeriodHrs** (integer) - Optional - Retention period in nanoseconds for the new bucket. This key’s name has been misleading since OSS 2.0 GA, please transition to use `retentionPeriodSeconds`.
- **retentionPeriodSeconds** (integer <int64>) - Optional - Retention period in seconds for the new bucket.
- **token** (string) - Optional - Authentication token to set on the initial user. If not specified, the server will generate a token.
- **username** (string) - Required - The username for the initial user.

### Request Example
```
curl --request POST \
  "http://localhost:8086/api/v2/setup" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "bucket": "BUCKET",
  "org": "ORG",
  "password": "PASSWORD",
  "retentionPeriodHrs": 0,
  "retentionPeriodSeconds": 0,
  "token": "TOKEN",
  "username": "USERNAME"
}'
```

### Response
#### Success Response (201 Created)
- **auth** (object) - The authorization object created.
  - **createdAt** (string <date-time>) - The creation timestamp.
  - **description** (string) - A description of the token.
  - **id** (string) - The authorization ID.
  - **links** (object) - Example: `{"self":"/api/v2/authorizations/1","user":"/api/v2/users/12"}`
    - **self** (string <uri>) - URI of resource.
    - **user** (string <uri>) - URI of resource.
  - **org** (string) - The organization name. Specifies the organization that the token is scoped to.
  - **orgID** (string) - Required - The organization ID. Specifies the organization that the authorization is scoped to.
  - **permissions** (object[]) - Required - The list of permissions. An authorization must have at least one permission.
    - **action** (string) - Required - Allowed: `read`, `write`.
    - **resource** (object) - Required - The resource the permission applies to.
  - **status** (string) - Status of the token. If `inactive`, InfluxDB rejects requests that use the token. Allowed: `active`, `inactive`. Default: `active`.
  - **token** (string) - The API token. The token value is unique to the authorization. API tokens are used to authenticate and authorize InfluxDB API requests and `influx` CLI commands.
  - **updatedAt** (string <date-time>) - The last update timestamp.
  - **user** (string) - The user name. Specifies the user that owns the authorization.
  - **userID** (string) - The user ID. Specifies the user that owns the authorization.
- **bucket** (string) - The name of the created bucket.
- **org** (string) - The name of the created organization.
- **user** (string) - The name of the created user.

#### Error Response (Non 2XX)
- **code** (string) - Required - Machine-readable error code. Allowed: `internal error`, `not implemented`, `not found`, `conflict`, `invalid`, `unprocessable entity`, `empty value`, `unavailable`, `forbidden`, `too many requests`, `unauthorized`, `method not allowed`, `request too large`, `unsupported media type`.
- **err** (string) - Stack of errors that occurred during processing of the request. Useful for debugging.
- **message** (string) - Human-readable message.
- **op** (string) - Describes the logical code operation when the error occurred. Useful for debugging.
```

--------------------------------

### docker run influxdb:2 with initial setup options

Source: https://docs.influxdata.com/influxdb/v2/install/index.md

Starts an InfluxDB 2 container with initial setup environment variables and persistent volumes. Replace ADMIN_USERNAME, ADMIN_PASSWORD, ORG_NAME, and BUCKET_NAME with your own values. If successful, InfluxDB starts initialized with the user, organization, bucket, and Operator token, and logs to stdout.

```bash
docker run \
 --name influxdb2 \
 --publish 8086:8086 \
 --mount type=volume,source=influxdb2-data,target=/var/lib/influxdb2 \
 --mount type=volume,source=influxdb2-config,target=/etc/influxdb2 \
 --env DOCKER_INFLUXDB_INIT_MODE=setup \
 --env DOCKER_INFLUXDB_INIT_USERNAME=ADMIN_USERNAME \
 --env DOCKER_INFLUXDB_INIT_PASSWORD=ADMIN_PASSWORD \
 --env DOCKER_INFLUXDB_INIT_ORG=ORG_NAME \
 --env DOCKER_INFLUXDB_INIT_BUCKET=BUCKET_NAME \
 influxdb:2
```

--------------------------------

### GET /api/v2/setup - Check setup status

Source: https://docs.influxdata.com/influxdb/v2/api/setup/index.md

Checks whether the InfluxDB instance has completed initial setup. Returns true if no default user, organization, or bucket has been created.

```sh
curl --request GET \
  "http://localhost:8086/api/v2/setup" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

--------------------------------

### influx server-config examples

Source: https://docs.influxdata.com/influxdb/v2/reference/cli/influx/server-config/index.md

Shows how to display the server configuration and output it as YAML.

```sh
# Show the server configuration.
influx server-config

# Show the server configuration as YAML.
influx server-config --yaml
```

--------------------------------

### influx setup

Source: https://docs.influxdata.com/influxdb/v2/reference/config-options

Sets up InfluxDB for initial use.

```APIDOC
## influx setup

### Description
Sets up InfluxDB for initial use.

### Command
`influx setup`

### Usage
Use this command to initialize InfluxDB.
```

--------------------------------

### List installed stacks with curl

Source: https://docs.influxdata.com/influxdb/v2/api/templates/index.md

Sends a GET request to the /api/v2/stacks endpoint to list installed stacks for an organization. Requires an orgID query parameter and an Authorization header with a Bearer token.

```sh
curl --request GET \
  "http://localhost:8086/api/v2/stacks?orgID=ORGID" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

--------------------------------

### List configurations after setup

Source: https://docs.influxdata.com/influxdb/v2/install/upgrade/v2-beta-to-v2/index.md

Shows the two configuration profiles after setup: default for the new instance and influx_old for the old instance.

```sh
$ influx config ls
Active  Name        URL                    Org
        default     http://localhost:8086  InfluxData
*       influx_old  http://localhost:9999  InfluxData
```

--------------------------------

### Run the complete example

Source: https://docs.influxdata.com/influxdb/v2/api-guide/client-libraries/nodejs/query/index.md

Set InfluxDB environment variables and execute the JavaScript file with node.

```sh
export INFLUX_URL=http://localhost:8086 && \
export INFLUX_TOKEN=YOUR_API_TOKEN && \
export INFLUX_ORG=YOUR_ORG && \
node query.js
```

--------------------------------

### Start local Kubernetes cluster with minikube or kind

Source: https://docs.influxdata.com/influxdb/v2/install?t=Windows

Starts a local Kubernetes cluster using either minikube or kind. These are alternative commands; choose one based on your installed tool.

```bash
# with minikube
minikube start
```

```bash
# with kind
kind create cluster
```
Tokens:
Raw