Skip to main content
GET
List security groups

Authorizations

Authorization
string
header
required

Authentication is performed via an Auth0-issued JSON Web Token (JWT). Provide the token in the Authorization header with the Bearer scheme.

Response

A list of security groups.

id
string
read-only

The unique identifier for the security group, prefixed with sec_grp_.

Example:

"sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw"

name
string

A human-readable name for the security group.

Example:

"Default Web Servers"

description
string

An optional description for the security group, providing more context.

Example:

"Allows inbound HTTP/HTTPS traffic from anywhere."

status
enum<string>
read-only

The current synchronization status of the security group. syncing means changes are being deployed and the resource is locked from modification.

Available options:
active,
syncing,
failed
Example:

"active"

sites
string[]

A list of site IDs to which this security group is currently applied.

rules
object[]

An ordered list of firewall rules that define the security policy.