Skip to content
NimbusNexus

VM interfaces

A VM interface is a network attachment on a VM — the binding between the VM and one of its network ports. Most VMs are fine with the default interface created at launch; you only manage interfaces directly when you need to attach a VM to multiple networks (e.g. dual-homed services, blue/green network swings).

Attaching an interface is hot — the VM doesn't reboot. The kernel sees the new NIC immediately; you may need to bring it up (ip link set <name> up) and configure addressing manually unless the image's cloud-init handles it.

Detaching is also hot. Sockets bound to the detached interface drop; sockets on other interfaces are unaffected.

What's next

Reference

GET/api/v1/instance/{server_id}/interfaces/

List Interfaces

List network interfaces currently attached to a virtual machine instance.

Parameters

NameInRequiredDescription
server_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/instance/{server_id}/interfaces/

POST/api/v1/instance/{server_id}/interfaces/

Attach Interface

Attach a new network interface (port) to a virtual machine instance.

Parameters

NameInRequiredDescription
server_idpathyes—

Request body

JSON body required.

Responses

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

https://api.nimbusnexus.net/api/v1/instance/{server_id}/interfaces/

GET/api/v1/instance/{server_id}/interfaces/artifacts

Interface Artifacts

Return reference data needed to attach a new interface (available networks, subnets and ports for the instance).

Parameters

NameInRequiredDescription
server_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/instance/{server_id}/interfaces/artifacts

DELETE/api/v1/instance/{server_id}/interfaces/{port_id}

Detach Interface

Detach a network interface (port) from a virtual machine instance.

Parameters

NameInRequiredDescription
server_idpathyes—
port_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/instance/{server_id}/interfaces/{port_id}

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