Get Instances

Prev Next

Get

/api/v1/instances.get

Get the instances running for the workspace. Permission required: view-statistics

Header parameters

X-User-Id

stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC

X-Auth-Token

stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE

Responses

200

401

403

OK

Collapse all

object

instances

Array of object

object

address

string

currentStatus

object

instanceRecord

object

broadcastAuth

boolean

success

boolean

Was this article helpful?

Request

URL

X-User-Id ^*

X-Auth-Token ^*

Response

Available responses

xxxxxxxxxx
 
{
 "instances": [
  {
   "address": "string",
   "currentStatus": {
    "connected": true,
    "lastHeartbeatTime": 1,
    "local": true
   },
   "instanceRecord": {
    "_id": "string",
    "_createdAt": "string",
    "_updatedAt": "string",
    "extraInformation": {
     "host": "string",
     "port": "string",
     "tcpPort": 1,
     "os": {
      "type": "string",
      "platform": "string",
      "arch": "string",
      "release": "string",
      "uptime": 1,
      "loadavg": [
       1
      ],
      "totalmem": 1,
      "freemem": 1,
      "cpus": 1
     },
     "nodeVersion": "string",
     "conns": 1
    },
    "name": "string",
    "pid": 1
   },
   "broadcastAuth": true
  }
 ],
 "success": true
}