REST API

Base URL https://api.cloud.enzonic.com. All endpoints require a bearer token. JSON in, JSON out.

An interactive OpenAPI reference (Swagger UI) is served by the backend at /docs, and the machine-readable spec at /openapi.json.

Conventions

  • Authentication: Authorization: Bearer <token> on every request.
  • Request bodies are JSON; set Content-Type: application/json.
  • Errors use a consistent envelope — see /docs/errors.
  • Rate limit: 240 requests/minute per client.

Endpoints

MethodPathDescription
GET/v1/healthLiveness + instance count
GET/v1/accountCurrent account & balance
GET/v1/account/transactionsCredit ledger
GET/v1/account/budgetBudget status
PUT/v1/account/budgetUpdate budget cap
GET/v1/account/logsActivity log
GET/v1/keysList your API keys
POST/v1/keysCreate an API key (secret once)
DELETE/v1/keys/:idRevoke an API key
GET/v1/regionsRegion availability
GET/v1/instancesDeployable instances
GET/v1/eggsList eggs across instances
GET/v1/eggs/:instanceId/:eggIdEgg detail + variables
GET/v1/serversList your servers
POST/v1/serversDeploy a server
GET/v1/servers/:idGet a server
PATCH/v1/servers/:idResize a server
DELETE/v1/servers/:idDelete a server
POST/v1/servers/:id/powerPower signal
GET/v1/servers/:id/resourcesLive usage
POST/v1/servers/:id/commandSend console command
GET/v1/servers/:id/consoleWebsocket credentials
GET/v1/servers/:id/filesList files
GET/v1/servers/:id/files/contentsRead a file
POST/v1/servers/:id/files/writeWrite a file
GET/v1/servers/:id/files/downloadSigned download URL
POST/v1/servers/:id/files/deleteDelete files
GET/v1/billing/configBilling config
POST/v1/billing/checkoutStart top-up checkout
GET/v1/invoicesList invoices
GET/v1/invoices/:idOne invoice
GET/v1/admin/instances[admin] List instances
POST/v1/admin/instances[admin] Add instance
PATCH/v1/admin/instances/:id[admin] Update instance
DELETE/v1/admin/instances/:id[admin] Delete instance
POST/v1/admin/instances/:id/test[admin] Test connectivity
GET/v1/admin/settings[admin] Get settings
PUT/v1/admin/settings[admin] Update settings
GET/v1/admin/users[admin] List accounts
POST/v1/admin/users/:id/credits[admin] Grant/deduct credits
GET/v1/admin/servers[admin] List all servers
GET/v1/admin/logs[admin] Platform audit log

Example

bash
curl -X POST https://api.cloud.enzonic.com/v1/servers \
  -H "Authorization: Bearer $CLOUD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"smp","eggId":3,"region":"USA","ramMb":2048,"cpuPercent":200,"diskMb":10240}'
REST API | Enzonic Cloud API