Update Application Demo Configuration

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config"

payload = {
    "database": True,
    "env": [
        {
            "name": "<string>",
            "secret": True,
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({database: true, env: [{name: '<string>', secret: true, value: '<string>'}]})
};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PUT \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": true,
  "env": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ]
}
'

{
  "database": true,
  "env": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "base_stack": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>"
  },
  "database_extensions": [
    "<string>"
  ],
  "migrate_command": "<string>",
  "stack_profile": {
    "enabled": true,
    "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parameters": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "profile_name": "<string>",
    "version": 123
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Applications API

Update Application Demo Configuration

Replace the application's saved demo defaults. env and database are replaced wholesale on every PUT. The stack_profile and base_stack blocks are written only when their key is present in the body: an absent key preserves the stored designation, an explicit null clears it, so a client that predates either block cannot silently drop a demo's dependencies. Secret environment values are submitted and echoed as ${SECRET_SLOT:<uuid>} sentinels. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication plus the X-Ankra-CSRF double-submit header).

PUT

api

org

applications

{application_id}

demo-config

Update Application Demo Configuration

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config"

payload = {
    "database": True,
    "env": [
        {
            "name": "<string>",
            "secret": True,
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({database: true, env: [{name: '<string>', secret: true, value: '<string>'}]})
};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PUT \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/demo-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": true,
  "env": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ]
}
'

{
  "database": true,
  "env": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "base_stack": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>"
  },
  "database_extensions": [
    "<string>"
  ],
  "migrate_command": "<string>",
  "stack_profile": {
    "enabled": true,
    "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parameters": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "profile_name": "<string>",
    "version": 123
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 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

Show child attributes

base_stack

object | null

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

Show child attributes

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.

Show child attributes

Response

The saved configuration after the write

database

boolean

required

env

object[]

required

Show child attributes

base_stack

object | null

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

Show child attributes

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.

Show child attributes

API reference

Endpoints

Update Application Demo Configuration

Authorizations

Headers

Path Parameters

Body

Response