Skip to main content
POST
Deploy an App

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id
string
required

Body

application/json

Deploy a pre-built bundle (CLI path) or trigger a Git-based build.

message
string
required

Deploy message describing what changed (required, like a git commit message)

environment
enum<string>
default:production

Target environment for this deploy

Available options:
staging,
production
source
enum<string>
default:cli_upload

Deploy source. 'cli_upload' = zip already uploaded to S3. 'git' = Phase 3b.

Available options:
cli_upload,
git
bundle_s3_key
string | null

S3 key of the uploaded source zip (required for source='cli_upload')

source_files
Source Files · object | null

Map of relative path → file content for source-level version diffs

git_commit_sha
string | null

Git commit SHA associated with this deploy

git_commit_message
string | null

Git commit message associated with this deploy

git_author
string | null

Git commit author (name )

Response

Successful Response

app_id
string
required
deploy_id
string
required
status
enum<string>
required
Available options:
queued,
building,
complete,
failed
environment
string
required
message
string | null