# Firewall Rules

## Create Firewall Rule

**post** `/v1/networking/vpcs/{vpc_id}/firewall_rules`

Create a firewall rule

### Path Parameters

- `vpc_id: string`

### Body Parameters

- `destination_address: string`

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

- `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.

  - `"tcp"`

  - `"udp"`

- `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.

- `tags: optional array of string`

  Tags to attach to the Firewall Rule.

### Returns

- `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: OperationDetails`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

      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.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

  - `kind: OperationKind`

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

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/vpcs/$VPC_ID/firewall_rules \
    -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"
          ]
        }'
```

#### Response

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

## Firewall Rule Details

**get** `/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}`

Get details about a firewall rule

### Path Parameters

- `vpc_id: string`

- `firewall_rule_id: string`

### Returns

- `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.

  - `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.

    - `"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.

    - `"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.

  - `vpc_id: string`

    ID of the VPC the Firewall Rule belongs to.

### Example

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

#### Response

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

## Update Firewall Rule

**patch** `/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}`

Update a firewall rule

### Path Parameters

- `vpc_id: string`

- `firewall_rule_id: string`

### Body Parameters

- `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.

  - `"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.

### Returns

- `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: OperationDetails`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

      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.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

  - `kind: OperationKind`

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

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Example

```http
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"
          ]
        }'
```

#### Response

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

## Delete Firewall Rule

**delete** `/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}`

Delete a firewall rule

### Path Parameters

- `vpc_id: string`

- `firewall_rule_id: string`

### Returns

- `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: OperationDetails`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

      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.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

  - `kind: OperationKind`

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

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Example

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

#### Response

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

## List Firewall Rules

**get** `/v1/networking/vpcs/{vpc_id}/firewall_rules`

List all firewall rules

### Path Parameters

- `vpc_id: string`

### Query Parameters

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `FirewallRuleList object { items, pagination }`

  - `items: array of FirewallRule`

    - `id: string`

      Unique identifier for the Firewall Rule.

    - `created_at: string`

      When the Firewall Rule was created.

    - `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.

      - `"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.

      - `"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.

    - `vpc_id: string`

      ID of the VPC the Firewall Rule belongs to.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

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

#### Response

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

## Domain Types

### Firewall Rule

- `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.

  - `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.

    - `"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.

    - `"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.

  - `vpc_id: string`

    ID of the VPC the Firewall Rule belongs to.

### Firewall Rule List

- `FirewallRuleList object { items, pagination }`

  - `items: array of FirewallRule`

    - `id: string`

      Unique identifier for the Firewall Rule.

    - `created_at: string`

      When the Firewall Rule was created.

    - `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.

      - `"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.

      - `"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.

    - `vpc_id: string`

      ID of the VPC the Firewall Rule belongs to.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`