Skip to main content
GET
Get an application's demo configuration

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

Response

Successful Response

The application's saved demo defaults, served and accepted by GET/PUT demo-config. On PUT, env and database are replaced wholesale; stack_profile, base_stack, migrate_command, and database_extensions are written only when their key is present in the body (absent preserves the stored value, explicit null/empty clears it).

database
boolean
required
env
object[]
required
protected
boolean

Whether every demo of this application launches behind Ankra's edge password guard (a Traefik basicAuth middleware on the preview ingress). On PUT, written only when the body carries the key: turning it on mints one shared credential, the answer to that PUT carries generated_password, and Ankra keeps it so POST demo-config/protection/reveal can answer it again; turning it off clears it.

protected_username
string

The login a protected demo accepts. Read-only; empty when protection is off.

generated_password
string

Present only in the answer to the PUT that turned protection on: the plaintext of the credential just minted. Never stored, never read back; rotate to get a new one.

base_stack
object | null

The shared demo base stack demos of this application depend on; null keeps demos free of shared infrastructure.

database_extensions
string[] | null

Postgres extensions the demo database creates at initdb (plain lowercase identifiers, e.g. vector). Requires database=true.

migrate_command
string | null

The command that provisions a fresh demo database's schema; runs through sh -c in the application image after the database gate, with the demo environment. Requires database=true or a base stack.

stack_profile
object | null

The full-stack demo designation; null keeps demos single-service.