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

# Measured outcomes of the organisation's cost decisions

> The measured outcomes of the organisation's cost decisions (`ankra cost ledger`): every cost proposal that was approved, is running or has run, with what the surface expected it to save, what was measured seven days after it ran (the subject cluster's mean run rate over the week before the change minus its mean over the week after it, from cost snapshots, never an estimate; unmeasured when another measured change on the cluster overlaps it), where the measurement stands and why it could not be made, in the caller's display currency. measured_total_cents sums measured rows only; running_total_cents sums the expectations of approved, running and still-verifying changes. Bearer-PAT twin of the browser route of the same name under /org.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/cloud-cost/ledger
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: 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: 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: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - 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:
  /api/v1/org/cloud-cost/ledger:
    get:
      tags:
        - Cost
      summary: Measured outcomes of the organisation's cost decisions
      description: >-
        The measured outcomes of the organisation's cost decisions (`ankra cost
        ledger`): every cost proposal that was approved, is running or has run,
        with what the surface expected it to save, what was measured seven days
        after it ran (the subject cluster's mean run rate over the week before
        the change minus its mean over the week after it, from cost snapshots,
        never an estimate; unmeasured when another measured change on the
        cluster overlaps it), where the measurement stands and why it could not
        be made, in the caller's display currency. measured_total_cents sums
        measured rows only; running_total_cents sums the expectations of
        approved, running and still-verifying changes. Bearer-PAT twin of the
        browser route of the same name under /org.
      operationId: cloud_cost_ledger_api_v1_org_cloud_cost_ledger_get
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCostLedgerResponse'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Missing or malformed Authorization header, or business validation
            error
        '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)
        '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:
    CloudCostLedgerResponse:
      description: >-
        The measured outcomes of the organisation's cost decisions, newest
        first. measured_total_cents sums measured rows only, never expectations;
        running_total_cents sums the expectations of the changes in flight
        (approved, running, or succeeded and still inside their verification
        window). An approved or running change holds no stored expectation until
        it succeeds, so it is counted, and its row's expected_monthly_cents
        filled, at what its surface stated; one that stated nothing is not
        counted and its row says null. A negative measured row counts against
        the total as it stands.
      properties:
        currency:
          type: string
        generated_at:
          type: string
          format: date-time
        measured_total_cents:
          type: integer
        month:
          description: The UTC calendar month measured_this_month_cents covers, as YYYY-MM.
          type: string
        measured_this_month_cents:
          description: >-
            measured_total_cents restricted to the rows measured in the current
            UTC calendar month (month): the figure a "saved this month" reading
            shows. Aggregated over every row, like the other totals.
          type: integer
        running_total_cents:
          type: integer
        counts:
          $ref: '#/components/schemas/CloudCostLedgerCounts'
        rows:
          items:
            $ref: '#/components/schemas/CloudCostLedgerRow'
          type: array
        truncated:
          description: >-
            True when the organisation holds more rows than the read returns
            (the newest 500); the totals and counts still cover every row.
          type: boolean
      required:
        - currency
        - generated_at
        - measured_total_cents
        - month
        - measured_this_month_cents
        - running_total_cents
        - counts
        - rows
        - truncated
      title: CloudCostLedgerResponse
      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
    CloudCostLedgerCounts:
      description: How many ledger rows sit in each measurement state.
      properties:
        pending:
          type: integer
        measured:
          type: integer
        unmeasured:
          description: unmeasured_coverage_moved and unmeasured_no_snapshots together.
          type: integer
        reverted:
          type: integer
      required:
        - pending
        - measured
        - unmeasured
        - reverted
      title: CloudCostLedgerCounts
      type: object
    CloudCostLedgerRow:
      description: >-
        One cost decision the organisation approved and what it did to the
        money. Money is in the response currency; a figure that is not known is
        null, never zero.
      properties:
        decision_id:
          type: string
          format: uuid
        cluster_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            The cluster whose cost snapshots measure the change; null when the
            proposal named none.
        cluster_name:
          anyOf:
            - type: string
            - type: 'null'
        lever:
          description: >-
            The proposal kind: off_hours_schedule, right_size, waste_cleanup and
            the rest.
          type: string
        summary:
          type: string
        status:
          description: The ledger status of the decision.
          enum:
            - approved
            - running
            - succeeded
          type: string
        expected_monthly_cents:
          anyOf:
            - type: integer
            - type: 'null'
        baseline_monthly_cents:
          anyOf:
            - type: integer
            - type: 'null'
        measured_monthly_cents:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Set only when measurement_status is measured; negative when the run
            rate rose.
        measurement_status:
          enum:
            - not_applicable
            - pending
            - measured
            - unmeasured_coverage_moved
            - unmeasured_no_snapshots
            - reverted
            - unmeasured_confounded
          type: string
        measurement_reason:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The sentence the measurement loop left when it could not measure the
            row or found the change reverted; null while pending or once
            measured.
        days:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Whole days of the verification window behind the row: 7 once
            measured, the days so far while pending, null when no measurement
            was opened.
        decided_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        executed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the change was dispatched (the end of the baseline window).
        verify_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        verification_status:
          description: >-
            Where a right-size's seven-day verification stands
            (ankra-cozgu.1.2): verifying until every day is judged, passed when
            all seven were clear, failed on the first day any node of the group
            ran p95 CPU over 60% or p95 memory over 70% of capacity (a
            right_size_rollback proposal is filed), unverified_no_metrics when
            no day tripped but at least one could not be read. not_applicable
            for every other proposal.
          enum:
            - not_applicable
            - verifying
            - passed
            - failed
            - unverified_no_metrics
          type: string
        verification_days:
          description: >-
            The judged verification days in order, empty until the first 24h
            after the dispatch has been read.
          items:
            $ref: '#/components/schemas/DecisionVerificationDay'
          type: array
        measured_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - decision_id
        - cluster_id
        - cluster_name
        - lever
        - summary
        - status
        - expected_monthly_cents
        - baseline_monthly_cents
        - measured_monthly_cents
        - measurement_status
        - measurement_reason
        - days
        - decided_at
        - executed_at
        - verify_until
        - measured_at
        - verification_status
        - verification_days
      title: CloudCostLedgerRow
      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
    DecisionVerificationDay:
      description: >-
        One judged 24h day of a right-size's verification, counted from the
        dispatch. Each hour of it is checked as it completes (CPU saturation,
        memory, Pending pods, OOM kills, restarts), and a trip in any hour ends
        the day as a breach.
      properties:
        day:
          description: 1 for the 24h after the dispatch, up to 7.
          type: integer
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
        state:
          description: >-
            breach when any node of the group ran over a threshold, unknown when
            any node reported nothing and none breached, else clear.
          enum:
            - clear
            - breach
            - unknown
          type: string
        cpu_p95_share:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The highest p95 CPU share of capacity among the nodes that reported
            (0.61 is 61%); null when none reported CPU.
        memory_p95_share:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The highest p95 memory share of capacity among the nodes that
            reported; null when none reported memory.
        hottest_node:
          description: The node furthest past (or closest to) its threshold.
          type: string
        nodes:
          type: integer
        reporting:
          description: >-
            How many of the nodes the metrics store answered for on both
            resources.
          type: integer
        reason:
          description: Why the day is unknown, or what tripped it.
          type: string
        hours_unknown:
          description: >-
            How many of the day's hours could not be read; any makes the day
            unknown. Absent when every hour was read.
          type: integer
        tripped_hour:
          description: >-
            The window hour (1 for the hour after the dispatch, up to 168) whose
            hourly check tripped the day; absent for a day judged on its
            whole-day p95.
          type: integer
        signal:
          description: What tripped the day's hour, or why it is unknown.
          enum:
            - cpu_saturation
            - memory
            - pending_pods
            - oom_kills
            - restarts
            - node_coverage
            - store_gap
            - no_nodes
          type: string
      required:
        - day
        - from
        - to
        - state
        - cpu_p95_share
        - memory_p95_share
        - nodes
        - reporting
      title: DecisionVerificationDay
      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.