Skip to main content
POST
TypeScript

Autorisations

Authorization
string
header
requis

Only available to a signed-in whop.com session. API keys, access tokens, and OAuth tokens are not accepted.

Scopes

developer:manage_builds

En-têtes

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Exemple:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

The app to deploy, prefixed app_.

Corps

application/json
draft
boolean

Upload the build without making it live. Defaults to false, which deploys and promotes in one step.

Exemple:

false

Réponse

deployment started

app_id
string
requis

The app being deployed, prefixed app_.

Exemple:

"app_xxxxxxxxxxxxxx"

build_id
string | null
requis

The build the deployment produced, prefixed abld_, or null until it succeeds.

Exemple:

null

draft
boolean
requis

Whether the running or last deployment uploaded a build without making it live.

Exemple:

false

error
string | null
requis

Why the deployment failed, or null when it did not.

Exemple:

null

estimated_duration_ms
integer | null
requis

How long this deployment is expected to take in total, estimated from previous runs.

Exemple:

150000

estimated_remaining_ms
integer | null
requis

How much longer the deployment is expected to take. Held above zero until it actually finishes.

Exemple:

91000

finished_at
integer | null
requis

When the deployment ended, in milliseconds since the epoch, or null while it is still running.

Exemple:

null

phase
enum<string> | null
requis

The stage a running deployment has reached, or null when none is running. Later phases dominate the wall clock: process_archive waits on the upload pipeline and promote waits for the build to go live.

Options disponibles:
install,
build,
typecheck,
upload_build,
upload_source,
process_archive,
create_build,
promote,
null
Exemple:

"process_archive"

progress
number | null
requis

Fraction of the deployment estimated to be complete, from 0 to 1. Stops just short of 1 until the run ends.

Exemple:

0.39

started_at
integer | null
requis

When the deployment began, in milliseconds since the epoch, or null when none has run.

Exemple:

1767268800000

status
enum<string>
requis

Whether the app has anything to publish, and what a publish in flight is doing. unpublished means publishing would ship something new; no_source means the sandbox holds no copy of this app, so there is nothing to publish from.

Options disponibles:
published,
unpublished,
publishing,
failed,
no_source
Exemple:

"publishing"

url
string | null
requis

Where the deployed site is served, or null unless the deployment went live.

Exemple:

null