Bucket Objects

Bulk Soft-Delete Objects

Changed on

Soft-delete many objects by ID in one call. Records are retained and flipped to a non-active lifecycle state (so retrieval excludes them), with the lifecycle propagated to downstream documents. There is no self-service restore endpoint: clearing the marker is a support action, so treat this as a one-way call. Bucket stats are recomputed once. Designed for large purges (e.g. scoping a synced bucket to a subset) without the per-object webhook/stats storms of single delete.

post/v1/buckets/{bucket_identifier}/objects/bulk-soft-delete

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/bulk-soft-delete
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

Request body

object_idsstring[] required

Object IDs to soft-delete (max 5000 per request). Records are retained and flipped to a non-active lifecycle state so retrieval excludes them. There is no self-service restore endpoint: clearing the marker is a support action.

reasonstring required

Why these objects are being soft-deleted (audit trail).

lifecycle_statestring

Lifecycle state to flip to (default 'disabled').

sourcestring

Marker source tag (default 'bulk_purge').

Example request

{
  "object_ids": [
    "obj_abc123",
    "obj_def456"
  ],
  "reason": "scope footage bucket to 8 target brands"
}

Response

Successful Response

soft_deletedinteger required

Number of object records flipped.

requestedinteger required

Number of object IDs requested.

collectionsinteger required

Collections sourced from the bucket considered for propagation.

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API