Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

GetCapacityForecast

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

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

Operation ID

GetCapacityForecast

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

Path Parameters

  • resourceType
    StringRequired

    Resource type to generate a forecast for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • resourceType
    String

    Resource type being forecasted

    Example: vm

  • currentCount
    Integer

    Current total resource count

    Example: 500

  • predictedCount30d
    Integer

    Predicted resource count in 30 days

    Example: 525

  • predictedCount90d
    Integer

    Predicted resource count in 90 days

    Example: 580

  • growthRate
    Long

    Monthly growth rate as a decimal fraction

    Example: 0.05

  • exhaustionDate
    String

    Estimated date when capacity will be exhausted (ISO 8601)

    Example: 2025-09-15