Documentation

influx v1 dbrp list

The influx v1 dbrp list command lists and searches DBRP mappings in the InfluxDB 1.x compatibility API.

Usage

influx v1 dbrp list [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c--active-configConfig name to use for commandstringINFLUX_ACTIVE_CONFIG
--bucket-idBucket ID
--configs-pathPath to the influx CLI configurations (default: ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
--dbFilter DBRP mappings by database
--defaultLimit results to default mapping
-h--helpHelp for the list command
--hide-headersHide the table headers (default: false)INFLUX_HIDE_HEADERS
--hostHTTP address of InfluxDBstringINFLUX_HOST
--idLimit results to a specified mappingstring
--jsonOutput data as JSON (default: false)INFLUX_OUTPUT_JSON
-o--orgOrganization name (mutually exclusive with --org-id)stringINFLUX_ORG
--org-idOrganization ID (mutually exclusive with --org)stringINFLUX_ORG_ID
--rpFilter DBRP mappings by InfluxDB v1 retention policystringINFLUX_ORG
--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 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 all DBRP mappings in your organization
influx v1 dbrp list
List DBRP mappings for specific buckets
influx v1 dbrp list \
  --bucket-id 12ab34cd56ef78 \
  --bucket-id 09zy87xw65vu43
List DBRP mappings with a specific database
influx v1 dbrp list --db example-db
List DBRP mappings with a specific retention policy
influx v1 dbrp list --rp example-rp

Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.