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

UpdateSync

Update the interval or resource list for an existing sync scheduler.

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 update

Body Fields

  • platformUuidStringRequired

    UUID of the associated platform

    Example: plat-abc123-def456

  • syncIntervalStringRequired

    New sync interval expression

    Example: */10 * * * *

  • resourcesListRequired

    Updated list of resource types to sync

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Confirmation message for the sync update

    Example: Sync configuration updated successfully

Endpoint

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

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

Operation ID

UpdateSync

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history