BlueForge Docs

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

MethodPathAuthIdempotent
POST
/api/apps/:appId/restart
Bearer {key}no

Parameters

NameTypeRequiredDefaultNotes
appId
stringyesApp ID (
app_*
)

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
    forge app deploy
    to apply new environment variables or build changes.
  • Health check required — app must have a
    /health
    endpoint configured for rolling restart to proceed.

See also

{auto-injected}

Tested against

{auto-injected}