ha-groups

Manage high availability groups and floating IPs.
get /servers/ha-groups

List of all configured HA groups.

Parameters
pagination string query
Responses
200 successful operation
HaGroupResponse array
HaGroupResponse object 
[
  {
    "id": 0,
    "servers": [
      {
        "nic": 0,
        "vlan": 0,
        "server": 0,
        "serverHostname": "string"
      }
    ],
    "service": "nfs",
    "failback": true,
    "virtualIp": "string",
    "description": "string",
    "failbackTime": 0,
    "failoverTime": 0,
    "serviceLabel": "string",
    "serversFormatted": "string",
    "evictNfsClientsOnFailback": true
  }
]
post /servers/ha-groups
Parameters
body object 
{
  "id": 0,
  "servers": [
    {
      "nic": 0,
      "vlan": 0,
      "server": 0
    }
  ],
  "service": "nfs",
  "failback": true,
  "virtualIp": "string",
  "description": "string",
  "failbackTime": 0,
  "failoverTime": 0,
  "evictNfsClientsOnFailback": true
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
put /servers/ha-groups/{id}
Parameters
id integer path Required
body object 
{
  "id": 0,
  "servers": [
    {
      "nic": 0,
      "vlan": 0,
      "server": 0
    }
  ],
  "service": "nfs",
  "failback": true,
  "virtualIp": "string",
  "description": "string",
  "failbackTime": 0,
  "failoverTime": 0,
  "evictNfsClientsOnFailback": true
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
delete /servers/ha-groups/{id}
Parameters
id integer path Required
Responses
default successful operation