influx task list
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.
The influx task list
command lists and searches for tasks in InfluxDB.
Usage
influx task list [flags]
Command aliases
list
, ls
, find
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-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 | |
—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 | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
-n | —user-id | Task owner ID | string |
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST
, INFLUX_ORG
, and INFLUX_TOKEN
). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host
: InfluxDB host-o, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token- List a specific task
- Limit the number of tasks returned to 20
- List all tasks created by a specific user
List all tasks
influx task list
List a specific task
influx task list --id 0Xx0oox00XXoxxoo1
Limit the number of tasks returned to 20
influx task list --limit 20
List all tasks created by a specific user
influx task list --user-id 0Xx0oox00XXoxxoo1
Related
- Process data with InfluxDB tasks
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions