API Reference

REST API overview

Every portal action is available via the Simplewala REST API. Automate provisioning, deployments, and configuration from your CI/CD pipeline.

Base URL

https://app.simplewala.com/api

Authentication

The API uses session-based authentication. All requests must include a valid session cookie obtained by logging in via the portal. API key support is on the roadmap.

Response format

All responses are JSON. Successful responses include a data field. Errors include an error string.

{
  "data": { ... }
}

// Error
{
  "error": "Server not found"
}

Rate limiting

API requests are rate-limited to 120 requests per minute per session. Exceeding this returns HTTP 429.

Key endpoints

Method	Path	Description
GET	/portal/api/servers	List all servers
POST	/portal/api/orders	Create a new server order
GET	/portal/api/servers/:slug	Get server details
GET	/portal/api/servers/:slug/apps	List deployed apps
POST	/portal/api/servers/:slug/apps	Install a new app (WordPress, Node.js, etc.)
GET	/portal/api/servers/:slug/databases	List databases
POST	/portal/api/servers/:slug/databases	Install a database (mysql, postgres, redis, etc.)
GET	/portal/api/servers/:slug/git-apps	List Git App deployments
POST	/portal/api/servers/:slug/git-apps	Create a Git App
POST	/portal/api/servers/:slug/git-apps/:id/deploy	Trigger a manual deploy
GET	/portal/api/servers/:slug/email	Get mail server status
GET	/portal/api/servers/:slug/volumes	List storage volumes
GET	/portal/api/servers/:slug/backups	List backups
POST	/portal/api/servers/:slug/backups	Trigger a backup
GET	/portal/api/servers/:slug/routes	List Front Door routes
GET	/portal/api/servers/:slug/commands/:id/output	Get command output / build log

OpenAPI spec

A machine-readable OpenAPI specification is available at:

GET https://app.simplewala.com/openapi.json

For questions about the API, contact support.