Retrieve details for a single device

Returns a specific device (server object) for the authenticated user.

get
/servers/{id}

https://console.automox.com/api/servers/{id}
Request
Response
Request
Path Parameters
id
required
integer
Server ID for the specified device
Headers
Authorization: Bearer
required
string
Your Automox API Key for authentication Format: Authorization: Bearer your_automox_api_key
Query Parameters
o
required
integer
Organization ID for the specified device
Response
200: OK
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"deleted": {
"type": "boolean"
},
"detail": {
"type": "object",
"properties": {
"CPU": {
"type": "string"
},
"DISKS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"SIZE": {
"type": "string"
},
"TYPE": {
"type": "string"
}
}
}
},
"MODEL": {
"type": "string"
},
"NICS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CONNECTED": {
"type": "boolean"
},
"DEVICE": {
"type": "string"
},
"IPS": {
"type": "array",
"items": {
"type": "string"
}
},
"MAC": {
"type": "string"
},
"TYPE": {
"type": "string"
},
"VENDOR": {
"type": "string"
}
}
}
},
"RAM": {
"type": "string"
},
"SERIAL": {
"type": "string"
},
"SERVICETAG": {
"type": "string"
},
"VENDOR": {
"type": "string"
},
"VERSION": {
"type": "string"
}
}
},
"instance_id": {
"type": "string"
},
"ip_addrs": {
"type": "array",
"items": {
"type": "string"
}
},
"last_checkin_time": {
"type": "string",
"format": "date-time"
},
"last_refresh_time": {
"type": "string",
"format": "date-time"
},
"last_update_time": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"needs_reboot": {
"type": "boolean"
},
"organization_id": {
"type": "integer",
"format": "int64"
},
"os_family": {
"type": "string"
},
"os_name": {
"type": "string"
},
"os_version_id": {
"type": "integer",
"format": "int64"
},
"patches": {
"type": "integer",
"format": "int64"
},
"refresh_interval": {
"type": "integer",
"format": "int64"
},
"server_group_id": {
"type": "integer",
"format": "int64"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"timezone": {
"type": "string"
},
"uptime": {
"type": "integer",
"format": "int64"
},
"uuid": {
"type": "string"
},
"status": {
"device_status": {
"type": "string"
},
"agent_status": {
"type": "string"
},
"policy_status": {
"type": "string"
},
"policy_statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "int64"
},
"compliant": {
"type": "boolean"
}
}
}
}
}
}
}
404: Not Found
An attempt to get information about a device that was deleted returns a 404 error.
{
"description": "Unauthorized"
}

Example Requests

cURL
Python http.client
Python requests
C#
PowerShell
cURL
curl -X GET \
'https://console.automox.com/api/servers/123456?o=0000' \
-H 'Authorization: Bearer your_automox_api_key'
Python http.client
import http.client
conn = http.client.HTTPConnection("console,automox,com")
headers = {
'Authorization': "Bearer your_automox_api_key"
}
conn.request("GET", "api,servers,123456", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Python requests
import requests
url = "https://console.automox.com/api/servers/123456"
querystring = {"o":"0000"}
headers = {
'Authorization': "Bearer your_automox_api_key"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
C#
var client = new RestClient("https://console.automox.com/api/servers/123456?o=0000");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 800a0975-1d94-4e4c-9cf9-9f7d44cc3eed");
IRestResponse response = client.Execute(request);
PowerShell
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/servers/123456?o=0000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content