Geta.Team Geta.Team
API

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

CallWhat it does
GET /saas-byok/instancesYour workspaces, then the deleted ones you can still restore
GET /saas-byok/instances/{id}/detailsOne workspace
POST /saas-byok/instances/{id}/credentialsIts address, administrator email and password
GET /saas-byok/pricingPlans and prices
PUT /saas-byok/instances/{id}/planChange its plan, { "employees": 3 }: up at once (prorated), down at the next renewal
POST /saas-byok/instances/{id}/cancelCancel its subscription at the end of the period paid
POST /saas-byok/instances/{id}/resumeKeep it after all
DELETE /saas-byok/instances/{id}Delete the workspace

Server

CallWhat it does
POST /saas-byok/instances/{id}/restartRestart the app (quick, safe)
POST /saas-byok/instances/{id}/updateInstall the latest version, then restart
POST /saas-byok/instances/{id}/resetReset the server
POST /saas-byok/instances/{id}/power-offPower off (still billed)
POST /saas-byok/instances/{id}/power-onPower on
POST /saas-byok/instances/{id}/redeployAsk for the server again, for a workspace in error

Network and SSH

CallWhat it does
GET, POST /saas-byok/instances/{id}/firewallRead, or replace, the firewall rules
POST /saas-byok/instances/{id}/firewall/enable, /disableTurn the firewall on or off
GET, POST /saas-byok/instances/{id}/domainsList, or add, custom domains
POST /saas-byok/instances/{id}/domains/removeRemove a custom domain
GET, POST /saas-byok/instances/{id}/ptrRead, or set, the reverse DNS
GET, POST /saas-byok/instances/{id}/ssh-keysList, or add, SSH keys
DELETE /saas-byok/instances/{id}/ssh-keys/{name}Remove an SSH key

Backups

CallWhat it does
GET /saas-byok/instances/{id}/backupsThe daily backups, newest first
POST /saas-byok/instances/{id}/backupsBack up now
POST /saas-byok/instances/{id}/backups/restoreRestore one (overwrites the current data)

Billing and support

CallWhat it does
GET /saas/invoicesYour invoices, with their PDF
GET /saas/upcoming-invoicesWhat each workspace will be charged at its renewal
GET, POST /saas/support/ticketsYour tickets, or open one
GET /saas/support/tickets/{ticketId}A ticket and its replies
POST /saas/support/tickets/{ticketId}/repliesReply
POST /saas/support/tickets/{ticketId}/resolveClose 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.

On this page