Skip to main content
POST
/
v1
/
apps
/
{app_id}
/
deploy
Deploy an App
curl --request POST \
  --url https://api.mixpeek.com/v1/apps/{app_id}/deploy \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "environment": "production",
  "source": "cli_upload",
  "bundle_s3_key": "<string>",
  "source_files": {},
  "git_commit_sha": "<string>",
  "git_commit_message": "<string>",
  "git_author": "<string>"
}
'
{
  "app_id": "<string>",
  "deploy_id": "<string>",
  "environment": "<string>",
  "message": "<string>"
}

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

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

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