Update flock settings

PATCH

/api/v1/flocks/{identifier}/settings

• Production
• Development

Update fields in the flock_settings document using JSON Patch operations. By default operates in dry-run mode to preview changes.

Authorizations

• ApiKeyAuth
• SessionCookie

Parameters

Path Parameters

identifier

required

string

Example

myflock

Flock identifier (bucket name)

Request Body ^required

object

operations

Array<object>

object

op

string

Allowed values: add replace remove

path

string

value

Value for add/replace operations

dry_run

boolean

default: true

Responses

200

Update result

object

data

object

dry_run

boolean

applied

boolean

changes

Array<object>

object

op

string

path

string

before

Value before change

after

Value after change

400

Bad request - invalid input

object

error

object

code

Error code

string

Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR

message

Human-readable error message

string

401

Unauthorized - missing or invalid credentials

object

error

object

code

Error code

string

Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR

message

Human-readable error message

string

404

Resource not found

object

error

object

code

Error code

string

Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR

message

Human-readable error message

string