Skip to main content
ZStack
Platform Operations/Platforms

PauseSync

Pause an existing sync scheduler without deleting its interval or resource configuration. Paused sync configs remain paused after service restart until ResumeSync is called.

POST/api/v1/platforms/sync/{uuid}/pause

Operation ID

PauseSync

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 pause

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • message
    String

    Confirmation message for the sync pause

    Example: Sync configuration paused successfully