Set Global Config

Stores or updates the value of the specified global config key. For the list of available keys, see Get Global Configs.

Required Permissions

Requires the Master role.

HTTP Request

PUT /api/sonar/global-configs/:key
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
     -d value="smtp.example.com" \
     -X PUT \
     https://HOSTNAME/api/sonar/global-configs/smtp_host
Request Parameters
Path Parameters
KeyTypeDescriptionNotes
keyStringGlobal config keyCase-insensitive.
Request Body Parameters
KeyRequiredTypeDescriptionNotes
valueYesStringGlobal config value

Success Response

{}

Error Responses

Unsupported key

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "invalid option name: foo"
}
Permission denied

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}