The Vector API
Vector ships with a GraphQL API that allows you to interact with a running Vector instance. This page covers how to configure and enable Vector’s API.
Configuration
address
common optional string literal0.0.0.0
. Otherwise
the API will not be exposed outside the container.127.0.0.1:8686
enabled
common optional boolfalse
graphql
common optional bool/graphql
endpoint of the address set using the bind
parameter.true
playground
optional bool/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.true
Endpoints
POST /graphql
Responses
errors
key to determine if
there were any errors in your query.GET /health
Responses
GET /playground
Responses
How it works
GraphQL
Vector chose GraphQL for its API because GraphQL is self-documenting and type safe. We believe that this offers a superior client experience and makes Vector richly programmable through its API.
Playground
Vector’s GraphQL API ships with a built-in playground that allows you to explore the available commands and manually run queries against the API. This can be accessed at the /playground
path.