List Firewall Rules

GET/v1/networking/vpcs/{vpc_id}/firewall_rules

List all firewall rules

Path ParametersExpand Collapse

vpc_id: string

Query ParametersExpand Collapse

cursor: optional string

Pagination cursor returned by a previous request

limit: optional number

Maximum number of items to return

maximum100

minimum10

ReturnsExpand Collapse

FirewallRuleList object { items, pagination }

items: array of FirewallRule { id, created_at, destination_address, 8 more }

id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

formatdate-time

destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

name: string

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:

"tcp"

"udp"

source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

formatdate-time

vpc_id: string

ID of the VPC the Firewall Rule belongs to.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

List Firewall Rules

curl https://api.nirvanalabs.io/v1/networking/vpcs/$VPC_ID/firewall_rules \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "destination_address": "10.0.0.0/25",
      "destination_ports": [
        "22",
        "80",
        "443"
      ],
      "name": "my-firewall-rule",
      "protocol": "tcp",
      "source_address": "0.0.0.0/0",
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z",
      "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "destination_address": "10.0.0.0/25",
      "destination_ports": [
        "22",
        "80",
        "443"
      ],
      "name": "my-firewall-rule",
      "protocol": "tcp",
      "source_address": "0.0.0.0/0",
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z",
      "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}