> ## 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 environment's size (browser session)

> One environment's size, for the Settings, Scaling page. For each placement: the copies, CPU and memory the next release renders, where each comes from (set, the deploy mode, the option contract's default, or not set), whether it is parked, and what the cluster mirror says runs, with whether Ankra's generated Deployment runs what is stored. The stored values follow applications.read. The running values are shown only on a cluster where the caller holds kubernetes.read, decided as the cluster read decides it; elsewhere they read withheld. environment_id is a stored environment's id, or the cluster id of a placement no stored environment claims, as the environments read lists them. A caller confined to a project is answered for an environment placed only outside it exactly as for one the application does not have (404), and is told only their own placements of a mixed one. Nothing is written.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /org/applications/{application_id}/environments/{environment_id}/size
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}/environments/{environment_id}/size:
    get:
      tags:
        - Applications
      summary: Get an environment's size (browser session)
      description: >-
        One environment's size, for the Settings, Scaling page. For each
        placement: the copies, CPU and memory the next release renders, where
        each comes from (set, the deploy mode, the option contract's default, or
        not set), whether it is parked, and what the cluster mirror says runs,
        with whether Ankra's generated Deployment runs what is stored. The
        stored values follow applications.read. The running values are shown
        only on a cluster where the caller holds kubernetes.read, decided as the
        cluster read decides it; elsewhere they read withheld. environment_id is
        a stored environment's id, or the cluster id of a placement no stored
        environment claims, as the environments read lists them. A caller
        confined to a project is answered for an environment placed only outside
        it exactly as for one the application does not have (404), and is told
        only their own placements of a mixed one. Nothing is written.
      operationId: get_application_environment_size
      parameters:
        - name: application_id
          in: path
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: environment_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationEnvironmentSizeResponse'
          description: The environment's stored and running size
        '401':
          description: Authentication required
        '403':
          description: Application permission required
        '404':
          description: Application or environment not found
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    ApplicationEnvironmentSizeResponse:
      description: >-
        One environment's size: for each placement the reader reaches, the
        copies, CPU and memory stored for its next release and where each comes
        from, and what the cluster mirror says runs.
      properties:
        environment_id:
          type: string
          format: uuid
          description: >-
            The environment read, in the canonical spelling the environments
            read lists.
        read_state:
          type: string
          enum:
            - ok
            - partial
            - unknown
          description: >-
            ok: every placement the reader reaches is answered. partial: the
            environment also runs on clusters outside the reader's project, or a
            placement's stored or running values could not be read. unknown: the
            read could not be made at all; placements is then empty, which says
            nothing about the environment.
        cluster_outside_projects:
          type: boolean
          description: >-
            Set for a reader confined to a project (a project-only member, or a
            token pinned to a project while projects are on) on an environment
            that also deploys to a cluster outside that project: only the
            reader's own placements are listed. Absent for every other
            environment and for an organisation-wide reader.
        placements:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationEnvironmentSizePlacement'
          description: >-
            The environment's placements the reader reaches, installations
            first, at most 20.
        placements_capped:
          type: boolean
          description: >-
            True when the environment has more than 20 placements and the list
            was cut.
      required:
        - environment_id
        - read_state
        - placements
        - placements_capped
      title: ApplicationEnvironmentSizeResponse
      type: object
    ApplicationEnvironmentSizePlacement:
      description: One place the environment runs.
      properties:
        cluster_id:
          format: uuid
          type: string
        namespace:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            null for a stack placement, whose members carry their own
            namespaces.
        lane:
          type: string
          enum:
            - installation
            - stack
          description: >-
            installation: deployed through the application lane, sized by the
            deploy inputs Ankra stores. stack: deployed as a stack (the deploy
            wizard's, or a Helm add-on carrying the application's chart) and
            sized in that stack, so stored and running are null.
        parked:
          type: boolean
          description: >-
            The placement is parked: its stored copies are what park wrote, and
            parked_copies is what waking brings back.
        parked_copies:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The copy count waking brings back. null when not parked, or when the
            stored count is not a whole number.
        deploy_mode:
          anyOf:
            - type: string
              enum:
                - quick
                - high_availability
            - type: 'null'
          description: >-
            The stored deploy mode. null when the placement stores none Ankra
            knows.
        stored:
          anyOf:
            - $ref: '#/components/schemas/ApplicationEnvironmentStoredSize'
            - type: 'null'
          description: >-
            The five size inputs the next release renders. null for a stack
            placement, for an application-lane resource with no installation
            record, and when the stored inputs could not be read (read_state
            partial).
        running:
          anyOf:
            - $ref: '#/components/schemas/ApplicationEnvironmentRunningSize'
            - type: 'null'
          description: What the cluster mirror says runs. null for a stack placement.
        matches:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether Ankra's generated Deployment runs what is stored. null
            unless the running values were read fresh, exactly one listed
            Deployment is Ankra's generated one and is sized by Ankra, and no
            list was cut; then null as well when a value either side cannot
            state leaves the answer open.
      required:
        - cluster_id
        - namespace
        - lane
        - parked
        - parked_copies
        - deploy_mode
        - stored
        - running
        - matches
      title: ApplicationEnvironmentSizePlacement
      type: object
    ApplicationEnvironmentStoredSize:
      description: The five stored size inputs, by name. No other stored input is returned.
      properties:
        copies:
          $ref: '#/components/schemas/ApplicationEnvironmentStoredCopies'
        cpu_request:
          $ref: '#/components/schemas/ApplicationEnvironmentStoredCPU'
        cpu_limit:
          $ref: '#/components/schemas/ApplicationEnvironmentStoredCPU'
        memory_request:
          $ref: '#/components/schemas/ApplicationEnvironmentStoredMemory'
        memory_limit:
          $ref: '#/components/schemas/ApplicationEnvironmentStoredMemory'
      required:
        - copies
        - cpu_request
        - cpu_limit
        - memory_request
        - memory_limit
      title: ApplicationEnvironmentStoredSize
      type: object
    ApplicationEnvironmentRunningSize:
      description: >-
        What the cluster mirror says runs for a placement. Shown only on a
        cluster where the caller holds kubernetes.read, decided exactly as the
        cluster read decides it.
      properties:
        state:
          type: string
          enum:
            - read
            - stale
            - not_read
            - withheld
          description: >-
            read: every listed Deployment was seen within 15 minutes and since
            the placement last changed. stale: one was not; the values are what
            was last seen. not_read: the permission check could not be decided,
            the placement has no cluster-side resource to match workloads
            through, or the mirror could not be read. withheld: the caller does
            not hold kubernetes.read on the cluster. workloads is empty for
            not_read and withheld, which says nothing about what runs.
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            When the least recently seen listed Deployment was last seen. null
            when nothing is listed.
        workloads:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationEnvironmentSizeWorkload'
          description: >-
            The Deployments labelled for the placement's cluster-side resource
            in its namespace, Ankra's generated one first, then by name, at most
            10. Under read and stale, an empty list means the mirror holds no
            such Deployment; the mirror follows the cluster with a lag, so it is
            not proof that nothing runs.
        capped:
          type: boolean
          description: True when more than 10 Deployments were found and the list was cut.
      required:
        - state
        - observed_at
        - workloads
        - capped
      title: ApplicationEnvironmentRunningSize
      type: object
    ApplicationEnvironmentStoredCopies:
      description: The stored copy count as the render receives it.
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The value as the render receives it. null exactly when source is
            not_set; a blank stored value is "".
        source:
          type: string
          enum:
            - set
            - mode
            - default
            - not_set
          description: >-
            Where the value the next release renders comes from. set: a deploy
            supplied it and the placement stores it, a blank value included.
            mode: the copy count high availability implies, written onto Ankra's
            generated Deployment only (copies only). default: the default the
            application's option contract declares, which the render uses when
            nothing was set. not_set: nothing Ankra stores or declares sets it,
            so the workloads keep what their manifests say.
      required:
        - value
        - source
      title: ApplicationEnvironmentStoredCopies
      type: object
    ApplicationEnvironmentStoredCPU:
      description: A stored CPU quantity.
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The value as the render receives it. null exactly when source is
            not_set; a blank stored value is "".
        source:
          type: string
          enum:
            - set
            - mode
            - default
            - not_set
          description: >-
            Where the value the next release renders comes from. set: a deploy
            supplied it and the placement stores it, a blank value included.
            mode: the copy count high availability implies, written onto Ankra's
            generated Deployment only (copies only). default: the default the
            application's option contract declares, which the render uses when
            nothing was set. not_set: nothing Ankra stores or declares sets it,
            so the workloads keep what their manifests say.
        millicores:
          anyOf:
            - type: integer
              format: int64
            - type: 'null'
          description: >-
            value in millicores, rounded up as Kubernetes reads it. null when
            value is null, blank, negative or not a quantity.
      required:
        - value
        - source
        - millicores
      title: ApplicationEnvironmentStoredCPU
      type: object
    ApplicationEnvironmentStoredMemory:
      description: A stored memory quantity.
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The value as the render receives it. null exactly when source is
            not_set; a blank stored value is "".
        source:
          type: string
          enum:
            - set
            - mode
            - default
            - not_set
          description: >-
            Where the value the next release renders comes from. set: a deploy
            supplied it and the placement stores it, a blank value included.
            mode: the copy count high availability implies, written onto Ankra's
            generated Deployment only (copies only). default: the default the
            application's option contract declares, which the render uses when
            nothing was set. not_set: nothing Ankra stores or declares sets it,
            so the workloads keep what their manifests say.
        bytes:
          anyOf:
            - type: integer
              format: int64
            - type: 'null'
          description: >-
            value in bytes, rounded up as Kubernetes reads it. null when value
            is null, blank, negative or not a quantity.
      required:
        - value
        - source
        - bytes
      title: ApplicationEnvironmentStoredMemory
      type: object
    ApplicationEnvironmentSizeWorkload:
      description: One running Deployment.
      properties:
        name:
          type: string
        generated:
          type: boolean
          description: Ankra's generated Deployment (annotated ankra.io/generated).
        sized_by:
          type: string
          enum:
            - ankra
            - repository
          description: >-
            repository: annotated ankra.io/deploy-overrides: none, so it keeps
            the size its repository commits. ankra: the deploy writes the stored
            size onto it.
        copies_desired:
          anyOf:
            - type: integer
            - type: 'null'
          description: spec.replicas. null when the mirror does not carry it.
        copies_ready:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            status.readyReplicas, 0 when a written status omits it. null when
            the mirror carries no status.
        containers:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationEnvironmentSizeContainer'
          description: The pod template's containers, at most 10.
        containers_capped:
          type: boolean
          description: >-
            True when the template has more than 10 containers and the list was
            cut.
      required:
        - name
        - generated
        - sized_by
        - copies_desired
        - copies_ready
        - containers
        - containers_capped
      title: ApplicationEnvironmentSizeWorkload
      type: object
    ApplicationEnvironmentSizeContainer:
      description: One container's declared size in a Deployment's pod template.
      properties:
        name:
          type: string
        cpu_request:
          $ref: '#/components/schemas/ApplicationEnvironmentRunningCPU'
        cpu_limit:
          $ref: '#/components/schemas/ApplicationEnvironmentRunningCPU'
        memory_request:
          $ref: '#/components/schemas/ApplicationEnvironmentRunningMemory'
        memory_limit:
          $ref: '#/components/schemas/ApplicationEnvironmentRunningMemory'
      required:
        - name
        - cpu_request
        - cpu_limit
        - memory_request
        - memory_limit
      title: ApplicationEnvironmentSizeContainer
      type: object
    ApplicationEnvironmentRunningCPU:
      description: A declared CPU quantity.
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          description: The quantity the container declares. null when it declares none.
        millicores:
          anyOf:
            - type: integer
              format: int64
            - type: 'null'
          description: >-
            value in millicores, rounded up as Kubernetes reads it. null when
            value is null, blank, negative or not a quantity.
      required:
        - value
        - millicores
      title: ApplicationEnvironmentRunningCPU
      type: object
    ApplicationEnvironmentRunningMemory:
      description: A declared memory quantity.
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          description: The quantity the container declares. null when it declares none.
        bytes:
          anyOf:
            - type: integer
              format: int64
            - type: 'null'
          description: >-
            value in bytes, rounded up as Kubernetes reads it. null when value
            is null, blank, negative or not a quantity.
      required:
        - value
        - bytes
      title: ApplicationEnvironmentRunningMemory
      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.