RArafftechnologies
Networking

Attach floating IP to VM

Changed on

Attach a floating public IP to a virtual machine. Pick one of two modes:

Option A — attach a reserved IP (use ip_id)

Pass ip_id set to a previously reserved IP (from POST /api/v1/ips/reserve or GET /api/v1/ips?reserved=true). The IP must:

  • belong to the same account
  • not be currently attached to another VM
  • have reserved: true

No new billing on attach — you're already paying for the reserved IP.

A VM can hold up to 4 public IPv4 addresses. The first IPv4 on a VM becomes its primary address; additional IPv4s must be reserved IPs attached with ip_id.

Option B — auto-assign a new IP (use type)

Leave ip_id empty and pass type to allocate a fresh IP from the pool:

  • type: IPv4 (default if omitted)
  • type: IPv6

Auto-assign is available only while the VM has no public IP of that family, and the IP is included with the VM at no extra charge. It is not reserved: detaching releases it back to the shared pool.

Notes

  • Auto-assign (type) fails if the VM already has a public IP of the same family — attach a reserved IP (ip_id) to add more IPv4s, up to 4 total.
  • Optionally pass security_groups (UUID array) to apply security groups to the new NIC.
post/api/v1/vms/{id}/ip

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/vms/{id}/ip
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

VM ID (UUID)

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Request body

ip_idstring uuid

ID of a previously reserved IP. The IP must belong to the same account, be reserved, and not already attached to another VM. No new billing on attach — you're already paying for the reserved IP. Use this to add up to 4 public IPv4 addresses to a VM.

type'IPv4' | 'IPv6'

IP family to auto-allocate. Used only when ip_id is omitted. Defaults to IPv4. Available only while the VM has no public IP of that family; the IP is included with the VM at no extra charge and is released back to the pool on detach.

security_groupsstring[]

Security group IDs (UUIDs) to apply to the new NIC.

Response

IP attached

successboolean required
messagestring

Example response

{
  "success": true
}

Changes