Manage your workspaces
Everything you do in your dashboard, from your own backend.
With the same key, your backend reaches every page of your dashboard: your
workspaces, their server, network, backups, invoices and support tickets. Each
call works on your own account only; another account's workspace answers 404.
These calls live next to /v1 under the same base URL, https://dash.geta.team/api.
A successful answer carries "success": true; a refusal from the call itself is
{ "success": false, "error": "a readable message" }, while a refusal from the key
check keeps its code (Errors).
curl https://dash.geta.team/api/saas-byok/instances \
-H "Authorization: Bearer gat_sk_..."A read-only key makes the GET calls; every other call needs a read and write
key. Fields, answers and errors of each call: the interactive reference.
Workspaces
| Call | What it does |
|---|---|
GET /saas-byok/instances | Your workspaces, then the deleted ones you can still restore |
GET /saas-byok/instances/{id}/details | One workspace |
POST /saas-byok/instances/{id}/credentials | Its address, administrator email and password |
GET /saas-byok/pricing | Plans and prices |
PUT /saas-byok/instances/{id}/plan | Change its plan, { "employees": 3 }: up at once (prorated), down at the next renewal |
POST /saas-byok/instances/{id}/cancel | Cancel its subscription at the end of the period paid |
POST /saas-byok/instances/{id}/resume | Keep it after all |
DELETE /saas-byok/instances/{id} | Delete the workspace |
Server
| Call | What it does |
|---|---|
POST /saas-byok/instances/{id}/restart | Restart the app (quick, safe) |
POST /saas-byok/instances/{id}/update | Install the latest version, then restart |
POST /saas-byok/instances/{id}/reset | Reset the server |
POST /saas-byok/instances/{id}/power-off | Power off (still billed) |
POST /saas-byok/instances/{id}/power-on | Power on |
POST /saas-byok/instances/{id}/redeploy | Ask for the server again, for a workspace in error |
Network and SSH
| Call | What it does |
|---|---|
GET, POST /saas-byok/instances/{id}/firewall | Read, or replace, the firewall rules |
POST /saas-byok/instances/{id}/firewall/enable, /disable | Turn the firewall on or off |
GET, POST /saas-byok/instances/{id}/domains | List, or add, custom domains |
POST /saas-byok/instances/{id}/domains/remove | Remove a custom domain |
GET, POST /saas-byok/instances/{id}/ptr | Read, or set, the reverse DNS |
GET, POST /saas-byok/instances/{id}/ssh-keys | List, or add, SSH keys |
DELETE /saas-byok/instances/{id}/ssh-keys/{name} | Remove an SSH key |
Backups
| Call | What it does |
|---|---|
GET /saas-byok/instances/{id}/backups | The daily backups, newest first |
POST /saas-byok/instances/{id}/backups | Back up now |
POST /saas-byok/instances/{id}/backups/restore | Restore one (overwrites the current data) |
Billing and support
| Call | What it does |
|---|---|
GET /saas/invoices | Your invoices, with their PDF |
GET /saas/upcoming-invoices | What each workspace will be charged at its renewal |
GET, POST /saas/support/tickets | Your tickets, or open one |
GET /saas/support/tickets/{ticketId} | A ticket and its replies |
POST /saas/support/tickets/{ticketId}/replies | Reply |
POST /saas/support/tickets/{ticketId}/resolve | Close it |
What stays in the dashboard
For your safety, a key never reaches: signing in and two-factor authentication,
the API keys and the webhook themselves, the account's email and closing the
account. These answer 403 not_available_with_api_key.