Skip to main content
API Explorer|API Explorer
SLO & Service Quality/SLO
GETSLOSince 1.0SynchronousAuth Required

GetVMQueryHealth

Get the health status and latency metrics for the VictoriaMetrics query backend.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • vmAvailableBoolean

    Whether the VictoriaMetrics backend is reachable and responding.

    Example: true

  • avgQueryLatencyMsLong

    Average query latency in milliseconds over recent queries.

    Example: 45.2

  • p99LatencyMsLong

    99th percentile query latency in milliseconds.

    Example: 210

  • slowQueriesLast1hInteger

    Number of queries that exceeded the timeout threshold in the last hour.

    Example: 3

  • circuitBreakerStateString

    Current circuit breaker state: closed | open | half-open.

    Example: closed

Endpoint

GET/api/v1/slo/query-health

/api/v1/slo/query-health

Operation ID

GetVMQueryHealth

Permalink

Request Example

curl -X GET '{host}/api/v1/slo/query-health' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "vmAvailable": true,
  "avgQueryLatencyMs": 45.2,
  "p99LatencyMs": 210.0,
  "slowQueriesLast1h": 3,
  "circuitBreakerState": "closed"
}

Change History

This API has no change history records yet.

View all change history