Skip to main content
ZStack
Platform Operations/Platforms

DeleteSync

Delete a sync scheduler configuration for the specified platform. This clears the saved interval and resource configuration; use PauseSync to temporarily stop syncing while preserving configuration. The operation is idempotent after owner coordination when the sync job is already absent. It returns 404 if the platform does not exist, 429 when another Federation replica owns the scheduler, and 503 for a real lease, session, or runtime cleanup failure. DeleteSyncRequest.options is deprecated and scheduled for removal in v1.3.0; callers must omit it.

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

Operation ID

DeleteSync

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 delete

Query Parameters

  • options.propagationPolicy
    String

    PropagationPolicy overrides the resource's default policy when non-empty. Accepted values: Restrict, Foreground, Background, Orphan, SoftDelete.

  • options.force
    Boolean

    Force skips the Finalizer phase and advances directly to PhysicalDelete. Requires operator-level permission; returns PermissionDenied until the audit-integration rollout lands.

    Example: true

  • options.gracePeriodSeconds
    Integer

    GracePeriodSeconds defines the post-request delay before the engine begins the Checking phase. Default 0 (immediate).

    Example: 0

  • options.revokeRemoteCredentials
    Boolean

    RevokeRemoteCredentials is a resource-scoped hint for resources that carry out-of-band credentials (e.g. Platform access keys). When true, the corresponding revoke finalizer is activated for this request. Ignored by resources that do not register such a finalizer.

    Example: true

Responses

200 OK

DELETE endpoints return an empty object on success, or a standard error structure on failure.

Success Response

{}

Error Response

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Delete resource timeout after 300s"
  }
}