UpdateGroupRequest

UpdateGroupRequest
UpdateGroupRequest

Request body to update a Security Group. Every field is optional; an omitted or null field keeps its current value.

JSON Example
{
    "name": "string",
    "description": "string",
    "heartbeatIntervalSeconds": 0,
    "enforcementMode": "string",
    "agentDisabledStatus": false
}
string
name
Optional
Constraints: minLength: 1 maxLength: 255

Same character and uniqueness rules as create; an unchanged name is not re-checked for characters

string
description
Optional
Constraints: maxLength: 2000

Replaces the description, trimmed with the same 2,000-character limit as on create. Absent or null leaves the description unchanged

integer As int32 As int32
heartbeatIntervalSeconds
Optional
Constraints: minimum: 30 maximum: 300

New seconds between agent heartbeats, from 30 to 300 inclusive; any other value is INVALID_HEARTBEAT_INTERVAL. Absent or null leaves the interval unchanged

enforcementMode
Optional

A Group's own enforcement posture, passed to its agents unchanged.

  • ENFORCE: The Group's agents are sent the enforcement mode MODE_ENFORCE; the mode of a new Group when none is given
  • MONITOR: The Group's agents are sent the enforcement mode MODE_MONITOR
Enumeration: ENFORCE, MONITOR
boolean
agentDisabledStatus
Optional

Changing it sends the disable or enable command to the Group's active agents after the change commits, in the background. Only ADMIN may send true.