The following documentation for the control center rest api is to be treated as beta. The API can change at any time.

Authorization
Info Service
- Get information on the cluster's servers
Start Servers
- Start a single server
- Start the cluster
Stop Servers
- Stop a single server
- Stop the cluster

Authorization

The Control Center Service API accepts only basic authentication.

The user and password is configured in the ClusterixConfig.xml

Info Service

Get information on the cluster's servers

List of all configured servers of the cluster with additional data

GET http://localhost:9000/clusterix/info/cluster/servers

Example Result

[
  {
    "identifier": "pim-server1",
    "host": "localhost",
    "serverType": "PIM_SERVER",
    "cpuUsage": 0.22388043210047837,
    "usedSystemMemory": 9532284928,
    "completeSystemMemory": 16851181568,
    "usedDiskSpace": 1613462867968,
    "completeDiskSpace": 2324735270912,
    "volumeInfos": [
      {
        "freeDiskSpace": 341987057664,
        "volume": "C:\\",
        "usedDiskSpace": 169267482624
      },
      {
        "freeDiskSpace": 149988917248,
        "volume": "D:\\",
        "usedDiskSpace": 349877743616
      },
      {
        "freeDiskSpace": 219295711232,
        "volume": "Z:\\",
        "usedDiskSpace": 1094318211072
      }
    ],
    "serverhardwareState": "RUNNING",
    "serverState": "STOPPED",
    "clusterix": 0,
    "consoleLength": 0,
    "errors": 0,
    "warnings": 0,
    "runLevel": "",
    "consoleTail": [],
    "connectedNodes": []
  }
]

Start Servers

Start a single server

POST http://localhost:9000/clusterix/start/server/{identifier}

Param	Datatype	Notes
identifier	String	the identifier of the server to shutdown

Start the cluster

Starts all application servers of the cluster

POST http://localhost:9000/clusterix/start/cluster

Stop Servers

Stop a single server

Stops a single server. Kill will kill the process, no shutdown is performed (not recommended), force aborts all jobs and disconnects all clients immediatley, graceful waits till the jobs are finished and informs the clients that they should disconnect

POST http://localhost:9000/clusterix/shutdown/server/{identifier}?mode=graceful

Param	Datatype	Notes
mode	String	force \| graceful \| kill default: graceful
identifier	String	the identifier of the server to shutdown

Stop the cluster

Stops all application servers of the cluster

POST http://localhost:9000/clusterix/shutdown/cluster?mode=graceful

Param	Datatype	Notes
mode	String	force \| graceful \| kill default: graceful