Get Instances
- Print
- DarkLight
- PDF
Get Instances
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/instances.get
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
Success Example
{
"instances": [
{
"_id": "vQZbiEj9fChaa9kjw",
"_createdAt": "2021-09-01T18:29:30.430Z",
"_updatedAt": "2021-09-30T11:20:44.678Z",
"extraInformation": {
"host": "10.42.15.191",
"port": "3000",
"os": {
"type": "Linux",
"platform": "linux",
"arch": "x64",
"release": "4.15.0-109-generic",
"uptime": 36801050,
"loadavg": [
"8.66",
"9.46",
"9.89"
],
"totalmem": "270450634752",
"freemem": "105877463040",
"cpus": 32
},
"nodeVersion": "v12.22.1"
},
"name": "rocket.chat",
"pid": 1
}
],
"success": true
}object
instances
Array of object
object
_id
string
_createdAt
string
_updatedAt
string
extraInformation
object
host
string
port
string
os
object
type
string
platform
string
arch
string
release
string
uptime
integer
loadavg
Array of number
number
totalmem
integer
freemem
integer
cpus
integer
nodeVersion
string
name
string
pid
integer
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
Was this article helpful?