Overview
The Xloud Compute API provides programmatic control over virtual machine instances, flavors, keypairs, availability zones, server groups, and hypervisor resources. The API follows RESTful conventions with JSON request and response bodies.Prerequisites
- A valid project-scoped token from the Identity API
- Base URL:
https://api.<your-domain>/compute/v2.1 - Minimum API microversion:
2.1
API Versioning (Microversions)
The Compute API uses microversions to add new capabilities without breaking existing clients. Specify the desired microversion in theX-OpenStack-Nova-Microversion header:
Request with specific microversion
Query supported microversions
Key Endpoints
Create an Instance
Instance Actions
Perform operations on a running instance via the/action endpoint:
- Reboot
- Stop / Start
- Resize
- Snapshot
Soft reboot (graceful OS restart)
Hard reboot (power cycle)
List Instances with Filtering
List all running instances
List instances with full details
List instances across all projects (admin)
Error Reference
Next Steps
Storage API
Attach volumes and manage snapshots via the Storage API
Networking API
Create networks and assign floating IPs for your instances
Authentication
Manage tokens and application credentials
Automation
Automate instance lifecycle with scripts and SDKs