Get an app
Returns one app with its status and limits. A key limited to some apps may only use those.
Requires the deploy:read permission.
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer jb_live_…
Path Parameters
The app name.
1 - 100^[A-Za-z0-9][A-Za-z0-9-]*$Response
The app.
An app as the account sees it. The hosting node, owner and internal metadata are left out.
The app name, used in paths.
The app id.
The address the app is served from.
The lifecycle: pending, building, deployed, failed or deleted.
The one status to show: failed, queued, building, rebuilding, suspended, throttled, scaling, ready or deleted.
The durable lifecycle: pending, building, deployed, failed or deleted.
Current work: queued, building, rebuilding, verifying or none.
Whether it is serving: running, stopped or crashed.
Whether traffic reaches it: active, suspended or inactive.
Resource state, such as normal, throttled, scaling or suspended.
A sentence about the current state.
What can be done now, by action: open_app, restart, redeploy, update_env, delete, view_logs, edit_metadata. Use this instead of checking states yourself.
The custom domain, if one is set.
CPU cores the app may use.
Memory limit in bytes.
Disk limit in bytes.
Disk used in bytes.
Whether the app is suspended.
Why it is suspended.
The last error, for a failed app.
When it was created.
When it last changed.
When the app expires, on plans where apps expire.