Sign in
import-export

Cancel Import Job

Changed on

Request cooperative cancellation of a pending or running import.

post/api/v1/import/{job_id}/cancel

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

job_idstring uuid required

Cookies

access_tokenstring nullable

Response

Cancellation requested; job is now cancelled

idstring required

Job ID (UUID)

status'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' required

Status for import/export jobs.

progressinteger required

Progress percentage 0-100

total_itemsinteger required

Total number of items to process

processed_itemsinteger required

Number of items processed so far

created_atstring date-time required

When job was created (UTC)

completed_atstring date-time nullable

When job completed or failed (UTC)

result_dataobject nullable

Result statistics (JSON)

errorsstring[] nullable

Error messages (JSON array)

warningsstring[] nullable

Warning messages (JSON array)

source_type'journiv' | 'markdown' | 'dayone' | 'immich' | 'daylio' required

Source types for imports.

Changes