Saltar al contenido
NimbusNexus

Networks

A network is a virtual L2 broadcast domain inside a region. VMs and load balancers don't attach to the internet directly — they attach to a subnet, which lives inside a network, which is what this resource describes.

Two flavors

FlavorCreated byRoutable to internetUsed for
ExternalAuto-provisioned per region; sharedYes (via floating IPs)The default uplink for most workloads
TenantYou, inside the projectNo directly — needs a routerPrivate VPC, multi-tier apps, internal-only services

The external network in each region (id pattern: net_external_us_east_1) is shared across all projects in that region but isolated at the security-group / VLAN level. Tenant networks are fully private and only visible inside your project.

Why you'd create a tenant network

  • Multi-tier architecture. Frontend VMs on a public-facing subnet; backend / DB VMs on a private subnet. The two sides talk over the tenant network without ever touching the public internet.
  • Multiple isolated environments in one region. prod / staging / dev on three separate tenant networks; no accidental cross-talk.
  • Compliance. Some workloads require private addressing for everything except a documented egress path. A tenant network + router lets you build that path explicitly.

For simple single-VM setups, just attach to the external network and skip tenant networks entirely.

MTU and IPv6

Networks default to MTU 1500 (Ethernet standard). You can request a jumbo-frame network (MTU 9000) at creation time for high-throughput VM-to-VM workloads in the same network — beware that some external CDNs / partners don't negotiate jumbo frames cleanly.

IPv6 is enabled by setting the network's IP version to dual or ipv6 (default ipv4). The subnets carved out of an IPv6-enabled network can be either v4 or v6 (mixed within one network is supported).

What's next

  • Subnets — IP-address blocks carved out of a network.
  • Routers — connect tenant networks to the external gateway.
  • Security groups — firewall rules applied to interfaces inside a network.
  • Load balancers — distribute traffic across VMs in a network.

Reference

GET/api/v1/network/

List Networks

Lists virtual networks owned by the project, optionally including shared public networks.

Parameters

NameInRequiredDescription
admin_domainqueryno—
admin_projectqueryno—
namequeryno—
descriptionqueryno—
admin_state_upqueryno—
sharedqueryno—
statusqueryno—
router_externalqueryno—
include_publicqueryno—
scope_current_projectqueryno—

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 422Validation Error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/

POST/api/v1/network/

Create Network

Creates a virtual network in the scoped project.

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/

GET/api/v1/network/artifacts

Network Artifacts

Returns the availability zones and QoS policies usable when creating a network.

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/artifacts

GET/api/v1/network/{network_id}

Get Network

Returns the details of a single virtual network by ID.

Parameters

NameInRequiredDescription
network_idpathyes—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/{network_id}

PUT/api/v1/network/{network_id}

Update Network

Updates the mutable attributes of an existing virtual network.

Parameters

NameInRequiredDescription
network_idpathyes—

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/{network_id}

DELETE/api/v1/network/{network_id}

Delete Network

Deletes a virtual network by ID.

Parameters

NameInRequiredDescription
network_idpathyes—

Responses

  • 204Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation Error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/network/{network_id}

Need to make a real call? Try these endpoints in the live Swagger UI →