PATCH/api/admin/settings/{key}Admin

Update a server setting

Sets the value of one server setting. The value is validated against the setting's own schema (boolean, string, ...).

operationId patch_api_admin_settings_keyAdministration

Authentication & permissionsAdmin

Platform administrators only

Accepted credentials
Who may call
Platform administrators only

Path parameters

NameTypeDescription
key*string

Request body

Required

application/json
UpdateServerSettingRequest
PropertyTypeDescription
valueany

New value; validated against the setting's own schema

descriptionstring
JSONExample
"value"null
"description""string"

Responses

application/json
PropertyTypeDescription
success*true
data*object
key*string
valueany
JSONExample
"success"true
"data"
"key""string"
"value"null

Example request

bashcurl
curl -X PATCH 'https://auth.schemavaults.com/api/admin/settings/<key>' \
  -b 'refresh_token_<auth_server_app_id>=<value>' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": null,
  "description": "string"
}'