Firewall Rule Details

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

Get details about a firewall rule

Path ParametersExpand Collapse

vpc_id: string

firewall_rule_id: string

ReturnsExpand Collapse

FirewallRule object { id, created_at, destination_address, 8 more }

Firewall rule details.

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.

Firewall Rule Details

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

{
  "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"
}

Returns Examples

{
  "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"
}