Skip to main content
GET
/
api
/
v1
/
accounts
/
{accountId}
/
projects
/
{projectId}
/
security-groups
List security groups
curl --request GET \
  --url https://api.aion.xyz/api/v1/accounts/{accountId}/projects/{projectId}/security-groups \
  --header 'Authorization: Bearer <token>'
{
  "security_groups": [
    {
      "id": "sg-abc123xyz-v1",
      "account_id": "<string>",
      "project_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "active",
      "metadata": {},
      "rules": [
        {
          "id": "sgr-abc123xyz-v1",
          "security_group_id": "<string>",
          "direction": "ingress",
          "protocol": "<string>",
          "port_range_min": 123,
          "port_range_max": 123,
          "remote_ip_prefix": "<string>",
          "remote_security_group_id": "<string>",
          "icmp_type": 123,
          "icmp_code": 123,
          "priority": 123,
          "description": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "is_deleted": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "is_deleted": true
    }
  ],
  "next_page_token": "<string>",
  "total_count": 123,
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

JWT token from authentication service

Headers

x-account-id
string

Account ID from authentication (must match path accountId)

Path Parameters

accountId
string
required

Account external ID

Pattern: ^acct-[a-zA-Z0-9]+-v1$
projectId
string
required

Project external ID

Pattern: ^proj-[a-zA-Z0-9]+-v1$

Query Parameters

page_size
integer
default:50

Number of items per page (max 100)

Required range: 1 <= x <= 100
page_token
string

Token for pagination

status
enum<string>

Filter by status

Available options:
active,
pending,
error,
deleting,
deleted

Response

List of security groups

security_groups
object[]
next_page_token
string

Token for next page (empty if no more pages)

total_count
integer

Total number of security groups

message
string