> ## 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. # Set a decision proposal aside > Records that the caller declined the proposal, with their reason. Allowed from proposed, approved or held (withdraws the approval before anything ran) and failed. Gated on the area's permission: billing.manage for cost, security.manage for security. A cost proposal that changes one cluster (right_size, right_size_rollback, right_size_ladder, off_hours_schedule) may also be acted on by a caller who holds clusters.write on that cluster (at the organisation, in its project or on the cluster itself), the permission that resizing it or giving it a power schedule by hand takes; the event records the permission that authorised it as authorised_by. 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 post /api/v1/org/decisions/{decision_id}/set-aside 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 `. 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:} 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/decisions/{decision_id}/set-aside: post: tags: - Decisions summary: Set a decision proposal aside description: >- Records that the caller declined the proposal, with their reason. Allowed from proposed, approved or held (withdraws the approval before anything ran) and failed. Gated on the area's permission: billing.manage for cost, security.manage for security. A cost proposal that changes one cluster (right_size, right_size_rollback, right_size_ladder, off_hours_schedule) may also be acted on by a caller who holds clusters.write on that cluster (at the organisation, in its project or on the cluster itself), the permission that resizing it or giving it a power schedule by hand takes; the event records the permission that authorised it as authorised_by. 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: set_aside_decision_api_v1_org_decisions_set_aside_post parameters: - description: PAT organisation override. in: header name: x-ankra-organisation-id required: false schema: type: string - in: path name: decision_id required: true schema: format: uuid title: Decision Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DecisionNoteRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DecisionProposal' 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: the area's permission (billing.manage for cost, security.manage for security) is required, or for a cost change of one cluster clusters.write on that cluster, or the token may not use this surface. A proposal the area's permission held or set aside is released, set aside again or approved only with that permission, never with a cluster's clusters.write '404': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: >- Decision proposal not found, or outside the caller's reach (another project's, on a cluster the caller cannot read, or of the organisation as a whole for a caller confined to part of it) '409': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: >- The proposal's status does not allow a set-aside, or it changed while the request was in flight '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: DecisionNoteRequest: description: Optional body of the set-aside, hold and release routes. properties: note: maxLength: 2000 type: string title: DecisionNoteRequest type: object DecisionProposal: description: >- One proposal of the decision ledger: what it is about, what the surface computed, where it stands, who decided, and what running it did. properties: id: type: string format: uuid area: description: >- security or cost; decides which permission approving and running it takes. enum: - security - cost type: string kind: description: >- What the proposal does, e.g. addon_upgrade, image_rebuild, right_size, off_hours_schedule, waste_cleanup. Only kinds with a platform operation are executable. type: string subject: additionalProperties: true description: >- Identity of what the proposal is about (finding_id, cluster_id, addon_name, waste_finding_id ...), one document per kind. type: object summary: type: string plan: additionalProperties: true description: >- The steps the surface computed. plan.parameters is the machine half the executable kinds are called with: addon_upgrade takes {cluster_id, addon_name, chart_version}; off_hours_schedule takes {cluster_id, timezone, schedules: [{action, stop_mode, cron_expression}]}; waste_cleanup takes {waste_finding_id}. type: object plan_hash: description: >- The identity of the plan this read serves: SHA-256, in lowercase hex, of the plan's canonical JSON (object keys sorted, no insignificant whitespace), so plans equal as JSON values hash alike. Approve echoes it as plan_hash to name the plan the person read. pattern: ^[0-9a-f]{64}$ type: string evidence: type: object additionalProperties: true status: enum: - proposed - approved - held - set_aside - running - succeeded - failed - superseded type: string source: description: Which surface computed it (default "surface"). type: string created_by: anyOf: - type: string - type: 'null' description: Ankra user id of whoever posted it. decided_by: anyOf: - type: string - type: 'null' description: Ankra user id of the last approve or set-aside. decided_at: anyOf: - type: string format: date-time - type: 'null' approved_at: anyOf: - type: string format: date-time - type: 'null' description: >- When the approval the proposal stands on was given. An approval writes it; a hold or a release keeps it while decided_at takes their own time, so a cost approval's seven-day expiry counts from here, or on a ladder between its waves from its previous wave finishing. Null on a proposal nobody approved, after an approval expired, and on a proposal approved before this field existed, whose decided_at is its approval time if it was never held or released. decision_note: anyOf: - type: string - type: 'null' operation_id: anyOf: - type: string format: uuid - type: 'null' description: >- The platform execution a run dispatched, to watch under /api/v1/org/executions. receipt: anyOf: - $ref: '#/components/schemas/DecisionReceipt' - type: 'null' dedupe_key: type: string executable: description: >- Whether the platform has an operation for the kind, so a surface offers "run" only where running can work. type: boolean approval_blocked: anyOf: - type: string - type: 'null' description: >- Why approving this proposal would be refused because the platform could not carry it out: its kind has no operation, or its plan is one the operation refuses. It is the same sentence approve answers 422 with, so a surface shows it in place of an Approve action. Null when neither stands in the way; whether the status allows an approval is the status's own answer. A response without this field comes from a platform that did not say, and a client treats it as "may be approvable". can_decide: anyOf: - type: boolean - type: 'null' description: >- Whether the caller holds the authority to approve, set aside, hold and release this proposal: the organisation's permission for the area, or for a cost change of the one cluster the proposal acts on, the permission that governs that change held on that cluster. A cluster grant does not count on a proposal held or set aside on another authority. Read by the checks the decisions make, so a surface offers what they take; each decision checks again. It does not say whether the status allows a decision or whether the plan can run (executable, approval_blocked). Null: Ankra could not tell; do not offer the action, the platform decides when it is attempted. A response without the field comes from a platform that did not say, and a client treats it as null. can_run: anyOf: - type: boolean - type: 'null' description: >- Whether the caller may also run this proposal: can_decide, and the further permission running it takes, if any. A right-size or a right-size ladder needs clusters.write where the authority that let the decision through was held; the cleanup of a released persistent volume needs clusters.write on the volume's cluster, and one whose finding names no cluster can be run by no one (false for every caller); no other kind needs a further permission. Read by the checks execute makes; execute checks again. Null: Ankra could not tell; do not offer the action, the platform decides when it is attempted. expected_monthly_cents: anyOf: - type: integer - type: 'null' description: >- What the surface expected a cost proposal to save per month, in USD cents, recorded when it succeeded: plan.parameters.expected_monthly_cents, else evidence.expected_monthly_cents, each with an optional sibling expected_currency (ISO code, default usd) converted to USD. Zero, whatever it declared, for an off_hours_schedule whose every stop is a pause on a provider that bills a powered-off server at its full price (Hetzner, DigitalOcean, UpCloud): it saves no compute cost. Null when the proposal declared none, has not run, or is not a cost proposal; never zero for an unknown. baseline_monthly_cents: anyOf: - type: integer - type: 'null' description: >- The subject cluster's run rate before the change: the mean monthly_cost_estimate_cents of its cost snapshots over baseline_window, in USD cents. Null until a measurement opens, or when no snapshot covered the window. baseline_window: anyOf: - $ref: '#/components/schemas/DecisionTimeWindow' - type: 'null' description: >- The 24 hours before the change was dispatched, [from, to); to is when the change ran. measured_monthly_cents: anyOf: - type: integer - type: 'null' description: >- What the change measurably saved per month, in USD cents: baseline_monthly_cents minus the cluster's mean run rate over the week after the change. A right-size is measured on the node groups it changed instead: the per-node cost it took off, over the nodes the groups ran on both sides, never more than their drop. Negative when the run rate rose. Null unless measurement_status is measured. measured_at: anyOf: - type: string format: date-time - type: 'null' description: >- When the measurement loop wrote its verdict (measured, unmeasured or reverted). measurement_status: description: >- Where the measured outcome stands: not_applicable (not a cost proposal, not run, or no cluster to measure), pending (inside the seven-day verification window), measured, unmeasured_coverage_moved (the cluster was not priced the same way on both sides), unmeasured_no_snapshots (nothing to read on one side, too few of a week's hours metered, or the cluster is no longer priced), unmeasured_confounded (another measured cost change ran on the same cluster inside the span, so the drop is not this change's alone), unmeasured_within_noise (the change was no larger than the run rate's own day-to-day swing, so it cannot be told apart from it, or the run rate grew from nothing on a day; the swing compares each day of the week after with the same weekday of the week before, as an amount and as a share of that day, and holds the change to the tighter of the two, so a weekly pattern such as a power schedule cancels, and so does a change that takes the same amount or the same share off every day), reverted (the change was undone inside the window; an off-hours change is settled the hour its schedules are gone and the cluster is back to size). The activity feed's measured / unmeasured / reverted event carries the reason. enum: - not_applicable - pending - measured - unmeasured_coverage_moved - unmeasured_no_snapshots - reverted - unmeasured_confounded - unmeasured_within_noise type: string verify_until: anyOf: - type: string format: date-time - type: 'null' description: >- When the verification window closes: seven days after the change ran. The measurement loop settles the row once it has passed. subject_cluster_id: anyOf: - type: string format: uuid - type: 'null' description: >- The cluster whose cost snapshots measure the change: plan.parameters.cluster_id, else subject.cluster_id. 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. A day the cluster's power schedule had the group stopped throughout is off and left out: a window whose other days were clear passes, and a window that was off all seven days is unverified_no_metrics. 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 rollback_of: anyOf: - type: string format: uuid - type: 'null' description: >- On a right_size_rollback: the right-size it undoes, which reads measurement_status reverted once this rollback succeeds. parent_id: anyOf: - type: string format: uuid - type: 'null' description: >- On a wave of a right-size ladder (a right_size proposal with source ladder): the right_size_ladder proposal it belongs to. Null for every other proposal. created_at: type: string format: date-time updated_at: type: string format: date-time run_after: anyOf: - type: string format: date-time - type: 'null' description: >- The earliest time the cost autopilot may run a proposal it approved itself - the end of its pre-notice window, in which a person may hold it; null for a proposal a person approved, which a person runs. required: - id - area - kind - subject - summary - plan - plan_hash - evidence - status - source - created_by - decided_by - decided_at - approved_at - decision_note - operation_id - receipt - dedupe_key - executable - expected_monthly_cents - baseline_monthly_cents - baseline_window - measured_monthly_cents - measured_at - measurement_status - verify_until - subject_cluster_id - verification_status - verification_days - rollback_of - parent_id - created_at - updated_at - run_after title: DecisionProposal 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 DecisionReceipt: description: >- The record of running a proposal: who ran it and when, the platform operation it became, the steps taken and how it ended. properties: claimed_at: type: string format: date-time executed_by: type: string dispatched_at: type: string format: date-time operation_id: type: string format: uuid completed_at: type: string format: date-time execution_status: description: >- The platform execution's terminal status once a read settled it (success, failed, critical, cancelled). type: string steps: items: $ref: '#/components/schemas/DecisionReceiptStep' type: array verification_hours_off: additionalProperties: type: integer description: >- On a right-size, how many hours of each verification day (keyed by the day's number, "1" to "7") the cluster's power schedule had the group stopped, by the schedule's own recorded stops and starts. Those hours are left out of the verification. Absent when no hour was. type: object required: - steps title: DecisionReceipt type: object DecisionTimeWindow: description: A closed-open [from, to) interval. properties: from: type: string format: date-time to: type: string format: date-time required: - from - to title: DecisionTimeWindow 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, off when the cluster's power schedule had the group stopped for the whole day (left out of the verification), else clear. enum: - clear - breach - unknown - 'off' 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 hours_off: description: >- How many of the day's hours the cluster's power schedule had the group stopped, by the schedule's own recorded stops and starts, with no node of the group running through them. They are left out: the day is judged on the hours that ran, and a day with all 24 off is off. Absent when no hour was off. 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 - parked type: string required: - day - from - to - state - cpu_p95_share - memory_p95_share - nodes - reporting title: DecisionVerificationDay 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 DecisionReceiptStep: properties: name: type: string outcome: enum: - dispatched - succeeded - failed - refused - error - abandoned type: string detail: type: string evidence: type: object additionalProperties: true required: - name - outcome title: DecisionReceiptStep 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.