Skip to main content
ZStack
Platform Operations/Platforms

GetSyncStatus

Get the current sync configuration and resource map for a platform.

GET/api/v1/platforms/sync/{uuid}

Operation ID

GetSyncStatus

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 sync configuration to retrieve

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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