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 '
{
  "environment": "staging",
  "message": "<string>",
  "source": "cli_upload",
  "bundle_s3_key": "<string>"
}
'
{
  "app_id": "<string>",
  "deploy_id": "<string>",
  "status": "queued",
  "environment": "<string>",
  "message": "<string>"
}

Headers

​
Authorization
string

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

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
authorization
string
​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
app_id
string
required

Body

application/json

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

​
environment
enum<string>
default:staging

Target environment for this deploy

Available options:
staging,
production
​
message
string | null

Deploy message / changelog note

​
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')

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