Apps

Deploy an app

Provision + deploy from a git repo. Returns 202 with the app, its web service and the queued deployment; poll /client/apps/{id}/progress for the rest. Requires apps:deploy.

This route takes no databaseEnabled — a database Roar provides is POST /client/apps/github. To use your own, send its DATABASE_URL in env.

A repository we can read and already know cannot build — several apps and no rootDir, or nothing we know how to build — is refused with 400 before anything is created, and the message says what to change. One we cannot tell how to START passes once startCommand says how (one line, at most 300 characters; an obviously unfinished command such as a bare node or one ending in a folder is refused). The body is strict: a field this route does not take is a 400, never silently ignored. GET /client/github/build-check asks the same question first.

post/client/apps

Request

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

Request body

namestring required
repostring required

owner/name

branchstring
rootDirstring

The app’s folder in a repository that holds several apps. Absent means found automatically.

startCommandstring

How the app starts, when the repository does not say (one line, at most 300 characters). Stored as the build settings start command.

envobject
projectIdstring uuid nullable

Response

Deploy started

Changes

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