Skip to main content
ZStack
Platform Operations/Platforms

ListSyncs

List all active sync scheduler configurations across platforms.

GET/api/v1/platforms/syncs

Operation ID

ListSyncs

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of sync configurations

    Example: (nested array)

    • platformUuid
      String

      UUID of the platform this sync configuration belongs to

      Example: plat-abc123-def456

    • interval
      String

      Sync interval expression (cron format)

      Example: */5 * * * *

    • resources
      LinkedHashMap

      Associated resource list

      Example: (nested object)

    • state
      String

      Current sync configuration state: active, paused, or not_configured

      Example: active

    • paused
      Boolean

      Whether the sync configuration is paused

      Example: false

  • total
    Integer

    Total number of sync configurations

    Example: 5

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped

    Example: 20