List group names

Returns group names only. Use GET /api/v1/group-info for full details, including members and locations.

get

Authorizations

cookieapi_token

defguard_sessionstringRequired

Query parameters

pageinteger · int32Optional

Page number. Defaults to 1.

per_pageinteger · int32Optional

Number of items per page, from 1 to 100. Defaults to 50.

Responses

200

Paginated list of group names.

application/json

Envelope returned by paginated endpoints.

datastring[]Required

Items of the requested page.

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

500

Unable to list groups.

application/json

get/api/v1/group

HTTPcURLJavaScriptPython

GET /api/v1/group HTTP/1.1
Accept: */*

{
  "data": [
    "admin"
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1
  }
}