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

# Set an application plain value (browser session)

> Store one plain value: the shared default, or with environment_id that environment's own value. The value is kept in the row as text and returned by reads, so it must not be a credential: a name or a value that looks like one is refused unless confirm_plain is true. It reaches the workload through the same <app>-env Secret as the secrets, on the next env-secrets apply or deploy. 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).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /org/applications/{application_id}/env-values/{key}
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts, and no operation is
    served without one. This document is published deliberately: it describes
    the contract only and carries no organisation data or credentials. Report
    security issues to security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - 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: Playground
    description: >-
      The organisation's playground cluster: order one, read its provisioning
      status, list the orderable sizes, resize it and destroy it.
  - 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: Cluster Meshes
    description: >-
      Cilium ClusterMeshes that join an organisation's clusters into one
      network: create a mesh, check whether clusters can join, prepare a running
      cluster, and add or remove members.
  - 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: Proxmox Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on Proxmox VE VMs: the node,
      storage, bridge, template and size catalogs, create and teardown, start
      and stop, node groups, nodes, standalone VMs, upgrades and the bastion.
  - name: HPE Morpheus Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on HPE Morpheus VMs: the
      group, cloud, plan, layout and network catalogs, create and teardown,
      start and stop, node groups, nodes, standalone VMs, upgrades and the
      bastion.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - 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: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - 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: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Projects
    description: >-
      Projects group an organisation's clusters, applications, credentials and
      other resources beneath it: list, create, rename and delete them, switch
      the current project, see who reaches one, and move resources between them.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address, and the AI provider keys your own work runs on.
  - 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: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - 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: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - 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:
  /org/applications/{application_id}/env-values/{key}:
    put:
      tags:
        - Applications
      summary: Set an application plain value (browser session)
      description: >-
        Store one plain value: the shared default, or with environment_id that
        environment's own value. The value is kept in the row as text and
        returned by reads, so it must not be a credential: a name or a value
        that looks like one is refused unless confirm_plain is true. It reaches
        the workload through the same <app>-env Secret as the secrets, on the
        next env-secrets apply or deploy. 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).
      operationId: >-
        set_application_env_value_api_v1_org_applications__application_id__env_values__key__put__browser
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
        - in: path
          name: key
          required: true
          schema:
            type: string
            title: Key
        - 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
        - name: environment_id
          in: query
          required: false
          schema:
            format: uuid
            type: string
          description: >-
            A stored application environment of this application. Omit it for
            the shared default every environment inherits. A legacy cluster ID
            is not accepted here, and empty or repeated values are refused.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetApplicationEnvValueRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationEnvValueItem'
          description: The plain value after the write.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Invalid key, value or environment_id, or a name or value that looks
            like a credential sent without confirm_plain ("{KEY} looks like a
            secret. Store it as a secret, or send confirm_plain: true.")
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            The caller lacks applications.write; the selected environment, or
            with no environment_id the application itself, also runs on clusters
            outside the caller's project (a project-confined caller); or
            (browser twin only) the CSRF check failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Application or selected environment not found. With no
            environment_id, a project-confined caller is also answered this for
            an application that runs only on clusters outside their project. A
            legacy cluster ID answers this too.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            The key is a secret in this scope ("{KEY} is a secret here. Change
            it under its secret, or remove the secret first."), or a secret
            turned off in this environment ("{KEY} is a secret turned off here.
            Make it use the shared default again with POST
            .../env-secrets/{secret_key}/inherit for this environment, then try
            again."); a key is a secret or a plain value in one scope, never
            both; the application already holds 500 entries across its secrets
            and plain values; or the selected environment changed while
            preparing the write.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Plain values are not available yet, while the platform is being
            updated ("Plain values are not available yet. Try again in a few
            minutes.")
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    SetApplicationEnvValueRequest:
      description: >-
        One plain value. It is stored as text and returned by reads, so it must
        not be a credential.
      properties:
        value:
          type: string
          minLength: 1
          title: Value
          description: 1 to 8192 bytes, with no NUL character.
        confirm_plain:
          type: boolean
          default: false
          title: Confirm Plain
          description: >-
            Store the value even though its name or the value itself looks like
            a credential.
      required:
        - value
      title: SetApplicationEnvValueRequest
      type: object
    ApplicationEnvValueItem:
      description: >-
        One plain key of an application as it resolves in the scope read. Unlike
        a secret, the value is returned.
      properties:
        key:
          type: string
          title: Key
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
          description: >-
            The value. Null when the key is turned off here (status disabled) or
            has no value in reach here (status not_set).
        source:
          anyOf:
            - type: string
              enum:
                - shared
                - environment
            - type: 'null'
          title: Source
          description: >-
            shared: the shared default; environment: the environment's own value
            or turn-off. Null for status not_set.
        status:
          type: string
          enum:
            - set
            - disabled
            - not_set
          title: Status
          description: >-
            set carries a value; disabled is the key turned off in this
            environment; not_set is a plain key of the application with no value
            in reach here.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: When the entry read was last written. Null for status not_set.
        updated_by:
          anyOf:
            - $ref: '#/components/schemas/ApplicationEnvValueActor'
            - type: 'null'
          description: >-
            Who last wrote the entry read; null for status not_set or when no
            person is recorded.
      required:
        - key
        - value
        - source
        - status
        - updated_at
        - updated_by
      title: ApplicationEnvValueItem
      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
    ApplicationEnvValueActor:
      description: Who last wrote a plain value.
      properties:
        user_id:
          title: User Id
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            The writer's profile name or email while they are an active member
            of the organisation; null otherwise.
      required:
        - user_id
        - name
      title: ApplicationEnvValueActor
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.