> ## 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 the cost autopilot policy (bearer twin) > How much Ankra may do about cost unasked (`ankra cost autopilot`): the tier each environment kind defaults to, the quiet hours and notification route of the autopilot's pre-notices, the four tiers with what each lets Ankra do, and every live cluster with its tier, whether an override or its environment set it, and the sentence a card shows for it. An organisation that never set a policy reads is_set false and Hands-off for every kind; recommended_defaults is the policy the Autopilot view offers to turn on. Any member can read it. Bearer-PAT twin of the browser route of the same name under /org; the console's session cookie is not accepted here and the browser route answers a token with a login redirect. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/cloud-cost/autopilot openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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: 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: 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 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: 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: 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/cloud-cost/autopilot: get: tags: - Cost summary: Get the cost autopilot policy (bearer twin) description: >- How much Ankra may do about cost unasked (`ankra cost autopilot`): the tier each environment kind defaults to, the quiet hours and notification route of the autopilot's pre-notices, the four tiers with what each lets Ankra do, and every live cluster with its tier, whether an override or its environment set it, and the sentence a card shows for it. An organisation that never set a policy reads is_set false and Hands-off for every kind; recommended_defaults is the policy the Autopilot view offers to turn on. Any member can read it. Bearer-PAT twin of the browser route of the same name under /org; the console's session cookie is not accepted here and the browser route answers a token with a login redirect. operationId: cost_autopilot_policy_api_v1_org_cloud_cost_autopilot_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/CostAutopilotPolicy' 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: CostAutopilotPolicy: description: >- The organisation's cost autopilot policy and every live cluster's tier under it. properties: clusters: items: $ref: '#/components/schemas/CostAutopilotCluster' type: array defaults: additionalProperties: enum: - hands-off - scheduled - managed - ephemeral type: string description: The tier each environment kind defaults to; every kind is present. type: object environment_kinds: items: enum: - production - staging - development - preview - unknown type: string type: array is_set: description: >- False for an organisation that never set a policy: every kind is then Hands-off. type: boolean notification_route_id: anyOf: - type: string format: uuid - type: 'null' description: >- The route the autopilot's pre-notices go to; null for the organisation's default routing. quiet_hours: anyOf: - $ref: '#/components/schemas/CostAutopilotQuietHours' - type: 'null' description: When the autopilot starts no change of its own; null for none. recommended_defaults: additionalProperties: enum: - hands-off - scheduled - managed - ephemeral type: string description: The policy the Autopilot view offers to turn on. type: object tiers: items: $ref: '#/components/schemas/CostAutopilotTier' type: array updated_at: anyOf: - type: string format: date-time - type: 'null' description: Null until a policy is set. updated_by: anyOf: - type: string - type: 'null' description: The Ankra user id of the last change; null until a policy is set. required: - is_set - defaults - recommended_defaults - quiet_hours - notification_route_id - updated_by - updated_at - environment_kinds - tiers - clusters title: CostAutopilotPolicy 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 CostAutopilotCluster: description: >- A live cluster's cost autopilot tier and why: one row of the Autopilot view's table. properties: cluster_id: type: string format: uuid cluster_name: type: string environment: description: The cluster's environment label as stored. type: string environment_kind: enum: - production - staging - development - preview - unknown type: string description: >- The kind the label maps to; an empty or unrecognised label is unknown. override: anyOf: - $ref: '#/components/schemas/CostAutopilotOverride' - type: 'null' description: The override that set the tier; null when the environment did. reason: description: >- The sentence a card shows, for example 'eu-production is Hands-off as a production cluster, so every change waits for a person.' type: string source: description: What set the tier. enum: - override - environment type: string tier: enum: - hands-off - scheduled - managed - ephemeral type: string required: - cluster_id - cluster_name - environment - tier - source - environment_kind - reason - override title: CostAutopilotCluster type: object CostAutopilotQuietHours: additionalProperties: false description: >- A daily window in the given timezone; an end before the start runs past midnight. properties: end: description: 24-hour HH:MM. pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ type: string start: description: 24-hour HH:MM. pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ type: string timezone: description: An IANA timezone, for example Europe/Stockholm. type: string required: - start - end - timezone title: CostAutopilotQuietHours type: object CostAutopilotTier: description: What a tier lets Ankra do, from docs/cost/cost-centre-north-star.md. properties: applies_to: type: string does: description: What Ankra does on its own. type: string name: type: string proposes: description: What Ankra proposes instead of doing. type: string rollback_window: type: string tier: enum: - hands-off - scheduled - managed - ephemeral type: string required: - tier - name - applies_to - does - proposes - rollback_window title: CostAutopilotTier 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 CostAutopilotOverride: description: A tier a person set on one cluster, active until expires_at. properties: expires_at: anyOf: - type: string format: date-time - type: 'null' description: When the override stops applying; null for never. reason: type: string set_at: type: string format: date-time set_by: description: The Ankra user id of the person who set it. type: string tier: enum: - hands-off - scheduled - managed - ephemeral type: string required: - tier - reason - set_by - set_at - expires_at title: CostAutopilotOverride type: object securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ````