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

ListCapacitySnapshots

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

GET/api/v1/monitoring/capacity/snapshots

Operation ID

ListCapacitySnapshots

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

Query Parameters

  • resourceType
    String

    Filter snapshots by resource type Filter snapshots by resource type

  • tenantId
    String

    Filter snapshots by tenant ID Filter snapshots by tenant ID

  • limit
    Integer

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

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • id
      String

      Unique identifier of the snapshot record

      Example: snap-001-abc

    • resourceType
      String

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

      Example: vm

    • totalCount
      Integer

      Total number of resources at the time of snapshot

      Example: 500

    • activeCount
      Integer

      Number of actively running resources at the time of snapshot

      Example: 480

    • usagePercent
      Long

      Usage percentage at the time of snapshot

      Example: 96

    • timestamp
      String

      Timestamp for this resource

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

    • tenantId
      String

      Tenant this snapshot is scoped to

      Example: tenant-001-xyz

  • total
    Integer

    Total number of matching snapshots

    Example: 100

  • limit
    Integer

    Page size limit

    Example: 20

  • offset
    Integer

    Pagination offset

    Example: 20