Retrieve details for all groups

Retrieves all server group objects for the authenticated user.

get
/servergroups

https://console.automox.com/api/servergroups
Request
Response
Request
Headers
Authorization: Bearer
required
string
Your Automox API Key for authentication
Query Parameters
o
required
integer
Organization ID for retrieving groups
Response
200: OK
{
"type": "array",
"items": {
"type": "object",
"id": {
"type": "integer",
"format": "int64"
},
"organization_id": {
"type": "integer"
"format": "int64"
},
"name": {
"type": "string"
},
"refresh_interval": {
"type": "integer",
"format": "int64"
}
"parent_server_group_id": {
"type": "integer",
"format": "int64"
},
"ui_color": {
"type": "string"
},
"notes": {
"type": "string"
},
"enable_os_auto_update": {
"type": "boolean"
},
"server_count": {
"type": "integer"
"format": "int64"
},
"wsus_config": {
"type": "object"
},
"policies": {
"type": "array",
"format": "int64"
},
"refresh_interval": {
"type": "integer",
"format": "int64"
}
}
}
}

Example Requests

cURL
Python http.client
Python requests
C#
PowerShell
cURL
curl -X GET \
'https://console.automox.com/api/servergroups?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,servergroups", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Python requests
import requests
url = "https://console.automox.com/api/servergroups"
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/servergroups?o=0000");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer your_automox_api_key");
IRestResponse response = client.Execute(request);
PowerShell
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/servergroups?o=0000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content