Skip to main content
POST
Deploy Application Demo

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

application_id
string
required

Body

application/json

The deploy-demo body. Provide exactly one of branch or a positive pr_number; PR demos additionally require an explicit image_tag.

branch
string | null
container_port
integer | null

Null resolves the application's default demo container port.

database
boolean | null

Overrides the application's saved throwaway-database default; null keeps it.

env
object[]

Per-launch env overrides, merged over the application's saved demo defaults (overrides win by name). Secret values ride as ${SECRET_SLOT:} sentinels.

image_tag
string | null

Null resolves the branch's built image via the build check.

pr_number
integer | null
ttl_hours
integer | null

At least 1 and at most the caller's role-capped maximum; null applies the policy default.

components
object[] | null

Subset of a monorepo's components to deploy with optional per-component overrides; omitted deploys every recorded component.

entry_component
string | null

Names the component that owns the demo host's root path; omitted applies the entry heuristic.

Response

Successful Response

branch
string | null
required
image
string
required
namespace
string
required
pr_number
integer | null
required
service_dns
string
required
status
string
required
ttl_hours
integer
required
workspace_id
string
required
preview_url
string
components
object[] | null