API & Automation
CloudRaya provides a REST API so you can automate platform operations and integrate CloudRaya into your own applications, scripts, and internal tools instead of relying only on the Control Panel.
This page explains what the API is for and how authentication works at a high level. For the full list of endpoints, request/response formats, and code samples, see the CloudRaya API Reference.
What You Can Do With the API
With the CloudRaya API, you can:
- Automate routine platform operations (provisioning, resizing, scheduling) instead of clicking through the panel
- Connect CloudRaya to your internal tools, dashboards, or customer portals
- Retrieve resource status, usage, and billing information programmatically
- Build custom provisioning and reporting workflows on top of CloudRaya
Services Covered
The API is organized per service, each with its own base URL under api-v2.cloudraya.com:
| Service | Covers |
|---|---|
| Core | Accounts, authentication, projects, members, roles, SSH keys, and quotas |
| Virtual Machine | Provisioning, resizing, power actions, snapshots, and scheduling |
| Network | Public and private IPs, VPCs, subnets, load balancers, ACLs, VPN, and firewalls |
| Block Storage | Volumes, snapshots, scheduled backups, and machine templates |
| Object Storage | S3-compatible buckets, folders, access keys, and regions |
| Kubernetes | Managed clusters, node pools, versions, and kubeconfig |
| Container Registry | Private registries, repositories, artifacts, and robot accounts |
| Product & Pricing | Product catalog, price books, regions, and per-user resource usage |
| Wallet & Billing | Balance, top-ups, invoices, coupons, transactions, and billing history |
| Notification | Broadcast notifications, categories, and e-mail templates |
Authentication
The API authenticates every request with a bearer token, not a separate API key.
- Exchange your CloudRaya account e-mail and password for a token by calling the login endpoint on the Core service
- Send that token on every other request as an
Authorization: Bearer <token>header, it works across every service, not just the one that issued it - The token expires after a limited time (currently around two hours); once it does, the API
returns
401 Unauthorizedand you log in again for a new one
There is no separate API key to generate or manage, and no HTTP Basic authentication, your account credentials are only ever sent to the login call itself. Since a token grants full access to your CloudRaya resources, never embed your credentials or tokens in client-side code or commit them to source control, and always call the API over HTTPS.
📄 See: the Reference's own Authentication page for the exact request and response format.
Response Format
Every response shares a common envelope with a code, a human-readable message, and a data
payload whose shape depends on the endpoint. Error responses and status codes are documented on
the Reference's Errors page.
Learn More
📄 CloudRaya API Reference: the full list of endpoints, parameters, and request/response examples, generated from the official Postman collections