Sign in
Jobs

Create a manual job

Changed on

Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.

post/jobs

Request

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

Request body

name'person-cleanup' | 'tag-cleanup' | 'user-cleanup' | 'memory-cleanup' | 'memory-create' | 'backup-database' | 'integrity-missing-files' | 'integrity-untracked-files' | 'integrity-checksum-mismatch' | 'integrity-missing-files-refresh' | 'integrity-untracked-files-refresh' | 'integrity-checksum-mismatch-refresh' | 'integrity-missing-files-delete-all' | 'integrity-untracked-files-delete-all' | 'integrity-checksum-mismatch-delete-all' required

Manual job name

Changes

  • 68ffb4f3c8deRevision changes
    • info

      added the new integrity-checksum-mismatch enum value to the request property

    • info

      added the new integrity-checksum-mismatch-delete-all enum value to the request property

    • info

      added the new integrity-checksum-mismatch-refresh enum value to the request property

    • info

      added the new integrity-missing-files enum value to the request property

    • info

      added the new integrity-missing-files-delete-all enum value to the request property

    • info

      added the new integrity-missing-files-refresh enum value to the request property

    • info

      added the new integrity-untracked-files enum value to the request property

    • info

      added the new integrity-untracked-files-delete-all enum value to the request property

    • info

      added the new integrity-untracked-files-refresh enum value to the request property