Creates a new server group.

Creates a new server group. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
query Parameters
o
required
integer <int64>

Organization ID for the created group.

Request Body schema: application/json
required
name
required
string

Name of the group

refresh_interval
required
integer [ 240 .. 1440 ]

Frequency of device refreshes (scans) in minutes. Minimum: 240 Maximum: 1440

parent_server_group_id
required
integer

ID of the parent group. Use the organization's Default Group ID to make this a top-level group. See About Automox API - Default Group ID

ui_color
string

The highlight color for the group. Primarily used on the System Management view. Format: #059F1D

notes
string

Use to define notes that are displayed while editing the policy

enable_os_auto_update
boolean or null

Enforce automatic update settings Options: null: Keep Device's Setting. true: Enable OS automatic updates. false: Disable OS automatic updates.

enable_wsus
boolean or null

Enforce WSUS settings for Windows devices. Options: null: Keep Device's Setting. true: force WSUS. false: force Windows Update.

wsus_server
string

WSUS server address. Use with enable_wsus. Format: "https://myserver.com:8530"

policies
Array of integers
Responses
200

Successful Operation

4XX

Invalid Request

default

Invalid Request

post/servergroups
Request samples
application/json
{
  • "name": "My Test Server Group",
  • "refresh_interval": 1440,
  • "parent_server_group_id": 90125,
  • "ui_color": "#3C78D8",
  • "notes": "Here's a note",
  • "enable_os_auto_update": true,
  • "enable_wsus": false,
  • "wsus_server": null,
  • "policies": [
    • 421365,
    • 587321
    ]
}
Response samples
application/json
{
  • "summary": "Server group example",
  • "description": "Example of a server group object with configuration settings, WSUS configuration, and associated policies",
  • "value": {
    • "id": 654231,
    • "organization_id": 250624,
    • "name": "My Test Server Group",
    • "refresh_interval": 1440,
    • "parent_server_group_id": 90125,
    • "ui_color": "#3C78D8",
    • "notes": "Here's some notes",
    • "enable_os_auto_update": true,
    • "server_count": 1,
    • "wsus_config": {
      • "id": 954368,
      • "server_group_id": 654321,
      • "is_managed": null,
      • "server_url": null,
      • "created_at": "2021-10-20T04:03:25+0000",
      • "updated_at": "2021-10-20T04:03:25+0000"
      },
    • "policies": [
      • 421365,
      • 587321
      ]
    }
}