Remove Address Objects

Removes address objects from a specified address group. Requests for non-existent IP addresses are ignored.

HTTP Request

DELETE /api/sonar/address-groups/:guid/addresses
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -X DELETE \
     "https://HOSTNAME/api/sonar/address-groups/4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2/addresses?addresses=1.1.1.1"
Request Parameters
KeyRequiredTypeDescriptionNote
guidOStringAddress group GUID36 characters
addressesOStringIP address listComma-separated list

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "addresses should be not null"
}
Identifier is not in valid GUID format

HTTP status code 400

{
    "error_code": "invalid-param-type",
    "error_msg": "guid should be guid type."
}
Invalid IP address

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "addresses should contain only valid IP addresses. input is 256.255.255.255"
}
Address group is not found

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "address group not found: ede06992-dd57-4b79-8c54-a295f33d8613"
}
No privileges to delete an address group

HTTP status code 500

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