Remove node pairs
Deletes the specified node pairs.
Required Permissions
Requires the ADMIN role or higher.
HTTP Request
DELETE /api/sonar/node-pairs
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
-X DELETE "https://HOSTNAME/api/sonar/node-pairs?guids=a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Request Parameters
| Key | Required | Type | Description | Note |
|---|---|---|---|---|
| guids | Yes | String | Node pair GUID list | Comma-separated (,) |
Success Response
{}
Error Responses
guids is missing
HTTP status code 400
{
"error_code": "null-argument",
"error_msg": "guids should be not null"
}
Some node pairs failed to be deleted
HTTP status code 200
The failures array returns the reason for each failed node pair and the loggers involved.
{
"failures": [
{
"reason": "node pair is in use",
"node_pair_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"loggers": ["syslog-01", "dirwatch-02"]
}
]
}
- failures (Array of objects): Node pairs that failed to be deleted
- reason (String): Reason for the deletion failure
- node_pair_guid (String): GUID of the node pair that failed to be deleted
- loggers (List of strings): Names of the loggers still assigned to the node pair. Not returned when no logger remains
Permission denied
HTTP status code 401
{
"error_code": "no-permission",
"error_msg": "no-permission"
}