Systems

get__systems_list

Code samples

GET /systems/list HTTP/1.1

Accept: application/json

GET /systems/list

List systems.

Parameters

Name	In	Type	Required	Description
connectToAllSystems	query	boolean	false	Create a connection to all systems.
showNodes	query	boolean	false	Show nodes within the systems.

Example responses

200 Response

{
  "Systems": [
    {
      "Id": 0,
      "Name": "string",
      "IsCurrentlyConnectedSystem": true,
      "Connectivity": "Relay",
      "ConnectedNodeAddress": "string",
      "RefreshedCachedQueryCount": 0,
      "Nodes": [
        {
          "Name": "string",
          "Id": 0,
          "Time": "2019-08-24T14:15:22Z",
          "State": "Running",
          "HAState": "Unknown",
          "CurrentManagementConnection": true
        }
      ],
      "ReplicationTargetSystems": [
        "string"
      ]
    }
  ],
  "Message": "string"
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	SystemsList
400	Bad Request	Bad Request	string

put__systems_rename

Code samples

PUT /systems/rename HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /systems/rename

Rename a system.

Body parameter

{
  "Name": "string",
  "Id": 0,
  "Newname": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	SystemsRename	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__systems_select

Code samples

GET /systems/select HTTP/1.1

Accept: application/json

GET /systems/select

Switch to a different system.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Switch and manage this system by name.
id	query	integer(int64)	false	Switch and manage this system by id.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string