Sign in
Collection Lifecycle

Transition Lifecycle

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

Path parameters

collection_identifierstring required

Collection ID or name

Collection ID or name

Request body

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

If False, block until the transition completes

Response

Successful Response

collection_idstring required
lifecycle_state'active' | 'cold' | 'archived' 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

Changed in 1 of the 29 revisions of this API.1