Update Address Group

Updates a specified address group.

HTTP Request

PUT /api/sonar/address-groups/:guid
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -d name=Exceptions \
     -d description="Service assets" \
     -X PUT \
     https://HOSTNAME/api/sonar/address-groups/4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2
Request Parameters
KeyRequiredTypeDescriptionNote
guidOStringAddress group GUID36 characters. The default is randomly generated.
nameOStringAddress group nameMinimum 1 to maximum 50 characters
descriptionXStringAddress group descriptionMaximum 2,000 characters

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "name should be not null"
}
Invalid argument length

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "'name' must be shorter than or equal to 50 characters."
}
Identifier is not in valid GUID format

HTTP status code 400

{
    "error_code": "invalid-param-type",
    "error_msg": "guid should be guid type."
}
Address group is not found

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "address group not found: 81e7ff9e-457e-4f65-8f8e-bb9b3a0021c8"
}
No privileges to update an address group

HTTP status code 500

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