Endpoint

/v1/cluster/nodes/

GET

List nodes.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_node",
    "type": "object",
    "properties": {
      "id": {
        "description": "id",
        "type": "number"
      },
      "node_status": {
        "description": "Status of the node",
        "type": "string"
      },
      "node_name": {
        "description": "User friendly node name",
        "type": "string"
      },
      "uuid": {
        "description": "Unique node identifier",
        "type": "string"
      },
      "label": {
        "description": "Physically identifiable label assigned to the hardware",
        "type": "string"
      },
      "model_number": {
        "description": "Node model number",
        "type": "string"
      },
      "serial_number": {
        "description": "Serial number",
        "type": "string"
      },
      "mac_address": {
        "description": "MAC address for the first network interface on this node",
        "type": "string"
      }
    }
  }
}

POST

Add one or more unconfigured nodes with the given node uuids and admin password. This endpoint is deprecated in favor of /v2/cluster/nodes.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_nodes_modify_request_v1",
  "type": "object",
  "properties": {
    "node_uuids": {
      "type": "array",
      "items": {
        "description": "Identifiers of nodes to add to existing cluster",
        "type": "string"
      }
    },
    "node_ips": {
      "type": "array",
      "items": {
        "description": "IP addresses of nodes to add to existing cluster",
        "type": "string"
      }
    },
    "optimize_node_fault_tolerance_over_usable_capacity": {
      "description": "True to trade-off some increase in usable capacity for increased node fault tolerance. Defaults to False.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code Description
202 Return value on success