Skip to main content
The Storiza API is a JSON REST API. Everything in this reference can be called with an API key; the catalog endpoints (plans, templates, datacenters, currencies) need no key at all.
Base URL

​
Authenticate

Send your key as a bearer token on every request:
Each endpoint page lists the permission the key needs, such as vps:read or apps:write. Reading needs :read; anything that changes something needs :write. See Permissions.

​
Try it here

Every endpoint page has a playground. Paste your key into the Authorization field, fill in the parameters and press Send — the request goes to the live API with your key, so it acts on your real account.
Requests sent from the playground are real. Creating, deleting or paying for something here does exactly that.

​
Conventions

Responses and errors

Every answer has the same envelope; every error has a stable code.

Pagination and filtering

_page, _limit, _search, _sort_by on every list endpoint.

Billing and payments

Paying from your balance versus ordering through a checkout.

Consoles and live streams

Terminals, app output and live editing over WebSockets.

​
IDs

Resources are identified by UUIDs, such as 0234c235-ee24-40ce-a8bc-b0f944484a6a. Some paths call a server’s id vmId, vpsId or id — they are all the same server id.