Deploy from a connected GitHub repo
The private-repo counterpart to POST /client/apps: deploys a repo reachable through your installed GitHub App. Returns 202 with the app, its web service and the queued deployment. Requires apps:deploy.
databaseEnabled and a DATABASE_URL of your own in env are mutually exclusive: when Roar provides the database it sets DATABASE_URL itself.
deployOnPush (boolean, default true) sets whether a push to branch deploys the app automatically.
A repository we can read and already know cannot build is refused with 400 before anything is created: with several apps and no rootDir, the message lists the folders rootDir can take. A repo we cannot tell how to START is refused the same way unless startCommand (one line, at most 300 characters — the same rule as the Build settings start command) says how; it is stored as that build setting, and an obviously unfinished command (a bare node, one ending in a folder, an unclosed quote) 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.
Request
- Base URL: https://api.roar-ai.com
- URL: https://api.roar-ai.com/client/apps/github
- Auth: HTTP bearer
Response
Deploy started
Changes
No recorded changes to this operation across all 1 revision of this API.