Cloudie Public API
The public, token-authenticated REST API for Cloudie, SkylonHost's cloud VPS control panel. It lets customers automate the full VM lifecycle — deploy, power, destroy, snapshot, rDNS — plus SSH-key and billing lookups.
Authentication
Every authenticated endpoint requires a per-user API key sent as a bearer token:
Authorization: Bearer <72-character token>
Create and manage keys from the panel under Account → API Keys. A key's plaintext token is shown exactly once at creation and is never retrievable again. The API never authenticates via the session cookie, so ambient browser cookies can never drive it (this is why the API is CSRF-exempt). Send keys over HTTPS only.
The catalogue endpoints (/locations, /plans, /os) are unauthenticated
so a client can discover what it can deploy before it holds a key.
Scopes
Keys are scoped as resource:action. Resources are instance, billing,
snapshot, and ssh; actions are read and write. A resource:write
scope implies resource:read, and the all scope grants everything. rDNS
lives under the instance resource. A key that lacks the scope an endpoint
requires gets 403 insufficient_scope. There is no staff bypass: a key only
ever reaches its own owner's resources.
Asynchronous operations
Provisioning-style actions (create/destroy/power an instance, create a
snapshot) are queued and return 202 Accepted immediately with the
resource's UUID and a transitional status. Poll the corresponding GET
endpoint to observe the resource reaching its final state.
Ownership & errors
Resources are always resolved with a query scoped to the calling key's owner.
A resource that does not exist — or is not yours — returns 404 not_found;
the API never distinguishes "not found" from "not yours". All responses,
including errors, are application/json.
Authentication
- HTTP: Bearer Auth
A per-user API key sent as Authorization: Bearer <token>. The scopes listed on each operation's security requirement indicate the scope the key must carry; write scopes imply their matching read scope, and the all scope satisfies any requirement.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Contact SkylonHost Support:
License