Skip to main content
PATCH
/
v1
/
collections
/
{collection_identifier}
/
lifecycle
Transition Lifecycle
curl --request PATCH \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/lifecycle \
  --header 'Content-Type: application/json' \
  --data '
{
  "async_transition": true
}
'
{
  "collection_id": "<string>",
  "s3_vector_index": "<string>",
  "vector_document_count": 123,
  "s3_vector_count": 123,
  "last_transitioned_at": "2023-11-07T05:31:56Z",
  "task_id": "<string>",
  "warning": "<string>"
}

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
collection_identifier
string
required

Collection ID or name

Body

application/json
​
lifecycle_state
enum<string>
required

Target lifecycle state for the collection

Available options:
active,
cold,
archived
​
async_transition
boolean
default:true

If False, block until the transition completes

Response

Successful Response

​
collection_id
string
required
​
lifecycle_state
enum<string>
required
Available options:
active,
cold,
archived
​
s3_vector_index
string | null
​
vector_document_count
integer | null
​
s3_vector_count
integer | null
​
last_transitioned_at
string<date-time> | null
​
task_id
string | null
​
warning
string | null