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

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.

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the sync configuration to delete

Query Parameters

  • options.propagationPolicyString

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

  • options.forceBoolean

    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.gracePeriodSecondsInteger

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

    Example: 0

  • options.revokeRemoteCredentialsBoolean

    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

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"
  }
}

Endpoint

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

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

Operation ID

DeleteSync

Permalink

Request Example

curl -X DELETE '{host}/api/v1/platforms/sync/{uuid}' -H 'Authorization: Bearer {token}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history