Groups Api List Groups
Returns every Security Group. Accessible to every authenticated role.
200 OK successful response envelope. Every Security Group
[
{
"securityGroupId": 1,
"name": "Production Servers",
"description": "Hosts that run production workloads",
"isDefault": false,
"heartbeatIntervalSeconds": 120,
"enforcementMode": "ENFORCE",
"agentDisabledStatus": false,
"policyVersion": 3,
"hasPendingChanges": true,
"hypervisorCount": 2,
"policyCount": 2,
"createdBy": 1,
"createdByUsername": "alice.example",
"updatedBy": 2,
"updatedByUsername": "bob.example",
"createdAt": "2026-01-02T09:00:00Z",
"updatedAt": "2026-01-15T09:20:00Z"
},
{
"securityGroupId": 2,
"name": "Staging Servers",
"description": "Pre-production test hosts",
"isDefault": false,
"heartbeatIntervalSeconds": 300,
"enforcementMode": "ENFORCE",
"agentDisabledStatus": false,
"policyVersion": 1,
"hasPendingChanges": false,
"hypervisorCount": 0,
"policyCount": 1,
"createdBy": 1,
"createdByUsername": "alice.example",
"updatedBy": 1,
"updatedByUsername": "alice.example",
"createdAt": "2026-01-03T09:00:00Z",
"updatedAt": "2026-01-03T09:00:00Z"
}
]
A Security Group.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/groups