Create Firewall Rule

$ nirvana networking:firewall-rules create

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

Create a firewall rule

ParametersExpand Collapse

--vpc-id: string

VPC ID

--destination-address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC. Must be in network-aligned/canonical form.

--destination-port: 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.

--source-address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0. Must be in network-aligned/canonical form.

--tag: optional array of string

Tags to attach to the Firewall Rule.

ReturnsExpand Collapse

operation: object { id, created_at, details, 6 more }

Operation details.

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

details: object { changes }

Structured details about what an operation is changing.

changes: map[OperationFieldDiff { from, to } ]

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

to: string or number or boolean or array of string

New value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

kind: "vm" or "volume" or "vpc" or 3 more

Kind of Operation.

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: "pending" or "running" or "done" or 2 more

Status of the Operation.

"pending"

"running"

"done"

"failed"

"unknown"

type: "create" or "update" or "delete" or "restart"

Type of Operation.

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

Create Firewall Rule

nirvana networking:firewall-rules create \
  --api-key 'My API Key' \
  --vpc-id vpc_id \
  --destination-address 10.0.0.0/25 \
  --destination-port "'22'" \
  --destination-port "'80'" \
  --destination-port "'443'" \
  --name my-firewall-rule \
  --protocol tcp \
  --source-address 0.0.0.0/0

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}