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

GetOverviewV2

Retrieve v2 platform overview with split warning and critical alert 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.

  • totalPlatformsInteger

    Total number of registered platforms

    Example: 8

  • onlinePlatformsInteger

    Number of currently online platforms

    Example: 7

  • alertCountWarningInteger

    Number of active warning-level alerts

    Example: 5

  • alertCountCriticalInteger

    Number of active critical-level alerts

    Example: 2

  • activeSilencesInteger

    Number of currently active alert silences

    Example: 1

Endpoint

GET/api/v1/monitoring/overview-v2

/api/v1/monitoring/overview-v2

Operation ID

GetOverviewV2

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/overview-v2' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "totalPlatforms": 8,
  "onlinePlatforms": 7,
  "alertCountWarning": 5,
  "alertCountCritical": 2,
  "activeSilences": 1
}

Change History

This API has no change history records yet.

View all change history