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.
PS_VERSION
optional
integer
PowerShell version running on the machine.
Response
200: OK
Device successfully retrieved
[
{
"id": 123456,
"os_version_id": 4313,
"server_group_id": 18321,
"organization_id": 1234,
"uuid": "string",
"name": string",
"instance_id": "",
"refresh_interval": 1440,
"last_update_time": "2021-03-09T07:00:38+0000",
"last_refresh_time": "2021-03-14T23:16:53+0000",
"uptime": "456627",
"needs_reboot": false,
"timezone": "UTC-0600",
"tags": [
"string"
],
"deleted": false,
"create_time": "2019-11-25T18:59:02+0000",
"os_version": "11.2.3",
"os_name": "string",
"os_family": "string",
"ip_addrs": [
"string"
],
"ip_addrs_private": [
"string"
],
"patches": 2,
"detail": {
"NICS": [
{
"TYPE": "string",
"MAC": "string",
"IPS": [
"string"
],
"CONNECTED": true,
"VENDOR": "string",
"DEVICE": "en0"
}
],
"IPS": [
"string"
],
"LAST_USER_LOGON": {
"SRC": "console",
"USER": "string",
"TIME": "2021-03-10T07:17:39-0700"
},
"VERSION": "string",
"VOLUME": [
{
"IS_SYSTEM_DISK": "true",
"VOLUME": "/dev/disk1s5s1",
"FSTYPE": "APFS",
"LABEL": "Macintosh HD",
"AVAIL": "121018208256",
"FREE": "51197444096"
}
],
"WSUS_CONFIG": null,
"RAM": "string",
"AUTO_UPDATE_OPTIONS": {
"ENABLED": "0",
"OPTIONS": "Automatic Check for Updates, Download new updates when available, Install system data updates, Install system security updates"
},
"DISKS": [
{
"TYPE": "string",
"SIZE": "string"
}
],
"SERIAL": "string",
"MODEL": "string",
"VENDOR": "string",
"SERVICETAG": null,
"WMI_INTEGRITY_CHECK": null,
"CPU": "string",
"PS_VERSION": null,
"UPDATE_SOURCE_CHECK": {
"ERROR": "Succeded",
"CONNECTED": "true"
},
"FQDNS": []
},
"agent_version": "1.0-30",
"custom_name": "string",
"exception": false,
"total_count": 2,
"server_policies": [],
"policy_status": [
{
"id": 123456789,
"organization_id": 1234,
"policy_id": 13530,
"server_id": 429883,
"policy_name": "Default Patch Policy",
"policy_type_name": "patch",
"status": 2,
"result": "{}",
"create_time": "2021-03-14T23:16:53+0000",
"next_remediation": null
}
],
"last_scan_failed": false,
"pending": true,
"compliant": true,
"display_name": "string",
"commands": [],
"pending_patches": 2,
"connected": true,
"last_process_time": "2021-03-15T13:41:35+0000",
"next_patch_time": "2021-03-16T06:00:00+0000",
"notification_count": 1,
"reboot_notification_count": 0,
"patch_deferral_count": 0,
"reboot_deferral_count": 0,
"is_delayed_by_notification": true,
"reboot_is_delayed_by_notification": false,
"is_delayed_by_user": false,
"reboot_is_delayed_by_user": false,
"last_disconnect_time": null,
"needs_attention": false,
"serial_number": "string",
"last_logged_in_user": "string",
"status": {
"device_status": "ready",
"agent_status": "connected",
"policy_status": "non-compliant",
"policy_statuses": [
{
"id": 13530,
"compliant": false
}
]
}
},

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