Sign in
Queues

Retrieve a queue

Changed on

Retrieves a specific queue by its name.

get/queues/{name}

Request

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

Response

isPausedboolean required

Whether the queue is paused

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

Queue name

Changes

  • 68ffb4f3c8deRevision changes
    • warning

      added the new integrityCheck enum value to the response property for the response status

    • info

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