List all group objects

Retrieves all server group objects for the authenticated user. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
query Parameters
o
required
integer

Organization ID for retrieving groups.

page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. See About Automox API - Pagination

limit
integer [ 1 .. 500 ]
Default: 500

A limit on the number of results to be returned, between 1 and 500, with a default of 500. Use with page parameter. See About Automox API - Pagination

Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

default

Invalid Request

get/servergroups
Request samples 
$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
Response samples
application/json
[
  • {
    • "id": 155825,
    • "organization_id": 106068,
    • "name": "",
    • "refresh_interval": 360,
    • "parent_server_group_id": 155825,
    • "ui_color": "#059F1D",
    • "notes": "",
    • "enable_os_auto_update": null,
    • "server_count": 1,
    • "wsus_config": {
      • "id": 107217,
      • "server_group_id": 155825,
      • "is_managed": null,
      • "server_url": null,
      • "created_at": "2023-12-30T20:02:09+0000",
      • "updated_at": "2023-12-30T20:02:09+0000"
      },
    • "policies": [
      • 271711,
      • 270658,
      • 270659,
      • 284592,
      • 271710,
      • 271707,
      • 323582,
      • 271708,
      • 271709,
      • 271715
      ]
    },
  • {
    • "id": 156202,
    • "organization_id": 106068,
    • "name": "Laptops",
    • "refresh_interval": 360,
    • "parent_server_group_id": 155825,
    • "ui_color": "#059B9F",
    • "notes": "",
    • "enable_os_auto_update": null,
    • "server_count": 1,
    • "wsus_config": {
      • "id": 84042,
      • "server_group_id": 156202,
      • "is_managed": null,
      • "server_url": null,
      • "created_at": "2023-03-12T17:34:42+0000",
      • "updated_at": "2023-03-12T17:34:42+0000"
      },
    • "policies": [
      • 271711,
      • 270658,
      • 284592,
      • 271710,
      • 271707,
      • 323582,
      • 271708,
      • 271709,
      • 271715
      ]
    },
  • {
    • "id": 156203,
    • "organization_id": 106068,
    • "name": "Windows Lappies",
    • "refresh_interval": 360,
    • "parent_server_group_id": 156202,
    • "ui_color": "#C53EC3",
    • "notes": "",
    • "enable_os_auto_update": null,
    • "server_count": 2,
    • "wsus_config": {
      • "id": 84043,
      • "server_group_id": 156203,
      • "is_managed": null,
      • "server_url": null,
      • "created_at": "2023-03-12T18:13:48+0000",
      • "updated_at": "2023-03-12T18:13:48+0000"
      },
    • "policies": [
      • 270659,
      • 271713,
      • 271710,
      • 271714,
      • 271707,
      • 271712,
      • 271708,
      • 271709
      ]
    },
  • {
    • "id": 182986,
    • "organization_id": 106068,
    • "name": "Virtual Machines",
    • "refresh_interval": 360,
    • "parent_server_group_id": 155825,
    • "ui_color": "#3C78D8",
    • "notes": "",
    • "enable_os_auto_update": null,
    • "server_count": 1,
    • "wsus_config": {
      • "id": 107360,
      • "server_group_id": 182986,
      • "is_managed": null,
      • "server_url": null,
      • "created_at": "2024-01-03T20:35:12+0000",
      • "updated_at": "2024-01-03T20:35:12+0000"
      },
    • "policies": [
      • 270658,
      • 270659,
      • 271713,
      • 271710,
      • 271714,
      • 271707,
      • 271712,
      • 271708,
      • 271709
      ]
    }
]