Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
POSTPlatformSince 1.0SynchronousAuth Required

StartSync

Start a scheduled resource synchronization job for a platform.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • platformUuidStringRequired

    UUID of the platform to start syncing

    Example: plat-abc123-def456

  • syncIntervalStringRequired

    Cron-like interval expression for the sync schedule

    Example: */5 * * * *

  • resourcesListRequired

    List of resource types to include in the sync

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • schedulerIdString

    Unique identifier of the created sync scheduler

    Example: sched-xyz-001

Endpoint

POST/api/v1/platforms/sync

/api/v1/platforms/sync

Operation ID

StartSync

Permalink

Request Example

curl -X POST '{host}/api/v1/platforms/sync' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{
  "schedulerId": "sched-xyz-001"
}

Change History

This API has no change history records yet.

View all change history