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

GetCapacitySummary

Get a consolidated capacity summary across all resource types

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.

  • totalResourcesInteger

    Total number of resources across all types

    Example: 1200

  • byTypeLinkedHashMap

    Breakdown by category type

    Example: (nested object)

    • *Object

      Map value

  • overallUsageLong

    Overall platform usage ratio

    Example: 0.82

Endpoint

GET/api/v1/monitoring/capacity/summary

/api/v1/monitoring/capacity/summary

Operation ID

GetCapacitySummary

Permalink

Request Example

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

Response Example

200
{
  "totalResources": 1200,
  "byType": null,
  "overallUsage": 0.82
}

Change History

This API has no change history records yet.

View all change history