Apps

Deploy progress

Where the last deploy got to (phase), whether the app is running right now (runState), and its address. The two are separate questions: a paused app reports phase: live with runState: paused.

get/client/apps/{id}/progress

Request

  • Base URL: https://api.roar-ai.com
  • URL: https://api.roar-ai.com/client/apps/{id}/progress
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Build/deploy progress + URL

phase'queued' | 'building' | 'deploying' | 'securing' | 'live' | 'failed' required

How the last DEPLOY went. live means it finished and its address was confirmed serving — not that the app is running now, which a later pause does not change. Read runState for that.

runState'running' | 'starting' | 'paused' | 'crashed' | 'unknown' required

Whether the app is running right now. paused is an owner having stopped it — its URL is still reported, because that is the address it comes back on, but nothing answers there until it is started again.

urlstring nullable required

The app's public address, once a deploy has been confirmed serving on it.

serviceStatusstring nullable required
errorstring nullable required

Plain-language failure reason while phase is failed.

fixstring nullable required

A suggested fix for that failure, when we have one.

canAutoFixboolean required
autoFixExhaustedboolean required

The fixer handles this failure, but the attempt budget for this episode is spent. Distinct from canAutoFix:false, which also covers failures we never fix.

failureKind'start' | 'code' | 'settings' | 'transient' | 'platform' | 'unsupported' | 'unknown' | 'null' nullable required

What the failure needs: a start command, a code fix, a setting, a retry, us, or an unsupported app. Null while not failed.

autoFixSummarystring nullable required
canRetryboolean required

Whether a failed app is far enough provisioned for a redeploy to be worth trying.

securingReasonstring nullable required

Why the address is taking longer than the normal window. Null inside it.

resourceWarningstring nullable required

Plain-language note about the app's own resource use — today, that it was killed for running out of memory.

memoryLimitMbinteger nullable required

The most memory the app may use, in MB — a ceiling set automatically from the server it runs on, not a reservation and not a setting. Billing is on what the app actually uses. Null until the app has been placed on a server.

cpuLimitnumber nullable required

The most CPU the app may use, in vCPU — set automatically, like memoryLimitMb. Null until the app has been placed on a server.

updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.