Skip to main content
ZStack
Platform Operations/Platforms

UpdateSync

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

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

Operation ID

UpdateSync

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

application/json

Path Parameters

  • uuid
    StringRequired

    UUID of the sync configuration to update

Body Fields

  • platformUuid
    StringRequired

    UUID of the associated platform

    Example: plat-abc123-def456

  • syncInterval
    StringRequired

    New sync interval expression

    Example: */10 * * * *

  • resources
    ListRequired

    Updated list of resource types to sync

    Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • message
    String

    Confirmation message for the sync update

    Example: Sync configuration updated successfully