Skip to main content
GET
/
vpc
/
security-groups
/
{securityGroupId}
Retrieve a security group
curl --request GET \
  --url https://v1.api.altostrat.io/vpc/security-groups/{securityGroupId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw",
  "name": "Default Web Servers",
  "description": "Allows inbound HTTP/HTTPS traffic from anywhere.",
  "status": "active",
  "sites": [
    "site_12345"
  ],
  "rules": [
    {
      "id": "fltr_0ujsswThIGTUYm2K8FjOOfxcYpw",
      "direction": "inbound",
      "order": 10,
      "protocol": 6,
      "port": "443",
      "address": "0.0.0.0/0",
      "description": "Allow inbound HTTPS traffic"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
securityGroupId
string
required

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

Pattern: ^sec_grp_[0-9a-zA-Z]{27}$
Example:

"sec_grp_0ujsswThIGTUYm2K8FjOOfxcYpw"

Response

The requested security group object.

Represents a container for a stateful firewall ruleset.

​
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.