Groups Api List Groups

Groups Api List Groups
List Security Groups

Returns every Security Group. Accessible to every authenticated role.

Request
URI
GET
https://{api_host}/api/v1/groups
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

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"
    }
]
array of object
Optional

A Security Group.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/groups