Get the authenticated user

List available regions

List workspaces for the authenticated user

Create a workspace (requires full scope)

Get a workspace by slug

Delete a workspace (requires full scope)

Update a workspace (requires full scope)

Inspect a source and preview its template

Deploy an app from a git repository or upload

Delete an app and purge its data

Update an app (name / status / version)

Redeploy an app (refresh code + roll pods)

Create a short-lived SSH session credential for a running container

Run a one-off shell command in a running container (kubernetes exec)

List an app's backups and its backup settings

Turn managed backups on or off and set the daily window

Overwrites the app's current volume contents with the snapshot. There is no undo.

Fetched live from GitHub; empty for apps whose source is not git. current is the branch the app deploys from.

Needs a running, build-backed app whose target image is still in the registry. Restarts every service in the instance, database included.

Credentials are derived, not stored, so they are stable for the volume and need no rotation step. volume is a name from listVolumes.

Read from the running pod's resolved environment at call time, so the container is the source of truth rather than the template. component is a compose service running a database.

List a database component's schemas and tables

Runs over a real protocol driver, not a shell, and executes whatever is sent — including writes and DDL. Redis and MongoDB take their own command syntax rather than SQL.

Reads the repository inside the running container by pod exec, so it is ground truth rather than the deploy record. Returns {ok:false, reason} when the app has no repo, no pod, or no git.

One action per call: discard, stage, unstage, commit, checkout, merge, rebase, revert, cherry, pull or push. Commits live in the container and die with it unless pushed.

With no sha, diffs the working tree. path narrows it to one file. Large patches come back with truncated: true.

Returns one status frame. Sending Accept: text/event-stream instead follows the status live, a frame every five seconds, which never completes on its own.

Returns one metrics reading; network and requestsPerSec are null until a second sample exists, so they are null on a one-shot read. Sending Accept: text/event-stream instead follows usage live, a frame every five seconds, which never completes on its own.

Returns one {ts, deploy} frame: the active deploy if one is running, otherwise the most recent, and deploy is null when the app has never deployed. Sending Accept: text/event-stream instead follows it live, a frame every two seconds, closing after one terminal frame.

Returns one {kind:"snapshot", log, status} frame — the whole log so far, not a delta: the stored log for a finished deploy, the live build pod's log for the in-flight one. Sending Accept: text/event-stream instead re-sends a growing snapshot every two seconds; a finished deploy sends one frame and closes, the in-flight one keeps the connection open after it ends, so close it yourself once a frame carries final: true.

List an app's deploys

List environment variables and credentials for an app

Create a new environment variable or credential

Bulk-create environment variables, skipping keys already set

Delete an environment variable or credential

Update an environment variable or credential value

Reveal the decrypted value of a secret variable

List all domains for an app in a workspace

Create a new domain for an app

Delete a domain from an app

Update a domain configuration

List TLS certificate statuses for app domains

Returns the last 200 log lines of one container as {container, state, logs}; state is no-pod when nothing is running. serviceName is a compose service, or clone / build for an in-flight deploy's init steps. Sending Accept: text/event-stream instead follows the log live as server-sent events, one bare data: frame per line, which never completes on its own.

List all services in an app instance

Trigger a new deployment for an app

List volumes for an app instance

Transfer an app to another workspace

The credentials are derived and expire on their own; access: "write" needs the developer role. Buckets are named <instance id without dashes>-<volume>.

End the caller's S3 session

Get workspace billing info

Change workspace billing tier

List workspace members

List pending workspace invitations

Send workspace invitation

Revoke workspace invitation

Transfer workspace ownership

List all domains in workspace

List storage volumes in workspace

List workspace integrations and provider status

Link GitHub installation to workspace

Disconnect GitHub integration from workspace

Search GitHub repositories

List the authenticated user's API tokens

Create a new API token for the current user

Revoke an API token

Get account billing information including payment methods and invoices

Returns a clientSecret that Stripe's payment element exchanges for a saved card in the browser. The secret alone cannot charge anything or read existing cards, and it is scoped to the caller's own Stripe customer.

Get user billing state (free availability and payment method status)

Get notification preferences for the current user

Update notification preferences for the current user

Read the account's sign-in security state

Update or set the password for the current user

List support tickets for the current user

Create a new support ticket

Get a single support ticket with all messages

Update ticket status or mark as read

Add a message to a support ticket

Confirm a phone number with the code that was sent

Send a verification code to a phone number

Enabling it requires a verified phone number.

Returns one frame. Sending Accept: text/event-stream instead follows the thread live, every 2.5 seconds, which stops only when the ticket disappears.

Returns the slug that would actually be used; suffixed is true when the requested one was taken and a numeric suffix was added.

List all available application templates

List all available service tiers

Get public pricing information for all tiers

Get invitation details by token

Accept a workspace invitation

Decline a workspace invitation