Skip to main content
POST
Bulk Soft-Delete Objects

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_identifier
string
required

The unique identifier of the bucket.

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

Request model for bulk soft-deleting objects by id.

Records are retained and flipped to a non-active lifecycle state. There is no self-service restore endpoint; clearing the marker is a support action.

object_ids
string[]
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.

Required array length: 1 - 5000 elements
reason
string
required

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

Maximum string length: 500
lifecycle_state
string
default:disabled

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

source
string
default:bulk_purge

Marker source tag (default 'bulk_purge').

Response

Successful Response

Response for a bulk soft-delete operation.

soft_deleted
integer
required

Number of object records flipped.

requested
integer
required

Number of object IDs requested.

collections
integer
required

Collections sourced from the bucket considered for propagation.