Dashboard overview
The Apso dashboard is the visual workspace for building and operating services. Open app.apso.cloud , select a workspace, then select a service.
Workspace navigation
The main navigation keeps workspace-level work separate from each backend:
| Area | Use it for |
|---|---|
| Services | Create a backend and return to existing services |
| Team | Manage people who can access the workspace |
| Billing | Review the workspace plan and billing details |
| Settings | Update workspace configuration |
Create a service
- Open Services and click New service.
- Start with a blank schema, describe the backend you need, or select a starter backend.
- Review the proposed entities and relationships in the editor.
- Save the schema.
- Deploy when the model is ready.
The editor writes the same data model represented by .apsorc. Use the visual workflow when you want fast schema iteration. Use the CLI when you want the schema and generated service in a local repository.
Service navigation
A deployed hosted service can expose these views:
| View | What you can do |
|---|---|
| Dashboard | Copy the API URL and review service and database metrics |
| Deployments | Follow build and deployment status |
| Editor | Change entities, fields, and relationships |
| Data | Inspect and work with service records |
| API Keys | Create credentials for server-side clients |
| Environment | Manage service environment variables |
| Docs | Open the API reference generated for the service |
| Logs | Search, filter, refresh, and export runtime logs |
The available tabs depend on the service state and hosting plan. Deploy the service before expecting live URLs, metrics, or logs.
The service header
The header shows the service name, deployment state, hosting type, and repository sync state. From here you can open settings, begin a deployment, connect GitHub, or push an updated generated codebase to the connected branch.
Treat deployment and repository sync as separate states. A service can be deployed while the latest editor changes are still waiting to be pushed to GitHub.
Common workflows
Change the data model
- Open Editor.
- Add or update an entity, field, or relationship.
- Review the schema change before saving it.
- Deploy the updated service.
- Open Deployments, then test the generated API in Docs.
Connect an application
- Copy the deployed URL from Dashboard.
- Create an API key in API Keys for a trusted server environment.
- Put both values in your application’s server-side environment file.
- Use
@apso/sdkor the generated REST API from your backend-for-frontend.
Do not expose an Apso API key in browser JavaScript or a public mobile bundle.
Investigate a failed request
- Confirm the service is deployed on Dashboard.
- Open Logs and select a useful time range.
- Filter by level or source, then search for the route or error text.
- Compare the request with the generated API reference in Docs.
- After a code or schema change, follow the next build in Deployments.