Skip to main content
ZStack
Platform Operations/Platforms

GetSyncOverview

Get a per-resource-type overview of synced counts for a platform.

GET/api/v1/platforms/syncs/{uuid}/overview

Operation ID

GetSyncOverview

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

  • uuid
    StringRequired

    UUID of the platform to get the sync overview for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • platformUuid
    String

    UUID of the platform this overview belongs to

    Example: plat-abc123-def456

  • platformName
    String

    Human-readable name of the platform

    Example: prod-zstack-01

  • productType
    String

    Product type of the platform

    Example: zstack

  • platformIp
    String

    IP address of the platform

    Example: 192.168.1.100

  • totalResources
    String

    Total number of resources synced across all types

    Example: 512

  • lastSyncTime
    String

    Last sync time

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

  • jobState
    String

    Current state of the sync job (running, idle, error)

    Example: idle

  • details
    List

    Per-resource-type breakdown of synced counts

    Example: (nested array)

    • resourceType
      String

      Type of resource being tracked

      Example: vm

    • syncedCount
      String

      Number of resources synced for this resource type

      Example: 128