Open app
Moonborn — API · config

Lock or unlock a config item at a scope (prevents lower-scope overrides)

PATCH/v1/config/{key}/lockscope · Bearer (API key or session JWT)
Path parameters
FieldTypeDescription
keyreqstring
Query parameters
FieldTypeDescription
scope_levelstring
scope_idstring
Request body
FieldTypeDescription
lockedreqboolean
reasonstring

Responses

200Lock state updated
Body
FieldTypeDescription
eventreqobject
401Unauthenticated
Body
FieldTypeDescription
typereqstring
titlereqstring
statusreqnumber
detailstring
codestring
403Forbidden (insufficient scope)
Body
FieldTypeDescription
typereqstring
titlereqstring
statusreqnumber
detailstring
codestring
404Config item not found
Body
FieldTypeDescription
typereqstring
titlereqstring
statusreqnumber
detailstring
codestring

Examples

cURL
curl -X PATCH https://api.moonborn.co/v1/config/<key>/lock \
  -H "Authorization: Bearer $MOONBORN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "locked": false
    }'
TypeScript
import Moonborn from '@moonborn/sdk';

const client = new Moonborn({ apiKey: process.env.MOONBORN_API_KEY });

const result = await client.config.lockConfigItem({
  key: '<key>',
  locked: false,
});
Python
import os
from moonborn import Moonborn

client = Moonborn(api_key=os.environ["MOONBORN_API_KEY"])

result = client.config.lock_config_item(
    key="<key>",
    locked=False,
)