HomeGuidesAPI Reference
API Reference

Get All Roles

Retrieves all configured segmentation roles or a filtered subset. Roles define Group Policy IDs (GPIDs) used for network segmentation. Default roles 'default' (ID: 0, GPID: 0) and 'unknown' (ID: 1, GPID: 65535) are always present.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^[_A-Za-z0-9-]+$

Filter roles by name using a case-insensitive substring match. Only alphanumeric characters, dashes (-), and underscores (_) are allowed.

Responses

401

Unauthorized - User not authenticated or session expired.

403

Forbidden - User lacks READ or READ_WRITE permission.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json