> ## 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. # Change a cost budget (bearer twin) > Changes a budget's name, amount, currency, owner or notify threshold; a field left out keeps its value and owner_user_id null clears the owner. A budget's scope never changes: naming scope_kind or scope_id is refused. Audited as update_cost_budget with what it replaced. Gated on billing.manage; the token stands in for the browser route's CSRF double-submit. 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 put /api/v1/org/cloud-cost/budgets/{budget_id} 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/budgets/{budget_id}: put: tags: - Cost summary: Change a cost budget (bearer twin) description: >- Changes a budget's name, amount, currency, owner or notify threshold; a field left out keeps its value and owner_user_id null clears the owner. A budget's scope never changes: naming scope_kind or scope_id is refused. Audited as update_cost_budget with what it replaced. Gated on billing.manage; the token stands in for the browser route's CSRF double-submit. 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: update_budget_api_v1_org_cloud_cost_put parameters: - description: PAT organisation override. in: header name: x-ankra-organisation-id required: false schema: type: string - description: The budget's id. in: path name: budget_id required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/BudgetUpdateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Budget' 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: Permission denied '404': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Budget not found '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: BudgetUpdateRequest: description: >- Body of PUT /api/v1/org/cloud-cost/budgets/{budget_id}; a field left out keeps its value, owner_user_id null clears the owner. properties: name: description: 1 to 120 characters. type: string monthly_cents: description: The budget in the currency's minor unit; positive. type: integer currency: description: One of the platform's convertible currencies. type: string owner_user_id: anyOf: - type: string format: uuid - type: 'null' description: An active member of the organisation the budget is for. notify_at_pct: default: 80 description: 1 to 100. type: integer title: BudgetUpdateRequest type: object additionalProperties: false Budget: description: A monthly cost budget for one scope with its month as of the read. properties: id: type: string format: uuid name: type: string scope_kind: enum: - organisation - cluster - environment - application type: string scope_id: anyOf: - type: string - type: 'null' description: >- The cluster or application id, or the environment label; null for the organisation. scope_name: description: >- What the scope is called now; empty for a cluster or application the organisation no longer has. type: string monthly_cents: description: The budget, in currency. type: integer currency: type: string owner_user_id: anyOf: - type: string format: uuid - type: 'null' description: Who the budget is for. notify_at_pct: description: >- The share of the budget the projection must reach for the budget's card (cost_budget_crossing) to be raised. type: integer created_by: type: string created_at: type: string format: date-time updated_at: type: string format: date-time month: description: The UTC month the projection is for, YYYY-MM. type: string projection: $ref: '#/components/schemas/BudgetProjection' required: - id - name - scope_kind - scope_id - scope_name - monthly_cents - currency - owner_user_id - notify_at_pct - created_by - created_at - updated_at - month - projection title: Budget 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 BudgetProjection: description: >- A budget's month as of the read, in the budget's currency. Every figure is null while the scope has no priced cluster (status unknown): an unread month is not a month with no spend. properties: status: description: >- under the notify threshold, approaching it, crossing (projected past the budget this month), over (already past it), or unknown (nothing priced to project from). enum: - under - approaching - crossing - over - unknown type: string month_to_date_cents: anyOf: - type: integer - type: 'null' description: Spent since the start of the UTC month. projected_month_end_cents: anyOf: - type: integer - type: 'null' description: Month to date plus the current run rate for the hours left. percent_of_budget: anyOf: - type: integer - type: 'null' description: The projected month end as a share of the budget, rounded. crossing_at: anyOf: - type: string format: date-time - type: 'null' description: The hour the pace crosses the budget; set only while crossing. running_savings_monthly_cents: anyOf: - type: integer - type: 'null' description: >- Monthly saving of the changes already approved or running on the scope's clusters; null while nothing in scope is priced. after_running_changes_cents: anyOf: - type: integer - type: 'null' description: >- Where the month lands once the running changes have landed, never below the month to date. priced_cluster_count: description: Clusters in scope with a current priced snapshot. type: integer unpriced_cluster_count: description: >- Clusters in scope with no snapshot this month inside the staleness window; their spend is not in the figures. type: integer complete: description: True when every cluster in scope is priced. type: boolean currency: description: The currency every cents figure is in (the budget's). type: string required: - status - month_to_date_cents - projected_month_end_cents - percent_of_budget - crossing_at - running_savings_monthly_cents - after_running_changes_cents - priced_cluster_count - unpriced_cluster_count - complete - currency title: BudgetProjection 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 ````