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

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.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the sync configuration to pause

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Confirmation message for the sync pause

    Example: Sync configuration paused successfully

Endpoint

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

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

Operation ID

PauseSync

Permalink

Request Example

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

Response Example

200
{
  "message": "Sync configuration paused successfully"
}

Change History

This API has no change history records yet.

View all change history