# Firewall Rules

## Create Firewall Rule

`client.Networking.FirewallRules.New(ctx, vpcID, body) (*Operation, error)`

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

Create a firewall rule

### Parameters

- `vpcID string`

- `body FirewallRuleNewParams`

  - `DestinationAddress param.Field[string]`

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

  - `DestinationPorts param.Field[[]string]`

    Destination ports of the Firewall Rule.

  - `Name param.Field[string]`

    Name of the Firewall Rule.

  - `Protocol param.Field[FirewallRuleNewParamsProtocol]`

    Protocol of the Firewall Rule.

    - `const FirewallRuleNewParamsProtocolTcp FirewallRuleNewParamsProtocol = "tcp"`

    - `const FirewallRuleNewParamsProtocolUdp FirewallRuleNewParamsProtocol = "udp"`

  - `SourceAddress param.Field[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 param.Field[[]string]`

    Tags to attach to the Firewall Rule.

### Returns

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

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

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/networking"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  operation, err := client.Networking.FirewallRules.New(
    context.TODO(),
    "vpc_id",
    networking.FirewallRuleNewParams{
      DestinationAddress: "10.0.0.0/25",
      DestinationPorts: []string{"22", "80", "443"},
      Name: "my-firewall-rule",
      Protocol: networking.FirewallRuleNewParamsProtocolTcp,
      SourceAddress: "0.0.0.0/0",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", operation.ID)
}
```

#### 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

`client.Networking.FirewallRules.Get(ctx, vpcID, firewallRuleID) (*FirewallRule, error)`

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

Get details about a firewall rule

### Parameters

- `vpcID string`

- `firewallRuleID string`

### Returns

- `type FirewallRule struct{…}`

  Firewall rule details.

  - `ID string`

    Unique identifier for the Firewall Rule.

  - `CreatedAt Time`

    When the Firewall Rule was created.

  - `DestinationAddress string`

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

  - `DestinationPorts []string`

    Destination ports of the Firewall Rule.

  - `Name string`

    Name of the Firewall Rule.

  - `Protocol FirewallRuleProtocol`

    Protocol of the Firewall Rule.

    - `const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"`

    - `const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"`

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

    - `const ResourceStatusPending ResourceStatus = "pending"`

    - `const ResourceStatusCreating ResourceStatus = "creating"`

    - `const ResourceStatusUpdating ResourceStatus = "updating"`

    - `const ResourceStatusReady ResourceStatus = "ready"`

    - `const ResourceStatusDeleting ResourceStatus = "deleting"`

    - `const ResourceStatusDeleted ResourceStatus = "deleted"`

    - `const ResourceStatusError ResourceStatus = "error"`

  - `Tags []string`

    Tags to attach to the Firewall Rule.

  - `UpdatedAt Time`

    When the Firewall Rule was updated.

  - `VPCID string`

    ID of the VPC the Firewall Rule belongs to.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  firewallRule, err := client.Networking.FirewallRules.Get(
    context.TODO(),
    "vpc_id",
    "firewall_rule_id",
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", firewallRule.ID)
}
```

#### 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

`client.Networking.FirewallRules.Update(ctx, vpcID, firewallRuleID, body) (*Operation, error)`

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

Update a firewall rule

### Parameters

- `vpcID string`

- `firewallRuleID string`

- `body FirewallRuleUpdateParams`

  - `DestinationAddress param.Field[string]`

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

  - `DestinationPorts param.Field[[]string]`

    Destination ports of the Firewall Rule.

  - `Name param.Field[string]`

    Name of the Firewall Rule.

  - `Protocol param.Field[FirewallRuleUpdateParamsProtocol]`

    Protocol of the Firewall Rule.

    - `const FirewallRuleUpdateParamsProtocolTcp FirewallRuleUpdateParamsProtocol = "tcp"`

    - `const FirewallRuleUpdateParamsProtocolUdp FirewallRuleUpdateParamsProtocol = "udp"`

  - `SourceAddress param.Field[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 param.Field[[]string]`

    Tags to attach to the Firewall Rule.

### Returns

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

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

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/networking"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  operation, err := client.Networking.FirewallRules.Update(
    context.TODO(),
    "vpc_id",
    "firewall_rule_id",
    networking.FirewallRuleUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", operation.ID)
}
```

#### 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

`client.Networking.FirewallRules.Delete(ctx, vpcID, firewallRuleID) (*Operation, error)`

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

Delete a firewall rule

### Parameters

- `vpcID string`

- `firewallRuleID string`

### Returns

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

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

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  operation, err := client.Networking.FirewallRules.Delete(
    context.TODO(),
    "vpc_id",
    "firewall_rule_id",
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", operation.ID)
}
```

#### 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

`client.Networking.FirewallRules.List(ctx, vpcID, query) (*Cursor[FirewallRule], error)`

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

List all firewall rules

### Parameters

- `vpcID string`

- `query FirewallRuleListParams`

  - `Cursor param.Field[string]`

    Pagination cursor returned by a previous request

  - `Limit param.Field[int64]`

    Maximum number of items to return

### Returns

- `type FirewallRule struct{…}`

  Firewall rule details.

  - `ID string`

    Unique identifier for the Firewall Rule.

  - `CreatedAt Time`

    When the Firewall Rule was created.

  - `DestinationAddress string`

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

  - `DestinationPorts []string`

    Destination ports of the Firewall Rule.

  - `Name string`

    Name of the Firewall Rule.

  - `Protocol FirewallRuleProtocol`

    Protocol of the Firewall Rule.

    - `const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"`

    - `const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"`

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

    - `const ResourceStatusPending ResourceStatus = "pending"`

    - `const ResourceStatusCreating ResourceStatus = "creating"`

    - `const ResourceStatusUpdating ResourceStatus = "updating"`

    - `const ResourceStatusReady ResourceStatus = "ready"`

    - `const ResourceStatusDeleting ResourceStatus = "deleting"`

    - `const ResourceStatusDeleted ResourceStatus = "deleted"`

    - `const ResourceStatusError ResourceStatus = "error"`

  - `Tags []string`

    Tags to attach to the Firewall Rule.

  - `UpdatedAt Time`

    When the Firewall Rule was updated.

  - `VPCID string`

    ID of the VPC the Firewall Rule belongs to.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/networking"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Networking.FirewallRules.List(
    context.TODO(),
    "vpc_id",
    networking.FirewallRuleListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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

- `type FirewallRule struct{…}`

  Firewall rule details.

  - `ID string`

    Unique identifier for the Firewall Rule.

  - `CreatedAt Time`

    When the Firewall Rule was created.

  - `DestinationAddress string`

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

  - `DestinationPorts []string`

    Destination ports of the Firewall Rule.

  - `Name string`

    Name of the Firewall Rule.

  - `Protocol FirewallRuleProtocol`

    Protocol of the Firewall Rule.

    - `const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"`

    - `const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"`

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

    - `const ResourceStatusPending ResourceStatus = "pending"`

    - `const ResourceStatusCreating ResourceStatus = "creating"`

    - `const ResourceStatusUpdating ResourceStatus = "updating"`

    - `const ResourceStatusReady ResourceStatus = "ready"`

    - `const ResourceStatusDeleting ResourceStatus = "deleting"`

    - `const ResourceStatusDeleted ResourceStatus = "deleted"`

    - `const ResourceStatusError ResourceStatus = "error"`

  - `Tags []string`

    Tags to attach to the Firewall Rule.

  - `UpdatedAt Time`

    When the Firewall Rule was updated.

  - `VPCID string`

    ID of the VPC the Firewall Rule belongs to.

### Firewall Rule List

- `type FirewallRuleList struct{…}`

  - `Items []FirewallRule`

    - `ID string`

      Unique identifier for the Firewall Rule.

    - `CreatedAt Time`

      When the Firewall Rule was created.

    - `DestinationAddress string`

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

    - `DestinationPorts []string`

      Destination ports of the Firewall Rule.

    - `Name string`

      Name of the Firewall Rule.

    - `Protocol FirewallRuleProtocol`

      Protocol of the Firewall Rule.

      - `const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"`

      - `const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"`

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

      - `const ResourceStatusPending ResourceStatus = "pending"`

      - `const ResourceStatusCreating ResourceStatus = "creating"`

      - `const ResourceStatusUpdating ResourceStatus = "updating"`

      - `const ResourceStatusReady ResourceStatus = "ready"`

      - `const ResourceStatusDeleting ResourceStatus = "deleting"`

      - `const ResourceStatusDeleted ResourceStatus = "deleted"`

      - `const ResourceStatusError ResourceStatus = "error"`

    - `Tags []string`

      Tags to attach to the Firewall Rule.

    - `UpdatedAt Time`

      When the Firewall Rule was updated.

    - `VPCID string`

      ID of the VPC the Firewall Rule belongs to.

  - `Pagination Pagination`

    Pagination response details.

    - `NextCursor string`

    - `PreviousCursor string`

    - `TotalCount int64`