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

# Estimate what a change to an application costs

> Prices a proposed change to an application as the monthly change to its cost. A change to one deployment - its replica count, its per-pod CPU and memory requests, parking it, or promoting a build into it - is read from its object cost projection and moved by the metering's own allocation rule; a new environment or a database preset is priced on the cluster it would run on as the share that cluster's latest metering pass would have allocated it, compute only, so a floor. The answer carries the confidence of the snapshot it is read from and how it was reached. A change Ankra cannot price (a namespace another application shares, a cluster with no recent snapshot or none recording its capacity yet, a parked deployment's size, a workload the cluster has no room for) answers priced false with the reason, never zero. Nothing is stored. Bearer-PAT twin of the browser route of the same name under /org.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/applications/{application_id}/cost/estimate
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, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - 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: 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: 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}/cost/estimate:
    post:
      tags:
        - Cost
      summary: Estimate what a change to an application costs
      description: >-
        Prices a proposed change to an application as the monthly change to its
        cost. A change to one deployment - its replica count, its per-pod CPU
        and memory requests, parking it, or promoting a build into it - is read
        from its object cost projection and moved by the metering's own
        allocation rule; a new environment or a database preset is priced on the
        cluster it would run on as the share that cluster's latest metering pass
        would have allocated it, compute only, so a floor. The answer carries
        the confidence of the snapshot it is read from and how it was reached. A
        change Ankra cannot price (a namespace another application shares, a
        cluster with no recent snapshot or none recording its capacity yet, a
        parked deployment's size, a workload the cluster has no room for)
        answers priced false with the reason, never zero. Nothing is stored.
        Bearer-PAT twin of the browser route of the same name under /org.
      operationId: application_cost_estimate_api_v1_org_applications_post
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationCostEstimateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationCostEstimate'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Missing or malformed Authorization header, or a change the estimate
            cannot read (an unknown kind, a deployment kind without its cluster
            and namespace, a replica count out of range, an unreadable resource
            quantity)
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unknown, expired, or revoked API token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Token may not use this surface (MCP-scoped token or service account
            restriction)
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Application not found in the token's organisation, or not deployed
            to that cluster and namespace
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    ApplicationCostEstimateRequest:
      description: >-
        A proposed change to an application. For replicas, resources, park and
        promote, cluster_id and namespace name the deployment it changes and are
        required. For new_environment and database, cluster_id names the cluster
        the new workload would run on; without it the answer is not known.
      properties:
        change:
          description: The kind of change.
          enum:
            - replicas
            - resources
            - park
            - promote
            - new_environment
            - database
          type: string
        cluster_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            The cluster the deployment runs on, or for new_environment and
            database the cluster the new workload would run on.
        namespace:
          anyOf:
            - type: string
            - type: 'null'
          description: The namespace the deployment runs in.
        replicas:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The proposed replica count, for replicas (0 to 1000); for
            new_environment (1 to 1000) it replaces the application's own.
        cpu_request:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The proposed CPU request per pod, for resources (a Kubernetes
            quantity such as 500m); for new_environment it replaces the
            application's own.
        memory_request:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The proposed memory request per pod, for resources (a Kubernetes
            quantity such as 512Mi); for new_environment it replaces the
            application's own.
        service:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            For database, the managed service engine the preset installs, such
            as service-postgresql (the default).
        parameters:
          anyOf:
            - additionalProperties:
                type: integer
              type: object
            - type: 'null'
          description: >-
            For database, the preset's plan parameters, such as instances,
            cpu_millicores and memory_mib; the engine's defaults fill what is
            absent.
      required:
        - change
      title: ApplicationCostEstimateRequest
      type: object
    ApplicationCostEstimate:
      description: >-
        What a proposed change would do to the application's monthly cost.
        Priced false leaves monthly_delta_cents and confidence null and names
        why in unpriced_reason; a priced zero is a change that costs nothing.
      properties:
        change:
          type: string
        application_id:
          type: string
          format: uuid
        cluster_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        namespace:
          anyOf:
            - type: string
            - type: 'null'
        currency:
          description: >-
            The reader's display currency; every *_cents figure is in its minor
            units.
          type: string
        priced:
          type: boolean
        unpriced_reason:
          anyOf:
            - type: string
            - type: 'null'
        monthly_delta_cents:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            How much more (positive) or less (negative) the application would
            cost a month after the change.
        current_monthly_cents:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The deployment's cost a month today, compute and storage, as the
            object projection counts it; null when it is not known, and for a
            new environment or a database, which do not run yet.
        confidence:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The pricing coverage of the snapshot the figure is read from: high,
            medium or low.
        coverage_incomplete:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            The figure is a floor: the snapshot left something unpriced, or, for
            a new environment or a database, storage it would claim is not
            included.
        basis:
          anyOf:
            - type: string
            - type: 'null'
          description: How the figure was reached, in a sentence or two.
      required:
        - change
        - application_id
        - cluster_id
        - namespace
        - currency
        - priced
        - unpriced_reason
        - monthly_delta_cents
        - current_monthly_cents
        - confidence
        - coverage_incomplete
        - basis
      title: ApplicationCostEstimate
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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

````

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