Back4app

Asks to put a web app back on its previous version, when the new one misbehaves and the one before worked. Nothing changes on this call: it answers a summary of the swap and a confirmationId. Show the summary to the person and, if they agree, call confirm_action. Environment variables and the database stay as they are.

rollback_web_app

Changes an app's settings or environment variables and always deploys it again; only what is sent changes. New code can go along with the change. To deploy with nothing else changed, use deploy_web_app. The first call changes nothing: it answers a summary of the change (the variables by name) and a confirmationId. Show the summary to the person and, if they agree, call update_web_app again with the same arguments and the confirmationId.

update_web_app

Runs an operation that was waiting for a confirmation, such as a rollback, after its summary was shown to the person. A confirmationId lasts 5 minutes and works once.

confirm_action

Creates an app on the Free plan from a folder of code and starts its first deployment. The app must listen on the port given in the PORT environment variable. Send the code one way: uploadId and manifestSha256 (from the command create_upload gives, when there is a terminal) or files (the code in this call, when there is none). For an app that exists, deploy_web_app and update_web_app send new code.

create_web_app

Publishes new code to an app, or deploys its latest code again when no code is sent. Send new code as uploadId and manifestSha256 (from create_upload, called with this appId) or as files.

deploy_web_app

One deployment of a web app: status (QUEUED, BUILDING, DEPLOYING, READY, FAILED, CANCELED or REMOVED), phase, dates, source, and the URL once READY. When FAILED it brings the error and the end of the build log. When the analysis of the code found settings the app does not have (environment variables, start command, port), it brings them as suggestions. When the app was not listening on the port its settings named, portDetected says where it was found: the port setting of the app was changed to that one, so tell the person. Follows a deployment started by create_web_app, deploy_web_app, update_web_app or a confirmed rollback, until it is READY or FAILED.

get_deployment

One app in full: where its code comes from, root folder, builder, port, start command, health check, plan, URL, the names of its environment variables and its last deployment. On the Free plan, urlExpiresAt is when the URL stops answering (a deploy after that brings the app back at a new URL); offlineReason says why an app is OFFLINE (FREE_ADDRESS_EXPIRED: that time passed, not a failed deploy).

get_web_app

For a client with a terminal: gives the command that packs the project's folder and sends it to Back4App. Run the command in the folder; it needs no login and prints the uploadId and manifestSha256 that create_web_app, deploy_web_app and update_web_app take. Pass appId when the code is for an app that exists.

create_upload

A web app's deployments, newest first. Use it to find an older deployment, or the one a push to the repository started.

list_deployments

The account's web apps, its own and the ones it collaborates on, newest first: state, URL, plan, where the code comes from and the last deployment. On the Free plan, urlExpiresAt is when the URL stops answering (a deploy after that brings the app back at a new URL); offlineReason says why an app is OFFLINE. The first step when working with an app that exists.

list_web_apps