influx bucket list

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+
  • Updated in CLI v2.2.0

The influx bucket list command lists and searches for buckets in InfluxDB.

Usage

  1. influx bucket list [flags]

Command aliases

list, ls, find

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-h—helpHelp for the list command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB servers.string
-i—idBucket IDstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—limitTotal number of buckets to fetch from the server, or 0 to return all bucketsstring
-n—nameBucket namestringINFLUX_BUCKET_NAME
—offsetNumber of buckets to skip over in the listINFLUX_ORG
-o—orgOrganization name (mutually exclusive with —org-id)stringINFLUX_ORG
—org-idOrganization ID (mutually exclusive with —org)stringINFLUX_ORG_ID
—page-sizeNumber of buckets to fetch per request to the server (default 20)
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

List all buckets
  1. influx bucket list
List a bucket by name
  1. influx bucket list --name example-bucket
List a bucket by ID
  1. influx bucket list --id 06c86c40a9f36000