Queues

Retrieve queue jobs

Changed on

Retrieves a list of queue jobs from the specified queue.

get/queues/{name}/jobs

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/queues/{name}/jobs
  • 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

Query parameters

statusQueueJobStatus[]

Filter jobs by status

Response

dataobject required

Job data payload

idstring

Job ID

name'AssetDelete' | 'AssetDeleteCheck' | 'AssetDetectFacesQueueAll' | 'AssetDetectFaces' | 'AssetDetectDuplicatesQueueAll' | 'AssetDetectDuplicates' | 'AssetEditThumbnailGeneration' | 'AssetEncodeVideoQueueAll' | 'AssetEncodeVideo' | 'AssetEmptyTrash' | 'AssetExtractMetadataQueueAll' | 'AssetExtractMetadata' | 'AssetFileMigration' | 'AssetGenerateThumbnailsQueueAll' | 'AssetGenerateThumbnails' | 'AuditTableCleanup' | 'DatabaseBackup' | 'FacialRecognitionQueueAll' | 'FacialRecognition' | 'FileDelete' | 'FileMigrationQueueAll' | 'LibraryDeleteCheck' | 'LibraryDelete' | 'LibraryRemoveAsset' | 'LibraryScanAssetsQueueAll' | 'LibrarySyncAssets' | 'LibrarySyncFilesQueueAll' | 'LibrarySyncFiles' | 'LibraryScanQueueAll' | 'HlsSessionCleanup' | 'MemoryCleanup' | 'MemoryGenerate' | 'NotificationsCleanup' | 'NotifyUserSignup' | 'NotifyAlbumInvite' | 'NotifyAlbumUpdate' | 'UserDelete' | 'UserDeleteCheck' | 'UserSyncUsage' | 'PersonCleanup' | 'PersonFileMigration' | 'PersonGenerateThumbnail' | 'SessionCleanup' | 'SendMail' | 'SidecarQueueAll' | 'SidecarCheck' | 'SidecarWrite' | 'SmartSearchQueueAll' | 'SmartSearch' | 'StorageTemplateMigration' | 'StorageTemplateMigrationSingle' | 'TagCleanup' | 'VersionCheck' | 'OcrQueueAll' | 'Ocr' | 'WorkflowAssetTrigger' | 'IntegrityUntrackedFilesQueueAll' | 'IntegrityUntrackedFiles' | 'IntegrityUntrackedRefresh' | 'IntegrityMissingFilesQueueAll' | 'IntegrityMissingFiles' | 'IntegrityMissingFilesRefresh' | 'IntegrityChecksumFiles' | 'IntegrityChecksumFilesRefresh' | 'IntegrityDeleteReportType' | 'IntegrityDeleteReports' required

Job name

timestampinteger required

Job creation timestamp

Changes

  • 68ffb4f3c8deRevision changes
    • warning

      added the new IntegrityChecksumFiles enum value to the / response property for the response status

    • warning

      added the new IntegrityChecksumFilesRefresh enum value to the / response property for the response status

    • warning

      added the new IntegrityDeleteReportType enum value to the / response property for the response status

    • warning

      added the new IntegrityDeleteReports enum value to the / response property for the response status

    • warning

      added the new IntegrityMissingFiles enum value to the / response property for the response status

    • warning

      added the new IntegrityMissingFilesQueueAll enum value to the / response property for the response status

    • warning

      added the new IntegrityMissingFilesRefresh enum value to the / response property for the response status

    • warning

      added the new IntegrityUntrackedFiles enum value to the / response property for the response status

    • warning

      added the new IntegrityUntrackedFilesQueueAll enum value to the / response property for the response status

    • warning

      added the new IntegrityUntrackedRefresh enum value to the / response property for the response status

    • info

      added the new enum value integrityCheck to the path request parameter name

  • 75567be711deRevision changes
    • warning

      added the new HlsSessionCleanup enum value to the / response property for the response status