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

GetCapacityForecast

Get a capacity forecast including predicted counts and exhaustion date for a resource type

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • resourceTypeStringRequired

    Resource type to generate a forecast for

Responses

200 OK

On success, this API returns the following response structure.

  • resourceTypeString

    Resource type being forecasted

    Example: vm

  • currentCountInteger

    Current total resource count

    Example: 500

  • predictedCount30dInteger

    Predicted resource count in 30 days

    Example: 525

  • predictedCount90dInteger

    Predicted resource count in 90 days

    Example: 580

  • growthRateLong

    Monthly growth rate as a decimal fraction

    Example: 0.05

  • exhaustionDateString

    Estimated date when capacity will be exhausted (ISO 8601)

    Example: 2025-09-15

Endpoint

GET/api/v1/monitoring/capacity/forecast/{resourceType}

/api/v1/monitoring/capacity/forecast/{resourceType}

Operation ID

GetCapacityForecast

Permalink

Request Example

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

Response Example

200
{
  "resourceType": "vm",
  "currentCount": 500,
  "predictedCount30d": 525,
  "predictedCount90d": 580,
  "growthRate": 0.05,
  "exhaustionDate": "2025-09-15"
}

Change History

This API has no change history records yet.

View all change history