Create Address Group

Creates a new address group.

HTTP Request

POST /api/sonar/address-groups
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -d name=Exceptions \
     -X POST \
     https://HOSTNAME/api/sonar/address-groups
Request Parameters
KeyRequiredTypeDescriptionNote
nameOStringAddress group nameMinimum 1 to maximum 50 characters
guidXStringAddress group GUID36 characters. The default value is randomly generated.
company_guidXStringCompany GUID36 characters. Default is the GUID of the company in the current session.
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": "company_guid should be guid type."
}
Company does not exist

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "company not found: 1245cbbc-681c-4c52-a01b-f4b496d95d50"
}