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
limit
optional
integer
Maximum number of group details to retrieve per page. Use in conjunction with the page parameter. See About Automox API > Pagination.
page
optional
integer
Retrieve a specific page from the list of group details. Use in conjunction with the limit parameter. See About Automox API > Pagination.
o
required
integer
Organization ID for retrieving groups
Response
200: OK
Details for groups successfully retrieved.
[
{
"id": 30599,
"organization_id": 1234,
"name": "",
"refresh_interval": 360,
"parent_server_group_id": 23456,
"ui_color": "#059F1D",
"notes": "",
"enable_os_auto_update": null,
"server_count": 2,
"wsus_config": {
"id": 21987,
"server_group_id": 30599,
"is_managed": null,
"server_url": null,
"created_at": "2020-11-03T00:22:06+0000",
"updated_at": "2020-11-03T00:22:06+0000"
},
"policies": [
25248,
25249,
116691,
44359,
27293,
29162,
67117
]
},
{
"id": 33237,
"organization_id": 1234,
"name": "Oct. update",
"refresh_interval": 1440,
"parent_server_group_id": 23456,
"ui_color": "#059F1D",
"notes": "",
"enable_os_auto_update": null,
"server_count": 0,
"wsus_config": null,
"policies": [
27932
]
},
{
"id": 33434,
"organization_id": 1234,
"name": "Fal.Con Demo",
"refresh_interval": 1440,
"parent_server_group_id": 23456,
"ui_color": "#059F1D",
"notes": "",
"enable_os_auto_update": false,
"server_count": 0,
"wsus_config": null,
"policies": [
43575
]
}
]

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