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 GraphQL endpoint, as well as access an interactive GraphQL playground for development.

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 GraphQL API is enabled for this Vector instance.
default: false

api.graphql

common optional bool
Whether the endpoint for receiving and processing GraphQL queries is enabled for the API. The endpoint is accessible via the /graphql endpoint of the address set using the bind parameter.
default: true

api.playground

optional bool
Whether the GraphQL Playground is enabled for the API. The Playground is accessible via the /playground endpoint of the address set using the bind parameter. Note that the playground endpoint will only be enabled if the graphql endpoint is also enabled.
default: true
Sidebar