Skip to main content
ZStack
Platform Operations/Platforms

StartSync

Start a scheduled resource synchronization job for a platform.

POST/api/v1/platforms/sync

Operation ID

StartSync

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

application/json

Body Fields

  • platformUuid
    StringRequired

    UUID of the platform to start syncing

    Example: plat-abc123-def456

  • syncInterval
    StringRequired

    Cron-like interval expression for the sync schedule

    Example: */5 * * * *

  • resources
    ListRequired

    List of resource types to include in the sync

    Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • schedulerId
    String

    Unique identifier of the created sync scheduler

    Example: sched-xyz-001