Remove Node Pairs

Removes the specified node pairs in bulk.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d guids="a1b2c3d4-e5f6-7890-abcd-ef1234567890,b2c3d4e5-f678-9012-bcde-f12345678901" \
     -X DELETE \
     https://HOSTNAME/api/sonar/node-pairs

Request Parameters

Success Response

{}

When some node pairs fail to remove

Node pairs that still have loggers registered are not removed, and failure details are included in the response body.

{
  "failures": [
    {
      "node_pair_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "reason": "logger-exist",
      "logger_names": ["syslog-collector", "windows-event"]
    }
  ]
}

• failures (Array): Node pairs that failed to remove
  • node_pair_guid (String): Node pair GUID
  • reason (String): Failure reason (logger-exist: loggers are still registered to the pair)
  • logger_names (Array): Names of loggers registered to the pair

Error Responses

Identifier is missing

HTTP status code 400

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

Permission denied

HTTP status code 500

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