hosting.apps.restart
Restart all containers for an app.
Triggers a rolling restart of all containers for a deployed app. Downtime is minimal as containers are replaced one at a time.
Endpoint
| Method | Path | Auth | Idempotent |
|---|---|---|---|
| POST | | Bearer {key} | no |
Parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
| string | yes | — | App ID () |
Response
interface RestartResult {
app_id: string
status: 'restarting' | 'healthy'
containers: number
started_at: string
}
Examples
cURL:
curl -X POST https://api.blueforge.studio/api/apps/app_xxxxx/restart \
-H "Authorization: Bearer $BF_API_KEY"
CLI:
forge app restart app_xxxxx
Pitfalls
- Rolling restart — containers restart one at a time. Brief increased latency during transition.
- Not for config changes — use
to apply new environment variables or build changes.forge app deploy - Health check required — app must have a
endpoint configured for rolling restart to proceed./health
See also
{auto-injected}
Tested against
{auto-injected}