Cloady

List all domains for an app in a workspace

listAppDomains

List all domains in workspace Every custom domain the workspace's applications serve, and every domain registered through Cloady, with its renewal details, whether or not an application serves it.

listWorkspaceDomains

List all services in an app instance

getAppServices

List an app's backups and its backup settings

listBackups

List an app's deploys

listDeploys

List an app's volumes and service filesystems

listVolumes

List available regions

listRegions

List the git branches available to an app Fetched live from GitHub; empty for apps whose source is not git. `current` is the branch the app deploys from.

listBranches

List workspaces for the authenticated user

listWorkspaces

Merge a Git branch Merge the named branch into the current one, as a merge commit unless it fast-forwards. Refused while another merge, rebase, revert or cherry-pick is in progress. If the merge fails, it is aborted, the call fails, and the error carries git's report. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

mergeGitBranch

Pull Git changes Fetch the current branch's upstream and fast-forward to it. Fails when the branches have diverged or uncommitted changes would be overwritten. A GitHub remote is read with the workspace's GitHub App installation; any other host is read without credentials. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

pullGitChanges

Read a container's recent logs 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. 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.

readServiceLogs

Read a deploy's build log 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`.

streamDeployLogs

Read a patch from a development app's repository With no `sha`, diffs the working tree. `path` narrows it to one file. Large patches come back with `truncated: true`.

getGitDiff

Read an app's CPU, memory, disk and network usage 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.

streamAppMetrics

Read app status Read an app's live status: per-service state, capacity waits, in-flight deploy. 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.

streamAppStatus

Read the active deploy Read the app's in-flight deploy, or its latest when none is running. 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.

streamActiveDeploy

Read the git working tree Read the working tree of a development app: branch, changes and recent commits. 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.

getGitOverview

Rebase onto a Git branch Replay the current branch's own commits on top of the named branch, rewriting them. Refused while another merge, rebase, revert or cherry-pick is in progress. If the rebase fails, it is aborted, the call fails, and the error carries git's report. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

rebaseGitBranch

Revert a Git commit Add a new commit that undoes the given commit. Refused while another merge, rebase, revert or cherry-pick is in progress. If the revert fails, it is aborted and the call fails. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

revertGitCommit

Search templates Search, filter, sort and page the template catalog. Public: no token needed. `total` counts every match, and `categories` counts the matches in each category with every other filter applied. Omit `limit` for every match.

listTemplates

Stage Git files Add the current contents of the given paths to the index, ready for the next commit. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

stageGitFiles

Unstage Git files Take the given paths out of the index; their changes stay in the working tree. Works only on a development app: any other app answers 403 `read_only`. Runs git in the app's running container and returns its output.

unstageGitFiles

Update a domain configuration

updateDomain