Zum Inhalt springen
NimbusNexus

Network ports

A network port is the connection point between a network and something that uses it — a VM, a load balancer, a router. Most users don't manage ports directly; they create a VM with a network attachment and the port gets created behind the scenes. The API surface here is for the cases where you do need direct control: pre-allocating a port + IP before launching a VM, attaching a load balancer to a specific known IP, or migrating a service IP between hosts.

Ports carry a MAC address, one or more IP addresses on the parent subnet, and optional security groups applied to filter ingress and egress. They're stateful — a port persists if you delete the VM it was attached to, ready to be re-attached to a replacement VM.

What's next

Reference

GET/api/v1/portal/port/

List Ports

Lists network ports owned by the project.

Parameters

NameInRequiredDescription
admin_domainqueryno—
admin_projectqueryno—
namequerynoPort name
network_idquerynoNetwork ID filter
admin_state_upquerynoAdministrative state of the port
device_idquerynoDevice ID (server UUID) attached to the port
device_ownerquerynoDevice owner of the port
qos_policy_idquerynoQoS policy ID
project_idquerynoProject ID
mac_addressquerynoMAC address
port_security_enabledquerynoPort security enabled
security_groupsquerynoSecurity group IDs
binding_vnic_typequerynoVNIC type binding
descriptionquerynoPort description
statusquerynoPort status filter

Responses

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

https://api.nimbusnexus.net/api/v1/portal/port/

POST/api/v1/portal/port/

Create Port

Creates a network port, optionally attached to a server, and embeds billing metadata in its description.

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/portal/port/

GET/api/v1/portal/port/artifacts

Port Artifacts

Returns subnets and QoS policies usable when creating a port.

Parameters

NameInRequiredDescription
product_type_namequeryno—

Responses

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

https://api.nimbusnexus.net/api/v1/portal/port/artifacts

GET/api/v1/portal/port/{port_id}

Get Port

Returns the details of a single network port by ID.

Parameters

NameInRequiredDescription
port_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/portal/port/{port_id}

PUT/api/v1/portal/port/{port_id}

Update Port

Updates the mutable attributes of an existing network port.

Parameters

NameInRequiredDescription
port_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/portal/port/{port_id}

DELETE/api/v1/portal/port/{port_id}

Delete Port

Deletes a network port by ID, rejecting the request if the port is still in use.

Parameters

NameInRequiredDescription
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/portal/port/{port_id}

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