Skip to main content
GET
/
security-groups
List security groups
curl --request GET \
  --url https://api.altostrat.io/security-groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw",
    "name": "Default Web Servers",
    "description": "Allows inbound HTTP/HTTPS traffic from anywhere.",
    "status": "active",
    "sites": [],
    "rules": []
  },
  {
    "id": "sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpz",
    "name": "Internal Management",
    "description": "Allows SSH and RDP from the main office prefix list.",
    "status": "syncing",
    "sites": [],
    "rules": []
  }
]

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

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>

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.