API configuration reference

This page documents the configuration for Vector’s observability API.

The API enables you to query Vector’s topology, metrics, and health information through a gRPC endpoint.

For other top-level configuration options, see:

  • Global Options - Global settings like data directories and timezone
  • Pipeline Components - Configure sources, transforms, sinks, and enrichment tables
  • Schema - Configure Vector's internal schema system
  • Secrets - Configure secrets management

api

optional object
API options.

Warning

The API currently does not support authentication. Only enable it in isolated environments or for debugging. It must not be exposed to untrusted clients.

api.address

common optional string
The network address to which the API should bind. If you’re running Vector in a Docker container, bind to 0.0.0.0. Otherwise the API will not be exposed outside the container.
Examples 
"0.0.0.0:8686"
"127.0.0.1:1234"
default: 127.0.0.1:8686

api.enabled

common optional bool
Whether the API is enabled for this Vector instance.
default: false
Sidebar