Skip to main content
PATCH
Update a Branch's Index Schema

Authorizations

x-api-key
string
header
required

Project API Key.

Path Parameters

collectionName
string
required

Collection name.

branchName
string
required
Required string length: 3 - 52
Pattern: ^[a-zA-Z0-9_-]{3,52}$

Body

application/json

A branch owns its indexConfigs only. Description, tags and snapshot retention stay on the collection route.

indexConfigs
IndexConfigs · object
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; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {"type":"keyword"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.

Response

Updated branch with its index schema.

branch
BranchDetails · object
required