Ssh

Start a new SSH session to a Solar Node

post

Start a new SSH session to a Solar Node

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

nodeIdstringRequired

The node ID

Responses

200

successful operation

application/json

webSocketUrlstringOptional

solarNodeProxyUrlstringOptional

startedbooleanOptional

400

Invalid status value

application/json

post

/solarnetwork/ssh

HTTPcURLJavaScriptPython

POST /solarnetwork/ssh?nodeId=text HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "session": {
    "sessionId": "text",
    "created": 1,
    "nodeId": 1,
    "host": "text",
    "port": 1,
    "reversePort": 1,
    "startInstructionId": 1,
    "stopInstructionId": 1,
    "established": true
  },
  "data": {
    "authorization": "text",
    "authorization-date": 1,
    "username": "text",
    "password": "text"
  },
  "webSocketUrl": "text",
  "solarNodeProxyUrl": "text",
  "started": true
}

Stop existing SSH session to a Solar Node

delete

Stop existingSSH session to a Solar Node

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

nodeIdstringRequired

The node ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

delete

/solarnetwork/ssh

HTTPcURLJavaScriptPython

DELETE /solarnetwork/ssh?nodeId=text HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "session": {
    "sessionId": "text",
    "created": 1,
    "nodeId": 1,
    "host": "text",
    "port": 1,
    "reversePort": 1,
    "startInstructionId": 1,
    "stopInstructionId": 1,
    "established": true
  }
}