<< Click to Display Table of Contents >> Navigation:  API > servers > get

Description

Obtains information about a specific server.

Syntax

https://api.cameyo.com/servers/[server-id]/get?clientId=...&clientSecret=...

Return

200: success.

400: invalid parameters.

403: authentication failed or insufficient permissions.

404: server not found.

500: an internal error has occurred.

Response

•status: one of the following server statuses: "running", "starting", "creating", "maintenance", "off", "deleting", "transitioning", "deleted".

•groupId: cluster ID to which the server is assigned.

•url: server's HTTP(S) base URL.

•created: server creation time.

•lastPing: server's last ping time, or empty of server hasn't been created yet.

•powertags: server's powertags, if any.

•ramUsageMb: current RAM usage in megabytes. Only provided if the server is currently on.

•ramTotalMb: total RAM in megabytes.

•cpuUsage: CPU usage in percentage. Only provided if the server is currently on.

•lastSession: time of the last session performed on this server, or empty if no session has been performed as of yet.

Response example

{

 "status": "running",

 "groupId": "ae7d3885-6e58-4d28-9144-a978e1332ad7",

 "url": "https://planira126.cameyo.net:443",

 "created": "2022-04-25T12:17:18.377",

 "lastPing": "2022-05-04T17:46:30.387",

 "powertags": [

   "!STARTUP_BEFORE_SYNC_BAT=c:\\windows\\system32\\calc.exe",

   "!WEBFS=1",

   "!STORAGEFILEDIALOGNEW=1"

 ],

 "ramUsageMb": 2229,

 "ramTotalMb": 7679,

 "cpuUsage": 49,

 "lastSession": "2022-05-04T17:31:29.437"

}