libraries

Move a library to trash

Changed on

Moves the library and all its contents into the trash. The library becomes inaccessible by default and can be fully restored within 90 days by calling restore_library. After 90 days the library's assets are gradually purged in the background; until the library row itself is removed, restore still works but recovers only the assets not yet purged.

Idempotent — a second call on an already-trashed library no-ops. To trash individual assets without trashing the whole library, use trash_assets instead.

Returns 409 if this is the user's last live library — every user keeps at least one. Retrying does not clear it; create another library first.

post/api/libraries/{library_id}/trash

Request

  • Base URL: https://api.gumnut.ai
  • URL: https://api.gumnut.ai/api/libraries/{library_id}/trash
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

library_idstring required

Library ID (with lib_ prefix) of the library to trash.

Response

Successful Response

DeletionResponse required

Empty acknowledgment returned when an operation succeeds.

Changes

  • 7c2860d9eb88Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 815e0302a988Revision changes
    • breaking

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

    • info

      the response property became required for the status