Skip to main content
ZStack
Monitoring & Collection/Scrape Collection

InstantHealthCheck

Run an on-demand health check against a set of scrape targets

POST/api/v1/monitoring/scrape-health/check

Operation ID

InstantHealthCheck

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • targetIds
    ListRequired

    Target ids

    Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • targetId
      String

      UUID of the target that was health-checked

      Example: target-001-abc

    • status
      String

      Health check status (up, down, timeout)

      Example: up

    • latencyMs
      String

      Round-trip latency of the health check in milliseconds

      Example: 28

    • error
      String

      Error message if the health check failed

      Example: connection refused

    • checkedAt
      String

      Checked at

      Example: 2026-01-15T08:00:00Z