Sign in
Jobs
Deprecated

Run jobs

Changed on

Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.

put/jobs/{name}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/jobs/{name}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Path parameters

name'thumbnailGeneration' | 'metadataExtraction' | 'videoConversion' | 'faceDetection' | 'facialRecognition' | 'smartSearch' | 'duplicateDetection' | 'backgroundTask' | 'storageTemplateMigration' | 'migration' | 'search' | 'sidecar' | 'library' | 'notifications' | 'backupDatabase' | 'ocr' | 'workflow' | 'integrityCheck' | 'editor' required

Queue name

Request body

command'start' | 'pause' | 'resume' | 'empty' | 'clear-failed' required

Queue command to execute

forceboolean

Force the command execution (if applicable)

Response

Changes