ByCloud Docs
GuidesCLIAPISDK
get/v1/security-groups/{security_group_id}/rules

List security group rules

List all rules for a specific security group

Path Parameters

security_group_id

string<uuid>required

path

Security Group ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

Example: "550e8400-e29b-41d4-a716-446655440000"

direction

stringoptional

query

Filter by direction

Enum: "ingress", "egress"

protocol

stringoptional

query

Filter by protocol

ethertype

stringoptional

query

Filter by ethertype

Enum: "IPv4", "IPv6"

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Responses

200

List of security group rules

Content-Type: application/json

security_group_rules

arrayoptional

meta

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/security-groups/550e8400-e29b-41d4-a716-446655440000/rules" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of security group rules

{
  "security_group_rules": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:network:security-group-rule:550e8400-e29b-41d4-a716-446655440000",
      "security_group_id": "550e8400-e29b-41d4-a716-446655440001",
      "direction": "ingress",
      "ethertype": "IPv4",
      "protocol": "tcp",
      "port_range_min": 80,
      "port_range_max": 80,
      "remote_ip_prefix": "0.0.0.0/0",
      "remote_group_id": "550e8400-e29b-41d4-a716-446655440000",
      "description": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  }
}