Update Firewall Rule

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

Update a firewall rule

Path ParametersExpand Collapse

vpc_id: string

firewall_rule_id: string

Body ParametersJSONExpand Collapse

destination_address: optional string

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

destination_ports: optional array of string

Destination ports of the Firewall Rule.

name: optional string

Name of the Firewall Rule.

protocol: optional "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:

"tcp"

"udp"

source_address: optional 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.

tags: 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.

formatdate-time

details: OperationDetails { changes }

Structured details about what an operation is changing.

changes: OperationChanges { 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.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

kind: OperationKind

Kind of Operation.

One of the following:

"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: OperationStatus

Status of the Operation.

One of the following:

"pending"

"running"

"done"

"failed"

"unknown"

type: OperationType

Type of Operation.

One of the following:

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

formatdate-time

Update Firewall Rule

curl https://api.nirvanalabs.io/v1/networking/vpcs/$VPC_ID/firewall_rules/$FIREWALL_RULE_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "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",
          "tags": [
            "production",
            "ethereum"
          ]
        }'

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