# VPCs

## Create VPC

**post** `/v1/networking/vpcs`

Create a VPC

### Body Parameters

- `name: string`

  Name of the VPC.

- `project_id: string`

  Project ID the VPC belongs to.

- `region: RegionName`

  Region the resource is in.

  - `"us-sva-2"`

- `subnet_name: string`

  Name of the subnet to create.

- `tags: optional array of string`

  Tags to attach to the VPC.

### 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 \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-vpc",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "us-sva-2",
          "subnet_name": "my-subnet",
          "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"
}
```

## Get VPC Details

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

Get details about a VPC

### Path Parameters

- `vpc_id: string`

### Returns

- `VPC object { id, created_at, firewall_rule_ids, 7 more }`

  VPC details.

  - `id: string`

    Unique identifier for the VPC.

  - `created_at: string`

    When the VPC was created.

  - `firewall_rule_ids: array of string`

    IDs of the Firewall Rules associated with the VPC.

  - `name: string`

    Name of the VPC.

  - `project_id: string`

    Project ID the VPC belongs to.

  - `region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

  - `status: ResourceStatus`

    Status of the resource.

    - `"pending"`

    - `"creating"`

    - `"updating"`

    - `"ready"`

    - `"deleting"`

    - `"deleted"`

    - `"error"`

  - `subnet: Subnet`

    Subnet of the VPC.

    - `id: string`

      Unique identifier for the Subnet.

    - `cidr: string`

      CIDR block for the Subnet.

    - `created_at: string`

      When the Subnet was created.

    - `name: string`

      Name of the Subnet.

    - `updated_at: string`

      When the Subnet was updated.

  - `tags: array of string`

    Tags to attach to the VPC.

  - `updated_at: string`

    When the VPC was updated.

### Example

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

#### Response

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "firewall_rule_ids": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "name": "my-vpc",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "region": "us-sva-2",
  "status": "ready",
  "subnet": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "cidr": "10.128.35.128/25",
    "created_at": "2025-01-01T00:00:00Z",
    "name": "my-subnet",
    "updated_at": "2025-01-01T00:00:00Z"
  },
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z"
}
```

## Update VPC

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

Update a VPC

### Path Parameters

- `vpc_id: string`

### Body Parameters

- `name: optional string`

  Name of the VPC.

- `subnet_name: optional string`

  Name of the subnet to create.

- `tags: optional array of string`

  Tags to attach to the VPC.

### 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 \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-vpc",
          "subnet_name": "my-subnet",
          "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 VPC

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

Delete a VPC

### Path Parameters

- `vpc_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 \
    -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 VPCs

**get** `/v1/networking/vpcs`

List all VPCs

### Query Parameters

- `project_id: string`

  Project ID of resources to request

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `VPCList object { items, pagination }`

  - `items: array of VPC`

    - `id: string`

      Unique identifier for the VPC.

    - `created_at: string`

      When the VPC was created.

    - `firewall_rule_ids: array of string`

      IDs of the Firewall Rules associated with the VPC.

    - `name: string`

      Name of the VPC.

    - `project_id: string`

      Project ID the VPC belongs to.

    - `region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `status: ResourceStatus`

      Status of the resource.

      - `"pending"`

      - `"creating"`

      - `"updating"`

      - `"ready"`

      - `"deleting"`

      - `"deleted"`

      - `"error"`

    - `subnet: Subnet`

      Subnet of the VPC.

      - `id: string`

        Unique identifier for the Subnet.

      - `cidr: string`

        CIDR block for the Subnet.

      - `created_at: string`

        When the Subnet was created.

      - `name: string`

        Name of the Subnet.

      - `updated_at: string`

        When the Subnet was updated.

    - `tags: array of string`

      Tags to attach to the VPC.

    - `updated_at: string`

      When the VPC was updated.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

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

#### Response

```json
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "firewall_rule_ids": [
        "123e4567-e89b-12d3-a456-426614174001",
        "123e4567-e89b-12d3-a456-426614174002"
      ],
      "name": "my-vpc",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "status": "ready",
      "subnet": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "cidr": "10.128.35.128/25",
        "created_at": "2025-01-01T00:00:00Z",
        "name": "my-subnet",
        "updated_at": "2025-01-01T00:00:00Z"
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
```

## Domain Types

### Subnet

- `Subnet object { id, cidr, created_at, 2 more }`

  Subnet of the VPC.

  - `id: string`

    Unique identifier for the Subnet.

  - `cidr: string`

    CIDR block for the Subnet.

  - `created_at: string`

    When the Subnet was created.

  - `name: string`

    Name of the Subnet.

  - `updated_at: string`

    When the Subnet was updated.

### VPC

- `VPC object { id, created_at, firewall_rule_ids, 7 more }`

  VPC details.

  - `id: string`

    Unique identifier for the VPC.

  - `created_at: string`

    When the VPC was created.

  - `firewall_rule_ids: array of string`

    IDs of the Firewall Rules associated with the VPC.

  - `name: string`

    Name of the VPC.

  - `project_id: string`

    Project ID the VPC belongs to.

  - `region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

  - `status: ResourceStatus`

    Status of the resource.

    - `"pending"`

    - `"creating"`

    - `"updating"`

    - `"ready"`

    - `"deleting"`

    - `"deleted"`

    - `"error"`

  - `subnet: Subnet`

    Subnet of the VPC.

    - `id: string`

      Unique identifier for the Subnet.

    - `cidr: string`

      CIDR block for the Subnet.

    - `created_at: string`

      When the Subnet was created.

    - `name: string`

      Name of the Subnet.

    - `updated_at: string`

      When the Subnet was updated.

  - `tags: array of string`

    Tags to attach to the VPC.

  - `updated_at: string`

    When the VPC was updated.

### VPC List

- `VPCList object { items, pagination }`

  - `items: array of VPC`

    - `id: string`

      Unique identifier for the VPC.

    - `created_at: string`

      When the VPC was created.

    - `firewall_rule_ids: array of string`

      IDs of the Firewall Rules associated with the VPC.

    - `name: string`

      Name of the VPC.

    - `project_id: string`

      Project ID the VPC belongs to.

    - `region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `status: ResourceStatus`

      Status of the resource.

      - `"pending"`

      - `"creating"`

      - `"updating"`

      - `"ready"`

      - `"deleting"`

      - `"deleted"`

      - `"error"`

    - `subnet: Subnet`

      Subnet of the VPC.

      - `id: string`

        Unique identifier for the Subnet.

      - `cidr: string`

        CIDR block for the Subnet.

      - `created_at: string`

        When the Subnet was created.

      - `name: string`

        Name of the Subnet.

      - `updated_at: string`

        When the Subnet was updated.

    - `tags: array of string`

      Tags to attach to the VPC.

    - `updated_at: string`

      When the VPC was updated.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

# Availability

## Check Create VPC Availability

**post** `/v1/networking/vpcs/availability`

Check if a VPC can be created

### Body Parameters

- `name: string`

  Name of the VPC.

- `project_id: string`

  Project ID the VPC belongs to.

- `region: RegionName`

  Region the resource is in.

  - `"us-sva-2"`

- `subnet_name: string`

  Name of the subnet to create.

- `tags: optional array of string`

  Tags to attach to the VPC.

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/vpcs/availability \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-vpc",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "us-sva-2",
          "subnet_name": "my-subnet",
          "tags": [
            "production",
            "ethereum"
          ]
        }'
```

## Check Update VPC Availability

**patch** `/v1/networking/vpcs/{vpc_id}/availability`

Check if a VPC can be updated

### Path Parameters

- `vpc_id: string`

### Body Parameters

- `name: optional string`

  Name of the VPC.

- `subnet_name: optional string`

  Name of the subnet to create.

- `tags: optional array of string`

  Tags to attach to the VPC.

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/vpcs/$VPC_ID/availability \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-vpc",
          "subnet_name": "my-subnet",
          "tags": [
            "production",
            "ethereum"
          ]
        }'
```