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

TriggerSyncNow

TriggerSyncNow triggers an immediate one-shot resource sync for a platform. Returns ALREADY_EXISTS if a sync cycle is already in progress. Returns NOT_FOUND if the platform or its scheduler does not exist. Immediately trigger a one-shot resource sync outside of the scheduled interval.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • platformUuidStringRequired

    platform_uuid is the platform to trigger an immediate sync for.

Responses

200 OK

On success, this API returns the following response structure.

  • taskIdString

    task_id is the unique identifier for this sync task.

    Example: task-sync-00123

  • platformUuidString

    platform_uuid echoes back the target platform.

    Example: plat-abc123-def456

  • statusString

    status is the initial task status (e.g. "queued").

    Example: queued

Endpoint

POST/api/v1/platforms/{platformUuid}/sync-now

/api/v1/platforms/{platformUuid}/sync-now

Operation ID

TriggerSyncNow

Permalink

Request Example

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

Response Example

200
{
  "taskId": "task-sync-00123",
  "platformUuid": "plat-abc123-def456",
  "status": "queued"
}

Change History

This API has no change history records yet.

View all change history