Get node pairs

Retrieves the list of node pairs registered in the cluster.

HTTP Request

GET /api/sonar/node-pairs
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/node-pairs
Request Parameters
KeyRequiredTypeDescriptionNote
include_nodesNoBooleanInclude node detailsIncludes node list when set to true
offsetNo32-bit integerNumber of records to skip
limitNo32-bit integerMaximum number of records
keywordsNoStringSearch keyword

Success Response

{
  "total_count": 1,
  "node_pairs": [
    {
      "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "control",
      "name": "main-pair",
      "description": "",
      "is_local": true,
      "is_alive": true,
      "vip_host": "192.0.2.10",
      "vip_port": 8443,
      "active": {
        "nid": "node-1",
        "host": "192.0.2.11",
        "port": 8443,
        "is_alive": true
      },
      "standby": {
        "nid": "node-2",
        "host": "192.0.2.12",
        "port": 8443,
        "is_alive": false
      }
    }
  ]
}