Discard a sync preview

DELETE

/sync/preview/{previewId}

const url = 'https://example.com/api/v1/sync/preview/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/sync/preview/example

Removes a stored preview snapshot.

This endpoint does not trigger any Arr sync action; it only removes the cached preview and does not change runtime configuration.

Parameters

Path Parameters

previewId

required

string

Preview snapshot ID

Responses

204

Preview discarded

404

Preview not found or expired

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}

500

Failed to delete preview

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}