Sign in
Catalogs

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

Kick off a catalog update or clean for the selected catalog

post/catalogs/{catalog_id}/action

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'

Catalog task to run

Request body

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

Catalog task to run

Response

Success

successstring

Changes

Changed in 7 of the 46 revisions of this API.514

  • e8e6b266ea296See the full diff
    • ○

      api operation id catalogAction was added

      api-operation-id-added

    • ○

      added optional request body

      request-body-added-optional

    • ○

      the query request parameter task became optional

      request-parameter-became-optional

    • ○

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

      request-parameter-enum-value-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      removed the non-success response with the status 410

      response-non-success-status-removed

  • 9abb9bf6d3bf35See the full diff
    • ▲

      removed the enum value garbage_collect from the query request parameter task

      request-parameter-enum-value-removed

    • ▲

      removed the enum value gather_art from the query request parameter task

      request-parameter-enum-value-removed

    • ▲

      removed the enum value verify_catalog from the query request parameter task

      request-parameter-enum-value-removed

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 410

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aaf4166bdf3a1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 21e41c5adb1c1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • 7ed7a764efd91See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

  • 3c57979a295f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 07f53972fdd71See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation