Deploy an App
deploy_appBuild and deploy an HTTP app in one resumable call. Builds the app files stored with write_app_files (the default), or repoUrl, or skips the build for image. Without gvc it uses the GVC a job made for apps, asks about any other, or creates the first one once the user picks a location. Creates a standard workload (stateful with per-replica storage) or updates one it created, with production defaults (HTTP readiness and liveness checks, 2 replicas so deploys cause no downtime, exposure set now), grants access to secrets its env references, waits up to 40 seconds, and returns the status, the public URL once ready, and the exact next call. Files that must survive restarts: storage. Serverless, several containers, cron, or other protocols: create_workload.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"public": "<public>"
},
"name": "deploy_app"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cpu | No | CPU per replica (default "250m"). | |
| env | No | Env vars. A value may reference a secret key as cpln://secret/NAME.KEY; deploy_app grants the workload access to it. | |
| gvc | No | GVC to deploy into; the app runs in every one of its locations. Omit it to use the GVC a job made for apps, or to create the first one. A name that does not exist yet creates that GVC in location. | |
| org | No | Organization slug. | |
| name | Yes | Workload name. Without image or repoUrl, it is also the name the app files were stored under with write_app_files. | |
| port | No | Port the app listens on. A build detects it and an update keeps the current one; required to create from image. | |
| image | No | Deploy this image with no build: //image/NAME:TAG from this org, or an exact external reference such as nginx:latest. | |
| branch | No | Branch to build, with repoUrl only. Default: the repository default branch. | |
| memory | No | Memory per replica (default "512Mi"). | |
| public | Yes | true: reachable from the internet at a public URL. false: reachable only by workloads in the same GVC. | |
| buildId | No | The buildId a previous deploy_app call returned. Continues that build instead of starting a new one. | |
| replace | No | true replaces a same-name workload that deploy_app did not create. Only after the user said yes. | |
| repoUrl | No | Build from this GitHub or GitLab repository instead of the stored app files. | |
| storage | No | Files that must survive restarts. Without it the container filesystem is wiped on every restart. A database: add_database. | |
| location | No | Only to create a GVC: An enabled location of the org, from the list a placement question gives. | |
| maxScale | No | Maximum replicas per location (platform default 5). | |
| minScale | No | Minimum replicas per location (default 2; 1 with per-replica storage). | |
| healthPath | No | HTTP path for the readiness and liveness checks. Default: what the build detected, else "/". | |
| connectNonce | No | Only after the user authorized the git provider for repoUrl: the connectNonce the previous call returned. | |
| timeoutSeconds | No | Seconds a request may run before the platform ends it (platform default 5). Raise it for slow requests: AI calls, third-party APIs, reports, streamed responses. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | No | The full result. Read this, not only the summary. | |
| details | No | ||
| summary | Yes | ||
| nextSteps | No |