> ## Documentation Index > Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt > Use this file to discover all available pages before exploring further. # API Changelog > Track all changes to the Raff API Updated May 25, 2026 # API Changelog All changes to the Raff public API. Current version: **v1.0.0** (beta). ๐ŸŸข Added ยท ๐Ÿ”ต Updated ยท ๐ŸŸก Deprecated ยท ๐Ÿ”ด Removed ยท ๐ŸŸฃ Fixed *** ## v1.0.0 (Beta) ### May 25, 2026 **Catalog โ€” API** * ๐ŸŸข **Added** โ€” `out_of_stock` field on `VMPricingPlan` โ€” `GET /api/v1/public/pricing/vm`. Marks a plan as sold out. Informational only โ€” the plan is still listed and can be ordered. **Catalog โ€” CLI** * ๐ŸŸข **Added** โ€” `STOCK` column on `raff pricing vm`, showing `In Stock` / `Sold Out`. **Catalog โ€” Terraform** * ๐ŸŸข **Added** โ€” `out_of_stock` attribute on `data.raff_vm_pricing` plans. ### May 14, 2026 **Virtual Machines โ€” API** * ๐Ÿ”ต **Updated** โ€” Backups now run as **incremental backup series** instead of one full image per call. Only changed blocks are stored after the first baseline, cutting storage and transfer dramatically. Existing backups taken before this change keep working unchanged โ€” they restore identically to today. * ๐Ÿ”ต **Updated** โ€” `storage_size` on `Backup` is now **MB** (was GB). Incremental restore points are often a few MB; the previous integer-GB column rounded them up to 1 GB and overstated both display and billing. Existing rows have been backfilled (`old_value_in_GB * 1024`) so customer-visible amounts stay consistent. Clients should display in MB up to 1024, else convert to GB. * ๐ŸŸข **Added** โ€” `increment_id` field on `Backup` โ€” `GET /api/v1/backups`. Position of a restore point within an incremental series; `null` for legacy standalone backups. * ๐ŸŸข **Added** โ€” **Delete backup series** โ€” `DELETE /api/v1/backups/{id}/chain`. Removes every restore point in a series in one call. Use this when [Delete backup](/api-reference/virtual-machines/delete-backup) reports that older points depend on the one being deleted. * ๐ŸŸข **Added** โ€” **Reset backup series** โ€” `POST /api/v1/vms/{id}/backups/reset-chain`. Starts a fresh baseline on the next backup; existing restore points stay restorable. ### May 10, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” `mac` field on `VMNetwork` โ€” `GET /api/v1/vms/{id}/networks`. Stable per-NIC MAC address. The backend already returned it; spec now documents it so generated clients expose it. **Volumes โ€” API** * ๐ŸŸฃ **Fixed** โ€” `pricing_id` now auto-derived from `volume_type` + `region` on `POST /api/v1/volumes`. The public spec never required customers to supply it, but the billing middleware did โ€” every CLI/Terraform/curl request was returning 400 until you looked it up out-of-band. * ๐ŸŸฃ **Fixed** โ€” `filesystem_type` is now honored. A wire-mapping bug in vm-service was discarding the value and validating `volume_type` (e.g. `nvme`) as if it were a filesystem, rejecting all valid `ext4` / `xfs` / `""` combinations with "filesystem\_type must be empty (manual), ext4, or xfs". * ๐Ÿ”ต **Updated** โ€” pricing\_id required-error now points at `raff pricing vm` (CLI) and `data.raff_vm_pricing` (Terraform) alongside the HTTP path. **Billing โ€” API** * ๐ŸŸฃ **Fixed** โ€” Add-payment-method (`POST /api/v1/billing/payment-methods`) now returns 503 if Airwallex's payment-source linking step fails, instead of saving an unusable row that looked like a working primary card. Customers no longer end up with a dashboard-confirmed card that fails the first time the API tries to charge it. * ๐ŸŸฃ **Fixed** โ€” "Payment method not configured for automatic billing" error correctly identifies the affected row (filters by `provider_type` and non-empty source ID) instead of firing on any active payment row. * ๐Ÿ”ต **Updated** โ€” Error messages link to `app.rafftechnologies.com` regardless of environment (was hardcoded to a local-dev hostname). **Virtual Machines โ€” CLI** * ๐ŸŸข **Added** โ€” `raff vm create --no-vpc` โ€” create a VM with only a public IP, no VPC at all. (raff-cli v0.3.5) * ๐ŸŸข **Added** โ€” `MAC` column on `raff vm networks`. (raff-cli v0.3.6) * ๐Ÿ”ต **Updated** โ€” `raff vm create --help` long help spells out all four networking modes (existing VPC / new VPC / no VPC / auto VPC). (raff-cli v0.3.4) * ๐Ÿ”ต **Updated** โ€” `raff vm get` shows base disk and attached volumes as separate rows (was a single collapsed "Storage" row). (raff-cli v0.3.4) * ๐Ÿ”ต **Updated** โ€” `vm networks` public-pool NICs show `(public pool)` instead of an empty `NETWORK` cell. (raff-cli v0.3.4) **Volumes โ€” CLI** * ๐Ÿ”ต **Updated** โ€” `raff volume create --type` help enumerates `nvme` (was a misleading "e.g. standard"). (raff-cli v0.3.3) * ๐Ÿ”ต **Updated** โ€” `raff pricing volume` table view shows the `ID` column. (raff-cli v0.3.3) **Networking โ€” CLI** * ๐Ÿ”ต **Updated** โ€” Security-group attachment count now labeled "Attached VMs" everywhere (was inconsistent โ€” `VMS` in list, `Attached NICs` in get). (raff-cli v0.3.4) * ๐Ÿ”ด **Removed** โ€” Unexplained `SIZE` column from `raff sg get` rules subtable. (raff-cli v0.3.4) **Virtual Machines โ€” Terraform** * ๐ŸŸข **Added** โ€” `data "raff_vm_networks"` โ€” list NICs for a VM with MAC, IP, gateway, and security-group binding. (terraform-provider-raff v0.1.8) * ๐ŸŸข **Added** โ€” `skip_vpc` argument on `raff_vm`. (terraform-provider-raff v0.1.7) * ๐Ÿ”ต **Updated** โ€” `raff_vm` schema descriptions for `vpc_id` / `vpc_name` / `vpc_cidr` / `delete_vpc` / `volume_action` rewritten to spell out the actual contract instead of one-liners. (terraform-provider-raff v0.1.6) * ๐Ÿ”ต **Updated** โ€” `volume_type = "nvme"` in README and Registry index examples (was an invalid `"standard"`). (terraform-provider-raff v0.1.4) **Networking โ€” Terraform** * ๐ŸŸข **Added** โ€” `data "raff_vpc_cidr_suggestions"` โ€” fetch a non-overlapping CIDR for declarative VPC sizing. (terraform-provider-raff v0.1.9) * ๐ŸŸข **Added** โ€” `data "raff_security_group_templates"` โ€” look up template IDs to pass to `raff_security_group.template_id`. (terraform-provider-raff v0.1.9) **Team & Access โ€” Terraform** * ๐ŸŸข **Added** โ€” `data "raff_permissions"` โ€” read-only catalog of permission identifiers; supports `scope` filter (`account` / `project`). (terraform-provider-raff v0.1.9) **Reference โ€” site** * ๐Ÿ”ต **Updated** โ€” Terraform Registry sidebar collapsed from 7 noisy buckets to a single `Virtual Machines` subcategory. (terraform-provider-raff v0.1.5) **Catalog โ€” CLI / Terraform** * ๐ŸŸฃ **Fixed** โ€” `category` filter on `raff template list` (CLI v0.3.7) and `data.raff_templates` (terraform-provider-raff v0.1.10) โ€” flag help, schema description, and README/Registry examples all incorrectly claimed values like `linux` / `windows`. The real enum is `os` (Linux/Windows OS templates) or `marketplace` (pre-baked apps); OS family (`linux` / `windows` / `alpine` / etc.) lives on the `os_type` response field with no API-level filter today. **Virtual Machines โ€” Terraform** * ๐ŸŸฃ **Fixed** โ€” `raff_vm` Create now waits for the VM to reach `active` before returning. Previously `terraform apply` returned as soon as the API accepted the request, so `public_ipv4` / `private_ipv4` were empty until the customer ran `terraform refresh`. Default timeout 15 minutes; override with `timeouts { create = "20m" }`. (terraform-provider-raff v0.1.11) * ๐Ÿ”ต **Updated** โ€” `volume_action` description on `raff_vm` rewritten to clarify it only governs volumes **not** under Terraform management (attached out-of-band via dashboard / CLI). Volumes managed by `raff_volume` in the same config are destroyed by Terraform independently. (terraform-provider-raff v0.1.11) *** **Compute โ€” CLI** * ๐ŸŸข **Added** โ€” `raff volume list|get|create|delete|resize|attach|detach` โ€” documentation page for block storage volume commands. * ๐ŸŸข **Added** โ€” `raff snapshot list|get|create|rename|restore|delete` โ€” documentation page for VM and volume snapshots. * ๐ŸŸข **Added** โ€” `raff backup list|get|create|restore|delete` and `raff backup schedule list|get|create|update|delete` โ€” documentation page for backups and recurring schedules. **Networking โ€” Terraform** * ๐ŸŸข **Added** โ€” `raff_vpc` documentation page โ€” VPC resource, CIDR immutability, gateway computed attrs. * ๐ŸŸข **Added** โ€” `raff_ip` documentation page โ€” floating IP reservation. * ๐ŸŸข **Added** โ€” `raff_security_group` documentation page โ€” firewall rulesets with nested `rule` blocks and template seeding. **Compute โ€” Terraform** * ๐ŸŸข **Added** โ€” `raff_volume`, `raff_snapshot`, `raff_backup`, `raff_backup_schedule` documentation pages โ€” covering immutability rules, retention semantics, and the "don't manage schedule-created backups" guidance. **Team & Access โ€” CLI** * ๐ŸŸข **Added** โ€” `raff ssh-key`, `raff api-key`, `raff member`, `raff role`, `raff permission`, `raff invitation` documentation pages โ€” full coverage of IAM commands. * ๐ŸŸข **Added** โ€” `raff project member` subcommands documented under `raff project` โ€” list, get, add, update, remove. **Team & Access โ€” Terraform** * ๐ŸŸข **Added** โ€” `raff_ssh_key`, `raff_api_key`, `raff_role`, `raff_member`, `raff_project_member` documentation pages โ€” including the `secret` returned-once warning on `raff_api_key` and the composite ID format on `raff_project_member`. **Catalog โ€” CLI / Terraform** * ๐ŸŸข **Added** โ€” `raff region`, `raff template`, `raff pricing` (CLI) and a consolidated `data-sources` page (Terraform) covering `raff_regions`, `raff_templates`, and the `*_pricing` family. **Reference โ€” site** * ๐Ÿ”ต **Updated** โ€” Reference tab CLI and Terraform groups in `docs.json` reorganized to expose every command group and resource in the sidebar. * ๐Ÿ”ต **Updated** โ€” `reference/cli/introduction.mdx` and `reference/terraform/introduction.mdx` refreshed with the full surface โ€” coverage table now lists every resource group instead of the original 5โ€“7. ### May 8, 2026 **Volumes โ€” API** * ๐ŸŸข **Added** โ€” **Volume CRUD + attach/detach** โ€” `GET/POST /api/v1/volumes`, `GET/DELETE /api/v1/volumes/{id}`, `POST /api/v1/volumes/{id}/attach`, `POST /api/v1/volumes/{id}/detach`. Create is async (202 Accepted). * ๐Ÿ”ด **Removed** โ€” `vm_id`, `vm_internal_id`, `image_id`, `attached_volume_id` fields from volume responses (OpenNebula internal identifiers). Use `id` and `product_vm` instead. **Snapshots โ€” API** * ๐ŸŸข **Added** โ€” **Snapshot CRUD + restore + rename** โ€” `GET/POST /api/v1/snapshots`, `GET/DELETE /api/v1/snapshots/{id}`, `POST /api/v1/snapshots/{id}/restore`, `PATCH /api/v1/snapshots/{id}/rename`. Supports VM and volume sources (`resource_type: vm|volume`). `Snapshot.status = active` indicates the source has been reverted to this snapshot. **Backups โ€” API** * ๐ŸŸข **Added** โ€” **Backup CRUD + restore** โ€” `GET/POST /api/v1/backups`, `GET/DELETE /api/v1/backups/{id}`, `POST /api/v1/backups/{id}/restore`. Create and restore are async (202 Accepted). * ๐ŸŸข **Added** โ€” **Backup schedules** โ€” `GET/POST /api/v1/backup-schedules`, `GET/PATCH/DELETE /api/v1/backup-schedules/{id}`. Daily or weekly with configurable retention. * ๐Ÿ”ด **Removed** โ€” `schedule_id`, `backup_id`, `vm_id` from backup/schedule responses (OpenNebula internal identifiers). Use `id` and `product_vm`. **SSH Keys โ€” API** * ๐ŸŸข **Added** โ€” **SSH key CRUD** โ€” `GET/POST /api/v1/ssh-keys`, `GET/PUT/DELETE /api/v1/ssh-keys/{id}`. Account-scoped (no `X-Project-ID` required). **Team & Access โ€” API** * ๐ŸŸข **Added** โ€” **Account Members** โ€” `GET/POST /api/v1/members`, `GET/PATCH/DELETE /api/v1/members/{id}`. Email invite, direct add, or attach an API key as member. * ๐ŸŸข **Added** โ€” **Project Members** โ€” `GET/POST /api/v1/projects/{id}/members`, `GET/PATCH/DELETE /api/v1/projects/{id}/members/{member_id}`. * ๐ŸŸข **Added** โ€” **Roles** โ€” `GET/POST /api/v1/roles`, `GET/PATCH/DELETE /api/v1/roles/{id}`. Custom account- or project-scoped roles. System roles are read-only. * ๐ŸŸข **Added** โ€” **Permissions catalog** โ€” `GET /api/v1/permissions`. Lists every permission string usable in role definitions. Requires a valid API key (no specific permission needed). * ๐ŸŸข **Added** โ€” **API Keys** โ€” `GET/POST /api/v1/api-keys`, `GET/PATCH/DELETE /api/v1/api-keys/{id}`, `POST /api/v1/api-keys/{id}/regenerate`. Full secret only returned once at create or regenerate. * ๐ŸŸข **Added** โ€” **Invitations** โ€” `POST /api/v1/invitations` (account), `POST /api/v1/projects/{id}/invitations` (project), `DELETE /api/v1/invitations/{id}` (cancel). Public spec deliberately omits `Invitation.token` since it's the acceptance secret. **Cross-cutting โ€” wire/spec alignment** * ๐Ÿ”ด **Removed** โ€” `vm_id` from VM responses, `vnet_id` / `vxlan_vni` / `router_vm_id` from VPC responses, `ip_group_id` / `subnet_id` / `vm_id` from floating IP responses, `network_id` / `mac` / `bridge` / `vxlan_vni` from VM network interface responses, and the legacy top-level `project_id` / `project_name` from API key responses. All are OpenNebula internal identifiers that the public spec already hid; the gateway response now matches the spec. ### April 30, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” `skip_public_ip` and `skip_vpc` flags on **Create VM** โ€” `POST /api/v1/vms`. Build VPC-only VMs (no public IP) or public-IP-only VMs (no VPC). Cannot be combined. **Networking โ€” API** * ๐ŸŸข **Added** โ€” **Floating IP reserve/release** โ€” `POST /api/v1/ips/reserve`, `DELETE /api/v1/ips/{id}/reserve`, plus `GET /api/v1/ips`, `GET /api/v1/ips/{id}`, `POST /api/v1/ips/{id}/change`. Reserve runs through the same balance/billing checks as VM create (402 / 403). Release refunds remaining time pro-rata for subscription IPs. * ๐ŸŸข **Added** โ€” **VPC CRUD** โ€” `POST/GET/PUT/DELETE /api/v1/vpcs[/{id}]` and `GET /api/v1/vpcs/cidr-suggestions`. Customers can now create and manage VPCs directly via the public API instead of only through VM creation. * ๐ŸŸข **Added** โ€” `?type=public|vpc|ipv6` query filter on **List VM network interfaces** โ€” `GET /api/v1/vms/{id}/networks?type=public`. * ๐Ÿ”ต **Updated** โ€” `VMNetwork.type` enum now includes `ipv6`. * ๐Ÿ”ด **Removed** โ€” `mac` field from public `VMNetwork` schema (still in raw response for the dashboard, hidden from public API consumers). **Networking โ€” CLI** * ๐ŸŸข **Added** โ€” `raff ip list|get|reserve|release|change` * ๐ŸŸข **Added** โ€” `raff vpc list|get|create|update|delete|cidr-suggestions` * ๐ŸŸข **Added** โ€” `raff vm networks --type public|vpc|ipv6` filter **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” **Update VM note** โ€” `PATCH /api/v1/vms/{id}/notes/{type}` โ€” replaces existing note content; returns 404 if no note exists yet (use `PUT` to create). * ๐ŸŸข **Added** โ€” **Append to VM note** โ€” `POST /api/v1/vms/{id}/notes/{type}/append` โ€” concatenates new content onto the existing note (newline-separated), creates the note if missing. * ๐ŸŸข **Added** โ€” `type` query filter on **Get VM notes** โ€” `GET /api/v1/vms/{id}/notes?type=personal|account` to fetch only one scope. **Virtual Machines โ€” CLI** * ๐ŸŸข **Added** โ€” `raff vm notes update --type X --content Y` (errors if note missing) * ๐ŸŸข **Added** โ€” `raff vm notes append --type X --content Y` * ๐ŸŸข **Added** โ€” `raff vm notes get --type personal|account` filter * ๐ŸŸข **Added** โ€” `raff vm tags list ` to discover tag IDs ### April 29, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” **Hard reboot VM** for unresponsive instances โ€” `POST /api/v1/vms/{id}/reboot-hard` * ๐ŸŸข **Added** โ€” **Save VM disk as custom image** โ€” `POST /api/v1/vms/{id}/save-image` * ๐ŸŸข **Added** โ€” **List VM network interfaces** โ€” `GET /api/v1/vms/{id}/networks` * ๐ŸŸข **Added** โ€” **Attach/detach VM to/from VPC** โ€” `POST/DELETE /api/v1/vms/{id}/vpc[/{nic_id}]` * ๐ŸŸข **Added** โ€” **Attach/detach floating IP** โ€” `POST/DELETE /api/v1/vms/{id}/ip[/{nic_id}]` * ๐ŸŸข **Added** โ€” **Attach/detach security group to VM NIC** โ€” `POST/DELETE /api/v1/vms/{id}/firewall[/{sg_id}/{nic_id}]` * ๐ŸŸข **Added** โ€” **Add/update/remove VM tags** โ€” `POST/PATCH/DELETE /api/v1/vms/{id}/tags[/{tagId}]` * ๐ŸŸข **Added** โ€” **Get/upsert VM notes** (personal + account scopes) โ€” `GET /api/v1/vms/{id}/notes`, `PUT /api/v1/vms/{id}/notes/{type}` * ๐Ÿ”ด **Removed** โ€” `vm_id` field from VM responses (was an OpenNebula internal identifier โ€” use `id` instead) * ๐Ÿ”ต **Updated** โ€” `BillingError.reason` enum trimmed to currently-returned values: `banned`, `failed`, `no_billing_customer`. Insufficient balance now consistently returns `402` with a plain `Error` body. **Virtual Machines โ€” CLI** * ๐ŸŸข **Added** โ€” `raff vm hard-reboot`, `raff vm save-image`, `raff vm networks`, `raff vm vpc attach|detach`, `raff vm ip attach|detach`, `raff vm sg attach|detach`, `raff vm tags add|update|remove`, `raff vm notes get|set` **Virtual Machines โ€” Terraform** * ๐Ÿ”ด **Removed** โ€” `vm_id` computed attribute from `raff_vm` (was the OpenNebula int ID; use `id` instead) ### March 25, 2026 **General** * ๐ŸŸข **Added** โ€” Changelog tracking started ### March 15, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” **Resize VM disk storage** without recreating โ€” `POST /api/v1/vms/{id}/disk/resize` * ๐ŸŸข **Added** โ€” **Bulk delete VMs** in a single request โ€” `DELETE /api/v1/vms/bulk` * ๐Ÿ”ต **Updated** โ€” **Create VM** now accepts `enable_ipv6` parameter for IPv6 support โ€” `POST /api/v1/vms` ### March 10, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” **Reinstall OS** on a running VM, keep your IP โ€” `POST /api/v1/vms/{id}/reinstall` * ๐ŸŸข **Added** โ€” **Factory reset** VM to original state โ€” `POST /api/v1/vms/{id}/factory-reset` * ๐ŸŸข **Added** โ€” **Reset root password** via API โ€” `POST /api/v1/vms/{id}/reset-password` * ๐ŸŸข **Added** โ€” **Rename VMs** after creation โ€” `POST /api/v1/vms/{id}/rename` ### March 5, 2026 **Volumes โ€” API** * ๐ŸŸข **Added** โ€” **Resize block storage volumes** attached to VMs โ€” `PATCH /api/v1/volumes/{id}` ### March 3, 2026 **Projects โ€” API** * ๐ŸŸข **Added** โ€” **Organize resources into projects** โ€” full CRUD via API * `GET /api/v1/projects` ยท `POST /api/v1/projects` ยท `GET /api/v1/projects/{id}` ยท `PUT /api/v1/projects/{id}` ยท `DELETE /api/v1/projects/{id}` ### March 1, 2026 **Virtual Machines โ€” API** * ๐ŸŸข **Added** โ€” **Full VM lifecycle** โ€” create, list, get details, delete * `GET /api/v1/vms` ยท `POST /api/v1/vms` ยท `GET /api/v1/vms/{id}` ยท `DELETE /api/v1/vms/{id}` * ๐ŸŸข **Added** โ€” **VM power control** โ€” start, stop, reboot * `POST /api/v1/vms/{id}/start` ยท `POST /api/v1/vms/{id}/stop` ยท `POST /api/v1/vms/{id}/reboot` * ๐ŸŸข **Added** โ€” **Scale resources** โ€” resize CPU and RAM on demand โ€” `POST /api/v1/vms/{id}/resize` **Catalog โ€” API** * ๐ŸŸข **Added** โ€” **Browse available resources** โ€” regions, OS templates, pricing (no auth required) * `GET /api/v1/public/regions` ยท `GET /api/v1/public/templates` * `GET /api/v1/public/pricing/vm` ยท `/volume` ยท `/snapshot` ยท `/backup` ยท `/ip`