Vector · JSON Structure

Vector Observability Api Health Response Structure

HealthResponse schema from Vector Observability API

Type: object Properties: 1
Data PipelineLogsMetricsObservabilityOpen SourceRustTraces

HealthResponse is a JSON Structure definition published by Vector, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ok

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vector/refs/heads/main/json-structure/vector-observability-api-health-response-structure.json",
  "description": "HealthResponse schema from Vector Observability API",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether Vector is running normally. True when operational, false during shutdown.",
      "example": true
    }
  },
  "name": "HealthResponse"
}