Skip to content

settingLocks

Settings module · 4 operations

List setting lock rows

GET/setting-locks

A lock that stops lower scopes from overriding a setting. Returns a cursor page of setting lock rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a setting lock

POST/setting-locks

A lock that stops lower scopes from overriding a setting. Creates a setting lock. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a setting lock

GET/setting-locks/{id}

A lock that stops lower scopes from overriding a setting. Returns one setting lock with its `ETag`. A setting lock the caller may not see returns 404.

Delete a setting lock

DELETE/setting-locks/{id}

A lock that stops lower scopes from overriding a setting. Soft-deletes the setting lock: it moves to Trash and can be restored for its table's retention period.