> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an application's demo configuration

> Return the application's saved demo defaults: the environment entries, the throwaway-database flag, and the optional stack-profile and base-stack dependency designations. Secret environment values and secret stack parameters ride as ${SECRET_SLOT:<uuid>} sentinels, never resolved values. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/applications/{application_id}/demo-config
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: Pipeline definitions and the approval of the authority they declare.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/applications/{application_id}/demo-config:
    get:
      tags:
        - Applications
      summary: Get an application's demo configuration
      description: >-
        Return the application's saved demo defaults: the environment entries,
        the throwaway-database flag, and the optional stack-profile and
        base-stack dependency designations. Secret environment values and secret
        stack parameters ride as ${SECRET_SLOT:<uuid>} sentinels, never resolved
        values. A browser session twin is mounted at the same path without the
        /api/v1 prefix (cookie authentication).
      operationId: >-
        get_application_demo_configuration_api_v1_org_applications__application_id__demo_config_get
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDemoConfiguration'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: Not found ("Application not found")
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ApplicationDemoConfiguration:
      description: >-
        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).
      properties:
        protected:
          description: >-
            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.
          title: Protected
          type: boolean
        protected_username:
          description: >-
            The login a protected demo accepts. Read-only; empty when protection
            is off.
          title: Protected Username
          type: string
        generated_password:
          description: >-
            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.
          title: Generated Password
          type: string
        base_stack:
          anyOf:
            - $ref: '#/components/schemas/DemoConfigurationBaseStack'
            - type: 'null'
          description: >-
            The shared demo base stack demos of this application depend on; null
            keeps demos free of shared infrastructure.
        database:
          type: boolean
        database_extensions:
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: >-
            Postgres extensions the demo database creates at initdb (plain
            lowercase identifiers, e.g. vector). Requires database=true.
        env:
          items:
            $ref: '#/components/schemas/DemoEnvironmentEntry'
          type: array
        migrate_command:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            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:
          anyOf:
            - $ref: '#/components/schemas/DemoConfigurationStackProfile'
            - type: 'null'
          description: The full-stack demo designation; null keeps demos single-service.
      required:
        - env
        - database
      type: object
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    DemoConfigurationBaseStack:
      description: >-
        The base-stack reference of a demo configuration. Only id is written on
        PUT; name and status are denormalized onto reads.
      properties:
        id:
          type: string
          format: uuid
        name:
          description: Read-only.
          type: string
        status:
          description: Read-only.
          type: string
      required:
        - id
      type: object
    DemoEnvironmentEntry:
      description: >-
        One demo environment entry. Secret values ride as ${SECRET_SLOT:<uuid>}
        sentinels - the persisted form, safe to echo; resolved secrets never
        ride this surface.
      properties:
        name:
          type: string
        secret:
          type: boolean
        value:
          type: string
      required:
        - name
        - value
        - secret
      type: object
    DemoConfigurationStackProfile:
      description: The stack-profile block of a demo configuration.
      properties:
        enabled:
          type: boolean
        parameters:
          description: >-
            Secret parameter values ride as ${SECRET_SLOT:<uuid>} sentinels.
            Entries with an empty name are dropped on PUT. Always present on
            reads.
          items:
            $ref: '#/components/schemas/DemoStackParameter'
          type: array
        profile_id:
          type: string
          format: uuid
        profile_name:
          description: Denormalized onto reads only; ignored on PUT.
          type: string
        version:
          anyOf:
            - type: integer
            - type: 'null'
          description: Null tracks the profile's current version.
      required:
        - enabled
        - profile_id
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    DemoStackParameter:
      description: >-
        One stack-profile parameter binding. Secret values ride as
        ${SECRET_SLOT:<uuid>} sentinels, never resolved values.
      properties:
        name:
          type: string
        value:
          type: string
      required:
        - name
        - value
      type: object

````