AMampache
Catalogs

Kick off a catalog task (add/clean/verify/gather art/scan folders) for the selected catalog

Changed on

Kick off a catalog update or clean for the selected catalog

post/catalogs/{catalog_id}/action

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/catalogs/{catalog_id}/action
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Path parameters

catalog_idstring required

Unique identifier of the catalog.

Query parameters

task'add_to_catalog' | 'clean_catalog' | 'verify_catalog' | 'update_catalog' | 'gather_art' | 'garbage_collect' | 'scan_catalog_folders'

Catalog task to run

Request body

task'add_to_catalog' | 'clean_catalog' | 'verify_catalog' | 'update_catalog' | 'gather_art' | 'garbage_collect' | 'scan_catalog_folders' required

Catalog task to run

Response

Success

successstring

Changes

  • 43e9c94415e1Revision changes
    • info

      added the new enum value scan_catalog_folders to the query request parameter task

    • info

      added the new scan_catalog_folders enum value to the request property (media type: application/json)

    • info

      added the new scan_catalog_folders enum value to the request property (media type: application/x-www-form-urlencoded)

  • e8e6b266ea29Revision changes
    • info

      api operation id catalogAction was added

    • info

      added optional request body

    • info

      the query request parameter task became optional

    • info

      added the new enum value update_catalog to the query request parameter task

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status