Unset Global Config

Removes the value of the specified global config key. The unset key reverts to the system default. For the list of available keys, see Get Global Configs.

Required Permissions

Requires the Master role.

HTTP Request

DELETE /api/sonar/global-configs/:key
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
     -X DELETE \
     https://HOSTNAME/api/sonar/global-configs/smtp_host
Request Parameters
Path Parameters
KeyTypeDescriptionNotes
keyStringGlobal config keyCase-insensitive.

Success Response

{}

Error Responses

Permission denied

HTTP status code 500

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