Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Scrape Collection
GETMonitoringSince 1.0SynchronousAuth Required

GetScrapeHealthSummary

Get a summary of scrape health across all targets (up, down, unknown, maintenance counts)

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.

  • totalTargetsInteger

    Total number of registered scrape targets

    Example: 20

  • upInteger

    Number of targets currently in an up (healthy) state

    Example: 17

  • downInteger

    Number of targets currently in a down (unhealthy) state

    Example: 2

  • unknownInteger

    Number of targets with an unknown health state

    Example: 20

  • maintenanceInteger

    Number of targets currently under maintenance

    Example: 1

  • lastUpdatedString

    Last updated

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

Endpoint

GET/api/v1/monitoring/scrape-health/summary

/api/v1/monitoring/scrape-health/summary

Operation ID

GetScrapeHealthSummary

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/scrape-health/summary' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "totalTargets": 20,
  "up": 17,
  "down": 2,
  "unknown": 20,
  "maintenance": 1,
  "lastUpdated": "example"
}

Change History

This API has no change history records yet.

View all change history