Vector

Vector Health API

Health check endpoints for load balancers and Kubernetes probes.

GitHub OpenAPI

Operations 2

GET /health Vector Get Health Status #
HEAD /health Vector Head Health Check #

Documentation

📖
Documentation
https://vector.dev/docs/reference/api/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/vector/openapi/vector-health-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/vector/json-schema/vector-observability-api-health-response-schema.json
📊
JSONStructure
https://artifacts.apis.io/vector/json-structure/vector-observability-api-health-response-structure.json

Other Resources

🔗
Examples
https://artifacts.apis.io/vector/examples/vector-observability-api-health-response-example.json
🔗
JSONLD
https://artifacts.apis.io/vector/json-ld/vector-observability-api-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vector:vector-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vector-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vector Observability Health API
  description: Vector is a high-performance observability data pipeline for collecting, transforming, and routing logs, metrics, and traces.
  version: 0.55.0
  contact:
    name: Vector Community
    url: https://vector.dev/community/
  license:
    name: MPL-2.0
    url: https://github.com/vectordotdev/vector/blob/master/LICENSE
  x-generated-from: documentation
servers:
- url: http://127.0.0.1:8686
  description: Local Vector Instance (default API address)
tags:
- name: Health
  description: Health check endpoints for load balancers and Kubernetes probes.
paths:
  /health:
    get:
      operationId: getHealth
      summary: Vector Get Health Status
      description: 'Returns the health status of the running Vector instance. Returns HTTP 200 with {"ok": true} when Vector is running normally. Returns HTTP 200 with {"ok": false} when Vector is shutting down. Used by load balancers and Kubernetes liveness/readiness probes.'
      tags:
      - Health
      security: []
      responses:
        '200':
          description: Vector health status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                getHealth200Example:
                  summary: Default getHealth 200 response
                  x-microcks-default: true
                  value:
                    ok: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    head:
      operationId: headHealth
      summary: Vector Head Health Check
      description: Same semantics as GET /health but returns no response body. Used for lightweight health probes where the response body is not needed.
      tags:
      - Health
      security: []
      responses:
        '200':
          description: Vector is healthy
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: Whether Vector is running normally. True when operational, false during shutdown.
          example: true
externalDocs:
  description: Vector API Reference
  url: https://vector.dev/docs/reference/api/