Collection Lifecycle

Transition Lifecycle

Changed on

Transition a collection's storage tier. 'cold' evicts from the vector store (vectors searchable via object storage). 'active' rehydrates back to the vector store. 'archived' permanently removes vectors.

patch/v1/collections/{collection_identifier}/lifecycle

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections/{collection_identifier}/lifecycle
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

collection_identifierstring required

Collection ID or name

Request body

lifecycle_state'active' | 'cold' | 'archived' | 'frozen' required
async_transitionboolean

If False, block until the transition completes. Ignored for frozen, which moves no data and always completes within the request.

Response

Successful Response

collection_idstring required
lifecycle_state'active' | 'cold' | 'archived' | 'frozen' required
s3_vector_indexstring nullable
vector_document_countinteger nullable
s3_vector_countinteger nullable
last_transitioned_atstring date-time nullable
task_idstring nullable
warningstring nullable

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

  • 8d925c1cf55fRevision changes
    • info

      added the optional property to the response with the status