Documentation

InfluxDB 3 Core

influxdb3 serve

The influxdb3 serve command starts the InfluxDB 3 Core server.

Usage

influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>

Required parameters

  • node-id: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
  • object-store: Determines where time series data is stored.
  • Other object store parameters depending on the selected object-store type.

--node-id supports alphanumeric strings with optional hyphens.

Options

OptionDescription
*--node-idSee configuration options
--object-storeSee configuration options
--admin-token-recovery-http-bindSee configuration options
--admin-token-recovery-tcp-listener-file-pathSee configuration options
--admin-token-fileSee configuration options
--aws-access-key-idSee configuration options
--aws-allow-httpSee configuration options
--aws-credentials-fileSee configuration options
--aws-default-regionSee configuration options
--aws-endpointSee configuration options
--aws-secret-access-keySee configuration options
--aws-session-tokenSee configuration options
--aws-skip-signatureSee configuration options
--azure-allow-httpSee configuration options
--azure-endpointSee configuration options
--azure-storage-access-keySee configuration options
--azure-storage-accountSee configuration options
--bucketSee configuration options
--data-dirSee configuration options
--datafusion-configSee configuration options
--datafusion-max-parquet-fanoutSee configuration options
--datafusion-num-threadsSee configuration options
--datafusion-runtime-disable-lifo-slotSee configuration options
--datafusion-runtime-event-intervalSee configuration options
--datafusion-runtime-global-queue-intervalSee configuration options
--datafusion-runtime-max-blocking-threadsSee configuration options
--datafusion-runtime-max-io-events-per-tickSee configuration options
--datafusion-runtime-thread-keep-aliveSee configuration options
--datafusion-runtime-thread-prioritySee configuration options
--datafusion-runtime-typeSee configuration options
--datafusion-use-cached-parquet-loaderSee configuration options
--delete-grace-periodSee configuration options
--disable-authzSee configuration options
--disable-parquet-mem-cacheSee configuration options
--distinct-cache-eviction-intervalSee configuration options
--exec-mem-pool-bytesSee configuration options
--force-snapshot-mem-thresholdSee configuration options
--gen1-durationSee configuration options
--gen1-lookback-durationSee configuration options
--google-service-accountSee configuration options
--hard-delete-default-durationSee configuration options
-h--helpPrint help information
--help-allPrint detailed help information
--http-bindSee configuration options
--last-cache-eviction-intervalSee configuration options
--log-destinationSee configuration options
--log-filterSee configuration options
--log-formatSee configuration options
--max-http-request-sizeSee configuration options
--object-store-cache-endpointSee configuration options
--object-store-connection-limitSee configuration options
--object-store-http2-max-frame-sizeSee configuration options
--object-store-http2-onlySee configuration options
--object-store-max-retriesSee configuration options
--object-store-retry-timeoutSee configuration options
--package-managerSee configuration options
--parquet-mem-cache-prune-intervalSee configuration options
--parquet-mem-cache-prune-percentageSee configuration options
--parquet-mem-cache-query-path-durationSee configuration options
--parquet-mem-cache-sizeSee configuration options
--plugin-dirSee configuration options
--preemptive-cache-ageSee configuration options
--query-file-limitSee configuration options
--query-log-sizeSee configuration options
--retention-check-intervalSee configuration options
--snapshotted-wal-files-to-keepSee configuration options
--table-index-cache-concurrency-limitSee configuration options
--table-index-cache-max-entriesSee configuration options
--tcp-listener-file-pathSee configuration options
--telemetry-disable-uploadSee configuration options
--telemetry-endpointSee configuration options
--tls-certSee configuration options
--tls-keySee configuration options
--tls-minimum-versionSee configuration options
--traces-exporterSee configuration options
--traces-exporter-jaeger-agent-hostSee configuration options
--traces-exporter-jaeger-agent-portSee configuration options
--traces-exporter-jaeger-service-nameSee configuration options
--traces-exporter-jaeger-trace-context-header-nameSee configuration options
--traces-jaeger-debug-nameSee configuration options
--traces-jaeger-max-msgs-per-secondSee configuration options
--traces-jaeger-tagsSee configuration options
-v--verboseEnable verbose output
--virtual-env-locationSee configuration options
--wal-flush-intervalSee configuration options
--wal-max-write-buffer-sizeSee configuration options
--wal-replay-concurrency-limitSee configuration options
--wal-replay-fail-on-errorSee configuration options
--wal-snapshot-sizeSee configuration options
--without-authSee configuration options
* Required options

Option environment variables

You can use environment variables to define most influxdb3 serve options. For more information, see Configuration options.

Examples

In the examples below, replace my-host-01: with a unique string that identifies your InfluxDB 3 Core server.

Run the InfluxDB 3 server

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01

Run the InfluxDB 3 server with extra verbose logging

influxdb3 serve \
  --verbose \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01

Run InfluxDB 3 with debug logging using LOG_FILTER

LOG_FILTER=debug influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01

Troubleshooting

Common Issues

  • Error: “Failed to connect to object store”
    Verify your --object-store setting and ensure all required parameters for that storage type are provided.

  • Permission errors when using S3, Google Cloud, or Azure storage
    Check that your authentication credentials are correct and have sufficient permissions.

Was this page helpful?

Thank you for your feedback!

© 2025 InfluxData, Inc.

What is your InfluxDB 3 Core URL?

Customize your InfluxDB 3 Core URL and we’ll update code examples for you.

Default
Custom

For more information, see InfluxDB Cloud regions or InfluxDB OSS URLs.

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.4

Key enhancements in InfluxDB 3.4 and the InfluxDB 3 Explorer 1.2.

See the Blog Post

InfluxDB 3.4 is now available for both Core and Enterprise, which introduces offline token generation for use in automated deployments and configurable license type selection that lets you bypass the interactive license prompt. InfluxDB 3 Explorer 1.2 is also available, which includes InfluxDB cache management and other new features.

For more information, check out: