API quickstart: first request in 30 seconds

Orvoxa’s REST API covers everything the portal does. OpenAPI 3.1 spec, JSON over HTTPS, bearer-token auth.

1. Get a token

See Generate and rotate API keys. Give it minimum needed scopes.

2. First request

curl https://api.orvoxa.com/v1/account \
  -H "Authorization: Bearer $TOKEN"

Returns your account profile as JSON. If this works, everything else will.

3. List VMs

curl https://api.orvoxa.com/v1/vms \
  -H "Authorization: Bearer $TOKEN"

4. Deploy a VM

curl -X POST https://api.orvoxa.com/v1/vms \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"region":"fra1","image":"ubuntu-24-04","plan":"cloud-s"}'

OpenAPI spec

Full spec: https://api.orvoxa.com/v1/openapi.json. Generate a client in any language.