Create a setting lock

Settings module

POST/setting-lockssettingLocks.create

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.

Requires the capability org.security.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: SettingLockCreate

settingLocks.create: SettingLockCreate
Field	Type	Required	Description
setting_key	string	Yes	Setting key.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "setting_key": "security.mfa_required"
}

Response 201: SettingLock

settingLocks.create: SettingLock
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the setting lock.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
setting_key	string	Yes	Setting key.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "setting_key": "security.mfa_required"
}

Code samples

curl -X POST "$XOS_BASE_URL/setting-locks" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"setting_key":"security.mfa_required"}'

const { data } = await xos.settingLocks.create({
    "setting_key": "security.mfa_required"
  });

response = xos.setting_locks.create({"setting_key": "security.mfa_required"})

xos setting-locks create --data '{"setting_key":"security.mfa_required"}'