Skip to main content
POST
Cancel a metadata import run

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collection_id
string<uuid>
required

The ID of the metadata collection

import_id
string<uuid>
required

The ID of the metadata import

run_id
string<uuid>
required

The ID of the import run

Response

The run in its post-cancel state

One execution of a metadata import.

object
enum<string>
Available options:
metadata_import_run
id
string<uuid>
import_id
string<uuid>
mode
enum<string>

append imports new files and retries previously-failed ones; refresh re-imports everything the filters match

Available options:
append,
refresh
delete_missing
boolean

Whether this run sweeps files this import previously brought in that the source no longer returns (refresh runs only)

status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
progress
object

Best-effort progress counters for display. Run completion is decided from the actual per-file indexing state, never from these counters, so they can drift slightly under retries without affecting correctness.

error
string | null

User-facing failure reason when status is failed

started_at
number | null

Unix timestamp in milliseconds

completed_at
number | null

Unix timestamp in milliseconds

created_at
number

Unix timestamp in milliseconds

max_files
integer | null

The cap this run executed with; null means unbounded

include_thumbnails
boolean

Whether this run copied poster thumbnails