Skip to main content
PATCH

Authorizations

x-api-key
string
header
required

Project API Key.

Path Parameters

collectionName
string
required

Collection name.

Body

application/json

Provide at least one non-null supported field. Omitted or null fields are unchanged. Supplied tags replace the entire metadata map; {} clears tags. An empty description clears it. indexConfigs must preserve the complete existing schema. New fields may be added at any object depth while retaining existing fields and their settings.

indexConfigs
IndexConfigs · object | null
required

Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected.

description
string | null
Maximum string length: 255
tags
object | null

Replaces the entire collection metadata map; {} clears it. Up to five entries.

snapshotRetentionInDays
integer | null

Number of days to retain committed snapshots.

Required range: 1 <= x <= 31

Response

Updated collection

collection
CollectionResponse · object
required