Deactivate a collection

Deactivate (soft delete) an existing collection.

This operation performs a soft deletion by marking the collection as inactive. The collection data remains in the database but is no longer accessible through the API.

Parameter:

• {collectionId} (path parameter): The unique identifier of the collection to deactivate.

What happens when you deactivate a collection:

1. Collection Deactivation: The collection is soft-deleted (marked as inactive)
2. API Visibility: The collection will no longer appear in collection list queries (GET /public/v1/collections) or be accessible via GET /public/v1/collections/{collectionId}
3. Target Relationships: Target-collection relationships remain in the database, but since the collection is inactive, targets linked to this collection become inaccessible through the API. The targets themselves are not deleted.
4. Cleanup: Collection filters and tree filters associated with the collection are removed
5. User Default Collection: If this collection was set as the user's default collection, it will be cleared
6. Audit Trail: The deactivation is recorded in the audit log with:
   • The user who deactivated the collection
   • Timestamp of the operation
   • Collection details (name, scope, type, ID)
   • Reference to the public API endpoint used
   • Audit comment: "Collection deleted via Public API"

Important Notes:

• This is a soft delete - the collection is marked as inactive but data remains in the database
• Deactivated collections are filtered out from all API queries automatically
• Only the creator of the collection can deactivate it - even if you have DELETE permission through a role, you must be the collection creator
• Target-collection relationships remain in the database, but targets become inaccessible through the API since the collection is inactive
• The targets themselves are not deleted - only the collection becomes inactive
• The collection cannot be reactivated through this API (no reactivation endpoint is available)
• All collection operations are audited for compliance and tracking purposes

Required Permissions:

• MANAGE_COLLECTION permission
• DELETE permission on the collection
• You must be the creator of the collection (collection.userId must match your user ID)