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

OK

Get Instances
{
  "instances": [
    {
      "address": "localhost",
      "currentStatus": {
        "connected": true,
        "lastHeartbeatTime": 16,
        "local": true
      },
      "instanceRecord": {
        "_id": "871f8be4-5fdb-45a8-868f-8d3e28a39148",
        "_createdAt": "2024-05-22T11:14:11.845Z",
        "_updatedAt": "2024-07-05T02:55:40.526Z",
        "extraInformation": {
          "host": "localhost",
          "port": "3000",
          "tcpPort": 46443,
          "os": {
            "type": "Linux",
            "platform": "linux",
            "arch": "x64",
            "release": "5.10.165-143.735.amzn2.x86_64",
            "uptime": 8455403.28,
            "loadavg": [
              "0.41",
              "0.17",
              "0.15"
            ],
            "totalmem": "4110323712",
            "freemem": 198479872,
            "cpus": 2
          },
          "nodeVersion": "v14.21.3",
          "conns": 1
        },
        "name": "rocket.chat",
        "pid": 1
      },
      "broadcastAuth": true
    }
  ],
  "success": true
}
Expand All
object
instances
Array of object
object
address
string
currentStatus
object
connected
boolean
lastHeartbeatTime
integer
local
boolean
instanceRecord
object
_id
string
_createdAt
string
_updatedAt
string
extraInformation
object
host
string
port
string
tcpPort
integer
os
object
type
string
platform
string
arch
string
release
string
uptime
number
loadavg
Array of number
number
totalmem
integer
freemem
integer
cpus
integer
nodeVersion
string
conns
integer
name
string
pid
integer
broadcastAuth
boolean
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string