Skip to Content
MCP

Tools

Every tool the A-Line.cloud MCP server offers, with its scope and arguments.

Each tool acts as you, only in the organizations you granted the connection, and only inside the environments and scopes you chose. Text that comes from your resources (names, logs, build output) is returned as untrusted text with credentials redacted.

Tools that are not always listed are found with search_tools and run with call_tool.

Read tools

whoami

Who am I. Which A-Line.cloud environment and account this server is: environment, issuer, API base, the signed-in user, the organizations granted to this connection with their roles, scopes and environments, and admin mode. Call it first when unsure which A-Line.cloud server to use.

Scope: none, always listed.

No arguments.

list_orgs

List organizations. The organizations granted to this connection (id, handle, name, role, scopes, environments, grant expiry), and the console link to grant more. Pass a handle or id from here as org.

Scope: none, always listed.

No arguments.

search_tools

Search tools. Searches the tools this connection may call that tools/list does not show. Returns name and summary; then call describe_tool for the schema and call_tool to run one.

Scope: none, always listed.

Arguments:

  • query (string, required): Keywords, e.g. build log or domains.

describe_tool

Describe a tool. The title, description, input schema and scope of a tool found with search_tools.

Scope: none, always listed.

Arguments:

  • name (string, required): The tool name.

call_tool

Call a tool. Runs the tool name with arguments (as describe_tool shows them). Its answer is the tool's own answer.

Scope: none, always listed.

Arguments:

  • arguments (object): The tool's arguments.
  • name (string, required): The tool name.

get_platform_status

Platform status. The public A-Line.cloud status page: overall state, each component's status, active incidents with their latest update, and upstream providers with active events. include adds history, resolved or upstream in full; component narrows to one component key.

Scope: none, always listed.

Arguments:

  • component (string): One component key.
  • include (string): history, resolved or upstream.

search_docs

Search the docs. Searches the A-Line.cloud docs and returns the best sections: title, path, url, section and a short snippet. Search here before guessing how a feature works, which setting does what or how to write an IaC file, then read the page with read_doc. The docs match this server's release.

Scope: none, always listed.

Arguments:

  • limit (integer 1–10): How many results (default 5, max 10).
  • query (string, required): Keywords, e.g. custom domain dns or backup policy.

read_doc

Read a docs page. One page of the A-Line.cloud docs as markdown, by the exact path search_docs returned (e.g. /mcp/tools). Long pages stop at 40 KiB with truncated and next_offset: call again with offset for the rest.

Scope: none, always listed.

Arguments:

  • offset (integer 0–10000000): Where to continue: a next_offset (default 0).
  • path (string, required): The page path from search_docs, e.g. /guides/custom-domain.

get_overview

Org overview. The environments of the org this connection may see and their projects (name, environment, cluster, app count, last activity), and notices: the signed-in user's unread inbox notices (unread, by_severity, the newest three titles; null on a narrowed grant). Start here to learn what an org runs; when notices are unread, list_notifications has them.

Scope: mcp:read, always listed.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

find_app

Find an app. Apps whose name or project name contains query, with their slug <env>/<project>/<app> for the other tools and their status. An empty query lists apps (capped).

Scope: mcp:read, always listed.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • query (string): Part of an app or project name.

get_app_status

App status. One app: state and status, image and running digest, replicas, source, last deploy and lifecycle error. Env var and secret reference names are listed; values are never returned.

Scope: mcp:read, always listed.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_deploys

List deploys. An app's releases, newest first: trigger, commit, image digest, status, error, actor and times. Page with before.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • before (id): Return releases older than this release id.
  • limit (integer 1–20): How many to return (default and max 20).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_deploy

Get a deploy. One release (deploy) of an app by id. A static site deploy also lists its timed publish steps (publish_steps: name, status, started_at, finished_at).

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • release (id, required): The release id from list_deploys.

list_builds

List builds. An app's builds, newest first, optionally only those with one status: number, status, trigger, commit, digest, error and failure stage. Page with cursor.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • cursor (string): The next_cursor of the previous page.
  • limit (integer 1–20): How many to return (default and max 20).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • status (string): pending, building, pushing, deploying, succeeded, failed or cancelled.

get_build_log

Build log. Lines of one build's log as untrusted text (credentials redacted), at most 500 per call; page with cursor.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • build (id, required): The build id from list_builds.
  • cursor (string): The next_cursor of the previous call.
  • limit (integer 1–500): Lines to return (default and max 500).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_app_logs

App logs. An app's (or static site's) runtime log lines as the console's log pane shows them, as untrusted text with credentials redacted. Newest page first; older lines with before, a live tail with after. Build output: get_build_log.

Scope: mcp:read.

Arguments:

  • after (string): A latest_cursor.
  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • before (string): A next_before.
  • build (id): Pods of this build.
  • level (string): all, warn or error.
  • limit (integer 1–500): Default 200.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • pod (string): Pod name.
  • q (string): Text to find.
  • since (string): RFC 3339 start.
  • until (string): RFC 3339 end.

get_deploy_log

Deploy log. One release (deploy) of an app with its error, and the app and pod events (scheduling, restarts, crash loops, readiness) during its rollout as untrusted text, redacted. Page older events with before. The pods' own output: get_app_logs with build.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • before (string): The next_before of a previous call.
  • limit (integer 1–200): Events to read per page (default 100).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • release (id, required): The release id from list_deploys.

list_domains

List domains. An app's domains: host, port, path prefix, protocol, TLS, platform domain and DNS state.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_clusters

List clusters. The org's own clusters (name, region, provider, state, environment).

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_cluster

Get a cluster. One of the org's own clusters by id, with maintenance: the maintenance window, when it next opens, the pending Talos/Kubernetes upgrade (from and target versions, not before, postponed until, deadline) and dont_deploy, the span a deploy may meet that upgrade (until null while it runs). Check it before a large deploy.

Scope: mcp:read.

Arguments:

  • cluster (id, required): The cluster id from list_clusters.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_usage

Usage and spend. The org's total spend, hourly burn, projected month and recent usage entries. Needs the owner or admin role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_secrets

List secrets. The secrets an environment's apps can read: name, type, scope, version, size and injection mode. Values are never returned.

Scope: mcp:read.

Arguments:

  • environment (string, required): The environment slug (from get_overview).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_notifications

Inbox notices. The signed-in user's own in-app notices in the org, newest first, as the console's bell shows them: kind, severity, title, body, read state, created_at, the resource it names (resource: app, project, environment, cluster or job) and console_url. Rows of one release share group_id; a repeating failure carries its incident count. Check it when the user asks whether anything is wrong or needs attention; platform incidents and maintenance are in get_platform_status. Reading never marks a notice read: the user's badge stays. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • kind (string): One kind: deploy, build, backup, cluster_upgrade, cluster_capacity, cluster_security, actions_rightsize, actions_job, billing, security, alert, ...
  • limit (integer 1–200): Default 20, max 200.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • severity (string): info, success, warning, error or critical.
  • since (string): Only notices from this RFC 3339 time on.
  • unread_only (boolean): Only notices not read yet.

get_iac_status

IaC status. The org's IaC project links: project, repository, branch, path, mode, status and last sync.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_project

Get a project. One project by slug <env>/<project>: its settings, quota limits and current usage, and its egress settings.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • project (string, required): The project slug <env>/<project> (from get_overview).

get_project_network

Project network. The network policies naming a project (as source or target) and its service connections, with their apply state.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • project (string, required): The project slug <env>/<project> (from get_overview).

get_app_config

App settings. An app's pod settings (resources, probes, placement; no commands), HTTP settings (custom header names only), storage bindings and secret groups (secret names only).

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_backups

List backups. An app's backup policies (schedule, retention, last run and restore) and its kept backups.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_volumes

List volumes. An app's volumes (size, state, who mounts them) and the volumes it mounts.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_dynamic_secrets

Dynamic secrets. An app's dynamic secret definitions and their leases (status, expiry, consumer). Usernames and credentials are never returned.

Scope: mcp:read.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • leases (string): all to include ended leases (default: active only).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_load_balancer

Get a load balancer. One load balancer of a cluster: type and limits, public IP, ports, hostnames, backend health and capacity samples.

Scope: mcp:read.

Arguments:

  • cluster (id, required): The cluster id from list_clusters.
  • lb (id, required): The load balancer id.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_billing_summary

Billing summary. The org's credit balance and burn rate, credit line, subscription, held commitments, business profile and extra invoice email recipients. credit_line_basis is live: the console's figure, counted over every org of a shared billing profile. Needs the owner or admin role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_billing_insights

Billing insights. The org's spend insights. Needs the owner or admin role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_transactions

List transactions. The org's credit transactions, newest first, grouped as the console shows them; page with offset. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • category (string): Only this category.
  • from (string): RFC 3339 start time.
  • limit (integer 1–20): How many to return (default and max 20).
  • offset (integer 0–100000): How many to skip (default 0).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • to (string): RFC 3339 end time.

list_invoices

List invoices. The org's final invoices, newest first; page with offset. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • limit (integer 1–20): How many to return (default and max 20).
  • offset (integer 0–100000): How many to skip (default 0).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_invoice

Get an invoice. One final invoice: amounts, VAT, buyer details. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • invoice (id, required): The invoice id from list_invoices.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_actions_usage

Actions usage. The org's Actions usage this month and the cost per workflow over period. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • period (string): today, 7d or 30d (default).

list_actions_jobs

Actions jobs. The org's newest Actions jobs (repository, workflow, job, runner size, region, status, conclusion, times, commit and pull request), filtered by repo, head_sha (a prefix works), pr or status. The pull request is known only when GitHub's delivery named it. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • head_sha (string): A commit id or its first 7+ hex digits.
  • limit (integer 1–100): Default 20, max 100.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • pr (integer 1–2147483647): A pull request number.
  • repo (string): owner/name.
  • status (string): queued, in_progress, completed or rejected.

get_actions_insights

Actions insights. The org's Actions insights over range: queue time (waiting for a runner, not billed) against run time (billed), medians per day and per workflow, flaky jobs (failing or passing on retry), jobs whose duration regressed, and where this month's spend is heading against the cap. Use it to find jobs worth retrying, fixing or splitting, and whether the cap will be hit. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • range (string): 24h, 7d (default) or 30d.

list_actions_rightsize

Runner size advice. The org's active runner size suggestions, out-of-memory first, then upsizes, then the biggest saving. Each names the repository, workflow and job, the current_label and suggested_label (the runner label to put in the job's runs-on:), a ready snippet, the reason, the runs it is based on and the estimated monthly saving; rules says how many runs a suggestion needs. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_actions_workflow_usage

Actions usage per workflow. Per repository and workflow, each job's runner label and size, its last run's and its average CPU p95, memory peak and disk peak against the runner's totals, over the job's last runs, with its size suggestion if any. Use it to judge whether a job's runs-on: runner is too big or too small. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_actions_cache

Actions cache. The org cache: bytes of actions/cache entries and of the BuildKit layer cache, their total against the never-billed free part and the limit (above it the oldest items are removed), the highest limit allowed, and the monthly estimate now and when full. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_actions_job_usage

Actions job usage. One Actions job's run: CPU p50/p95/max, memory p50/p95/peak against the runner's memory, I/O wait, disk read/write and peak, OOM kills; the means over the job's last runs; and its runner size suggestion (current and suggested runs-on: label) if any. run is empty for jobs from older runner agents. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • job (id, required): The Actions job id from list_actions_jobs.
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_actions_settings

Actions settings. The org's Actions settings, read only: the job duration limit, the monthly spend cap with this month's spend and its state (under, warn, capped), whether runners are enabled or the balance is below the floor, the runner and vCPU caps and how they are set, and the largest build CPU and memory. Use it to explain why jobs wait or are refused. Needs the billing role and a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_moderation

Holds and cases. Active holds on the org's resources, its moderation cases and its appeals. Org-wide: needs a grant on every environment.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

list_activity

Activity log. The org's activity log, newest first: action, outcome, source, summary, actor, target and project, as the console's activity feed shows them (an invite entry names the invitee's email). Actors are named only when they are members of the org or its API keys; anyone else shows as unknown. Org-wide: needs a grant on every environment. Page with cursor.

Scope: mcp:read.

Arguments:

  • cursor (string): The next_cursor of the previous page.
  • limit (integer 1–20): How many to return (default and max 20).
  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

get_proposal

Get a proposal. Where a proposal from a propose_ tool stands: pending, approved, rejected, expired or failed, with its preview and, once run, its result. Only answers for proposals this connection filed.

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.
  • proposal (id, required): The proposal id a propose_ tool answered.

get_org_settings

Org settings. The org's name, handle and creation time, and its policies (2FA requirement, API keys, allowed email domains).

Scope: mcp:read.

Arguments:

  • org (string): The org handle or id (from list_orgs); needed when more than one org is granted.

Write tools

Writes need their own scope, count against the per-org write budget you set on the grant, and show in the activity log.

deploy_app

Deploy an app. Rolls out the app's current image and settings with a new release. Counts against the org's deploy budget.

Scope: apps:deploy, destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

build_app

Build an app from git. Builds the app's repository at its branch head, or at commit (one of its earlier builds or releases), then deploys it as the console's Build button does. Apps that run a prebuilt image or an uploaded site are refused. Counts against the org's deploy budget.

Scope: apps:deploy, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • commit (string): A full commit id from list_builds or list_deploys.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

cancel_deploy

Cancel a deploy. Cancels the deploy in progress for the app, if any.

Scope: apps:deploy, destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

restart_app

Restart an app. Restarts the app's pods without changing its release. Counts against the org's deploy budget.

Scope: apps:deploy, destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • strategy (string): rolling (default), recreate or surge.

redeploy_previous

Redeploy a previous release. Redeploys an earlier succeeded release by digest, as a new release. Without release, the one before the latest succeeded release. Not for static sites, whose releases have no image.

Scope: apps:deploy, destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • release (id): The release id from list_deploys.

scale_app

Scale an app. Sets the app's replicas within the project quota. Never scales to 0: use stop_app. Autoscaled apps are refused.

Scope: apps:scale, destructive, safe to retry.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • replicas (integer 1–100, required): The replica count, at least 1.

set_env_vars

Set env vars. Sets plain env vars, merged into the app's current ones. Secret-looking names are refused: use set_secret. Applied on the next deploy; pass deploy to deploy now. Values are never returned.

Scope: apps:config:write, destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • deploy (boolean): Deploy right after (default false).
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • vars (object, required): Variable names and their values.

stop_app

Stop an app. Stops the app's pods; start_app brings them back.

Scope: apps:lifecycle, destructive, safe to retry.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

start_app

Start an app. Starts a stopped app with its previous replica count, within the project quota.

Scope: apps:lifecycle, not destructive, safe to retry.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

set_secret

Set a secret. Creates the environment secret name; refused if it already exists, so a retry never overwrites it. The value is never returned.

Scope: secrets:write, not destructive.

Arguments:

  • environment (string, required): The environment slug (from get_overview).
  • name (string, required): The secret's name.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • value (string, required): The value; never shown again.

add_domain

Add a domain. Adds a custom domain to the app and returns its status and the DNS records to create.

Scope: domains:write, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • domain (string, required): The host name, e.g. shop.example.com.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • port (integer 1–65535): The app port to route to (default the app's port).

propose_create_app

Propose a new app. Files a proposal to create an app; returns its preview and a console link. Nothing is created until a person approves it; check with get_proposal. Give image or template. The approver reads env var values, so never pass a credential.

Scope: proposals:create, not destructive.

Arguments:

  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • image (string): Container image.
  • name (string, required): New app name.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • port (integer 1–65535): Listen port.
  • project (string, required): <env>/<project>.
  • reason (string, required): Why, for the approver.
  • template (string): Or a template slug.
  • vars (object): Plain env vars, no secrets.

propose_delete_app

Propose deleting an app. Files a proposal to delete the app and returns what would go and a console link. Nothing is deleted until a person approves it there. An approved delete keeps the app's buckets and backups.

Scope: proposals:create, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • reason (string, required): Why, for the approver.

propose_scale_pool

Propose adding nodes. Files a proposal to grow a node pool and returns the nodes it would order, their price and a console link. Nothing is ordered until a person approves it there. Only adds nodes: scaling down is done in the console.

Scope: proposals:create, not destructive.

Arguments:

  • cluster (string, required): The cluster's name or id (from list_clusters).
  • count (integer 1–100, required): The pool's wanted node count; more than it wants now.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • pool (string, required): The node pool's name or id.
  • reason (string, required): Why, for the approver.

propose_remove_domain

Propose removing a domain. Files a proposal to remove a domain from the app and returns the route affected and a console link. Nothing is removed until a person approves it there.

Scope: proposals:create, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • domain (string, required): The host to remove (from list_domains).
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • reason (string, required): Why, for the approver.

propose_restore_backup

Propose a restore. Files a proposal to restore a backup of the app and returns what it would do and a console link. Nothing is restored until a person with the admin role approves it there. backup_name and target_id come from the app's backups.

Scope: proposals:create, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • backup_name (string, required): The backup to restore.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.
  • reason (string, required): Why, for the approver.
  • target_id (id, required): The backup target holding it.

trigger_backup

Start a backup. Starts a backup of the app under its enabled backup policy. Needs a backup policy.

Scope: backups:write, not destructive.

Arguments:

  • app (string, required): The app slug <env>/<project>/<app> (from find_app), or its console URL.
  • idempotency_key (string): Any unique string; a retry with the same key answers the first result without acting again.
  • org (string, required): The org handle or id (from list_orgs). Always required on a write.

On this page