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

ListCapacitySnapshots

List stored capacity snapshots with optional filtering by resource type and tenant

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • resourceTypeString

    Filter snapshots by resource type Filter snapshots by resource type

  • tenantIdString

    Filter snapshots by tenant ID Filter snapshots by tenant ID

  • limitInteger

    Maximum number of snapshots to return Maximum number of snapshots to return

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the snapshot record

      Example: snap-001-abc

    • resourceTypeString

      Resource type this snapshot covers (e.g. vm, host, storage)

      Example: vm

    • totalCountInteger

      Total number of resources at the time of snapshot

      Example: 500

    • activeCountInteger

      Number of actively running resources at the time of snapshot

      Example: 480

    • usagePercentLong

      Usage percentage at the time of snapshot

      Example: 96

    • timestampString

      Timestamp for this resource

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

    • tenantIdString

      Tenant this snapshot is scoped to

      Example: tenant-001-xyz

  • totalInteger

    Total number of matching snapshots

    Example: 100

  • limitInteger

    Page size limit

    Example: 20

  • offsetInteger

    Pagination offset

    Example: 20

Endpoint

GET/api/v1/monitoring/capacity/snapshots

/api/v1/monitoring/capacity/snapshots

Operation ID

ListCapacitySnapshots

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 100,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history