Nirvana Labs API | Networking › VPCs

API Reference

Networking

networking

Networking

Connect

networking.connect

Domain types

ConnectBandwidthMbps = 50 | 200 | 500 | 2 more...

Connect Connection speed in Mbps

ConnectConnection = { id, asn, aws, 12 more... }

Connect Connection details.

ConnectConnectionAWSConfig = { region }

AWS provider configuration

ConnectConnectionAWSConfigRequest = { account_id, region }

AWS provider configuration

ConnectConnectionList = { items, pagination }

ConnectRoute = { nirvana_region, provider, provider_region }

Routes supported for Connect.

ConnectRouteList = { items, pagination }

Networking Connect

Connections

networking.connect.connections

Methods

Create Connect Connection ->

Operation

post/v1/networking/connect/connections

Create a Connect Connection

Get Connect Connection ->

ConnectConnection

get/v1/networking/connect/connections/{connection_id}

Get Connect Connection details

Update Connect Connection ->

Operation

patch/v1/networking/connect/connections/{connection_id}

Update Connect Connection details

Delete Connect Connection ->

Operation

delete/v1/networking/connect/connections/{connection_id}

Delete Connect Connection

List Connect Connection -> Cursor<

ConnectConnection

get/v1/networking/connect/connections

List all Connect Connections

Networking Connect

Routes

networking.connect.routes

Methods

List Connect Supported Routes -> Cursor<

ConnectRoute

get/v1/networking/connect/routes

List all supported routes with regions for Connect.

Networking

Firewall Rules

networking.firewall_rules

Methods

Create Firewall Rule ->

Operation

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

Create a firewall rule

Firewall Rule Details ->

FirewallRule

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

Get details about a firewall rule

Update Firewall Rule ->

Operation

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

Update a firewall rule

Delete Firewall Rule ->

Operation

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

Delete a firewall rule

List Firewall Rules -> Cursor<

FirewallRule

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

List all firewall rules

Domain types

FirewallRule = { id, created_at, destination_address, 8 more... }

Firewall rule details.

FirewallRuleList = { items, pagination }

Networking

VPCs

networking.vpcs

Methods

Create VPC ->

Operation

post/v1/networking/vpcs

Create a VPC

Get VPC Details ->

VPC

get/v1/networking/vpcs/{vpc_id}

Get details about a VPC

Update VPC ->

Operation

patch/v1/networking/vpcs/{vpc_id}

Update a VPC

path Parameters

vpc_id: string

Response fields

Operation

Request example

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

200Example

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

Delete VPC ->

Operation

delete/v1/networking/vpcs/{vpc_id}

Delete a VPC

List VPCs -> Cursor<

VPC

get/v1/networking/vpcs

List all VPCs

Domain types

Subnet = { id, cidr, created_at, 2 more... }

Subnet of the VPC.

VPC = { id, created_at, firewall_rule_ids, 6 more... }

VPC details.

VPCList = { items, pagination }

Networking VPCs

Availability

networking.vpcs.availability

Methods

Check Create VPC Availability -> string

post/v1/networking/vpcs/availability

Check if a VPC can be created

Check Update VPC Availability -> string

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

Check if a VPC can be updated