app
app pause
Stop an application without deleting it.
writesrepeatable--dry-run
Stops every instance and keeps everything else: the configuration, the variables, the disks, the domains and the address. It is what to reach for when an application should be off rather than gone.
A paused application answers nothing and runs nothing. app resume brings it back
at the scale it had.
Usage
outplane app pause [APP]Arguments
| Argument | Type | Description |
|---|---|---|
APP | string | App name or id. Defaults to the linked app. |
Output
| Field | Type | Description |
|---|---|---|
app | string | |
appId | string | |
paused | bool | The state the application is now in. |
instances | int | The configured count, which pausing does not change. |
changed | bool | False when it was already in that state. |
Examples
See what it would do, without doing it
outplane app pause --dry-runPause an application
outplane app pause checkoutPause the linked one and read the result
outplane app pause --json --fields paused,changed{
"changed": true,
"paused": true
}What to Know
- Idempotent. Pausing something already paused changes nothing, reports changed false, and exits 0.
- Applied immediately, without a deployment.
- The configured replica count is kept, so resuming returns to the scale that was set rather than to a single instance.
- A paused application still reports its last deployment's state in deploymentStatus. status is what says paused.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of app.not_found, context.no_app. Branch on that, or on the exit status. The message is prose and changes.