# Akua | Docs - [Welcome to Akua](https://docs.akua.dev/index.md): Get started with Akua - connect agents, deploy applications, manage infrastructure, and sell cloud-native software - [Get started](https://docs.akua.dev/get-started.md): Try Akua in your browser: create a workspace, get a free trial machine, install n8n, and ask the agent. - [Platform capabilities](https://docs.akua.dev/capabilities.md): How the Akua product catalog maps to the docs - [Quickstart](https://docs.akua.dev/quickstart.md): Start from one prompt and let your coding agent install, authenticate, and operate the Akua CLI with you - [Agent Setup](https://docs.akua.dev/agent-setup.md): Let a coding agent install and operate the Akua CLI with optional MCP context - [Delivery](https://docs.akua.dev/delivery.md): Package applications, deliver installations, and manage customer install changes - [Installations](https://docs.akua.dev/installs.md): Install, version-control, and customize applications on your clusters - [Operate an installation](https://docs.akua.dev/installs/operations.md): Check health, inspect logs, review changes, and roll back an Akua installation - [Installation lifecycle](https://docs.akua.dev/installs/lifecycle.md): The Installation as a living resource: create, render, observe status, pods, and logs, then delete - [Concepts](https://docs.akua.dev/concepts.md): How packages, dependencies, products, and installations fit together - [Packages](https://docs.akua.dev/packages.md): Versioned install definitions that power products, offers, and direct installs - [Package repositories](https://docs.akua.dev/packages/repositories.md): How authored source becomes an immutable, Akua-hosted Package version - [Akua](https://docs.akua.dev/akua/index.md): The packaging substrate behind every Akua installation - [Why typed and sandboxed](https://docs.akua.dev/akua/why.md): The two problems akua solves for Helm and Kustomize users: untyped templates and renderers with your machine authority - [Typed resources](https://docs.akua.dev/akua/typed-resources.md): Type every resource a Package emits against a pinned Kubernetes version and the CRDs it depends on - [Package format](https://docs.akua.dev/akua/package-format.md): Authoring an akua Package: the Input schema, @ui annotations, and composition - [Docker Compose to Kubernetes converter](https://docs.akua.dev/tools/compose-converter.md): Convert Docker Compose files to Kubernetes manifests and Helm charts - [Customizing values](https://docs.akua.dev/customizing-values.md): Configure and customize your applications using inputs and per-installation overrides - [Installation repositories](https://docs.akua.dev/installs/repositories.md): The git-backed model behind every Akua installation: what it stores, why it works this way, and how to use it - [Customize an installation via git](https://docs.akua.dev/installs/install-repo.md): Understand the git repository behind an installation: change inputs, override resources, and roll out reviewed updates - [Repository change requests](https://docs.akua.dev/installs/repository-change-requests.md): Review proposed changes to an installation before they reach production: who proposes, who accepts, and how external proposers get a scoped token - [Package generation](https://docs.akua.dev/installs/chart-generation.md): How Akua turns your product configuration into a per-install repository - [Package versioning](https://docs.akua.dev/installs/versioning.md): How installation packages track changes and how to roll back installs - [Compute](https://docs.akua.dev/compute.md): Provision, autoscale, suspend, and manage the machines that run your workloads - [Clusters](https://docs.akua.dev/clusters.md): Understand how clusters work in Akua for deploying and managing your applications - [Create a Managed Cluster](https://docs.akua.dev/clusters/create.md): Start provisioning a managed Kubernetes control plane for your workers - [Add workers](https://docs.akua.dev/clusters/add-workers.md): Connect compute capacity to your managed cluster to run applications - [Import a cluster](https://docs.akua.dev/clusters/import.md): Connect your existing Kubernetes infrastructure - [Local testing](https://docs.akua.dev/clusters/local-testing.md): Test your applications locally with Multipass before deploying to production - [Regions](https://docs.akua.dev/clusters/regions.md): Understand how regions organize clusters for customer selection - [Compute](https://docs.akua.dev/compute/overview.md): Provision and manage cloud servers for your Kubernetes clusters - [Machines](https://docs.akua.dev/compute/machines.md): Akua-managed compute that provisions and manages worker nodes for you - [Hetzner Cloud](https://docs.akua.dev/compute/providers/hetzner.md): EU and US cloud servers — the first compute provider supported by Akua - [Limits and pricing](https://docs.akua.dev/clusters/limits.md): Which Akua limits apply to clusters, compute, and storage - [Storage](https://docs.akua.dev/storage.md): Choose persistent storage for the applications running in your clusters - [Storage](https://docs.akua.dev/clusters/storage.md): Add persistent storage to your clusters so applications can store data that survives restarts and upgrades - [Local Path Provisioner](https://docs.akua.dev/clusters/storage/local-path.md): Direct local disk storage for development, single-node setups, and latency-sensitive workloads - [Piraeus (LINSTOR)](https://docs.akua.dev/clusters/storage/piraeus.md): Replicated block storage across multiple nodes for production workloads - [Networking](https://docs.akua.dev/networking.md): Routes, gateways, and domains for your applications - [Preview domains](https://docs.akua.dev/networking/preview-domains.md): Get instant *.akua.run URLs for installations with no DNS setup - [Direct IP](https://docs.akua.dev/networking/direct-ip.md): Route traffic directly to your worker nodes using Gateway API and DNS - [Cloudflare Tunnel](https://docs.akua.dev/networking/cloudflare-tunnel.md): Use your own Cloudflare account to route custom domains to your cluster — no public IPs required - [Commerce](https://docs.akua.dev/commerce.md): Sell products, share private offers, and guide customers through checkout - [Sellable products](https://docs.akua.dev/products.md): Wrap a Package into a sellable product for the marketplace or private offers - [Offers](https://docs.akua.dev/marketplace/offers.md): Short customer URLs with selected inputs, access rules, and checkout flow - [Offer channels](https://docs.akua.dev/marketplace/offer-channels.md): Governed distribution paths that let partners, private audiences, and beta cohorts carry your offers under reviewed commercial terms - [Order drafts](https://docs.akua.dev/marketplace/order-drafts.md): The state machine a customer moves through from opening an offer to a live installation - [Platform](https://docs.akua.dev/platform.md): Manage workspaces, organizations, billing, security, notifications, quotas, and cloud ownership - [Workspaces](https://docs.akua.dev/workspaces.md): How organizations contain workspaces, and how workspaces isolate clusters, products, billing, and installations - [Organizations](https://docs.akua.dev/platform/organizations.md): Give your company a shared identity, centralized member management, and the ability to manage customer workspaces on their behalf - [Notifications](https://docs.akua.dev/platform/notifications.md): Stay informed about important events in your Akua account - [Custom dashboards](https://docs.akua.dev/dashboards/custom-dashboards.md): Build live monitoring dashboards from reusable code snippets - [Pricing](https://docs.akua.dev/pricing.md): Compare Akua plans, understand usage-based billing, and find the right tier for your workloads - [Billing](https://docs.akua.dev/billing/overview.md): Manage your workspace subscription and understand how billing works - [Plan tiers](https://docs.akua.dev/billing/tiers.md): How your plan tier is resolved and how it affects quotas, instance types, and machine lifecycle - [Enterprise](https://docs.akua.dev/billing/enterprise.md): Custom limits, dedicated support, and compliance for organizations with larger requirements - [Security](https://docs.akua.dev/platform/security.md): How Akua isolates workloads, protects data, and keeps your infrastructure secure - [Bring your own cloud](https://docs.akua.dev/platform/byoc.md): How Akua splits ownership between its managed control plane, your workers, and your cloud credentials - [Private container registries](https://docs.akua.dev/platform/private-registries.md): Configure authentication for private container registries to install applications with private images - [Quotas and limits](https://docs.akua.dev/platform/quotas.md): How Akua manages resource limits, provisioning speed, and API usage - [Agents](https://docs.akua.dev/agents/index.md): Use your own coding agent with Akua and check hosted-agent availability - [Changelog](https://docs.akua.dev/changelog.md): Product updates and announcements - [Introduction](https://docs.akua.dev/apis/introduction.md): Programmatic access to Akua resources for automation, CLI tools, and integrations - [Authentication](https://docs.akua.dev/apis/authentication.md): Authenticate with the Akua API using session tokens, workspace API tokens, or JWTs - [Domain routing API](https://docs.akua.dev/apis/domain-routing.md): Manage workspace subdomains, preview hostnames, and custom domains through the public API - [OpenAPI specification](https://docs.akua.dev/apis/openapi.md): Download the spec, generate type-safe clients, and stay in sync with API changes - [Explain an access decision](https://docs.akua.dev/api-reference/access-decisions/explain-an-access-decision.md): Explains whether the authenticated requester can perform an access action and why. - [Explain multiple access decisions](https://docs.akua.dev/api-reference/access-decisions/explain-multiple-access-decisions.md): Explains an ordered batch of access actions for the authenticated requester. - [List API tokens](https://docs.akua.dev/api-reference/api-tokens/list-api-tokens.md): Returns metadata for the workspace's API tokens. Full token values are never shown after creation. - [Create an API token](https://docs.akua.dev/api-reference/api-tokens/create-an-api-token.md): Creates a workspace API token. The full plaintext token is returned in the response and never shown again - store it securely. - [Revoke an API token](https://docs.akua.dev/api-reference/api-tokens/revoke-an-api-token.md): Revokes a workspace API token. The token immediately stops authenticating requests. - [List Cloudflare credentials](https://docs.akua.dev/api-reference/cloudflare/list-cloudflare-credentials.md): Returns Cloudflare credentials for the workspace. API tokens are never exposed. - [Create Cloudflare credential](https://docs.akua.dev/api-reference/cloudflare/create-cloudflare-credential.md): Adds a Cloudflare API credential to the workspace. The API token is stored as a platform Secret and is never returned. - [Delete Cloudflare credential](https://docs.akua.dev/api-reference/cloudflare/delete-cloudflare-credential.md): Permanently removes a Cloudflare credential. Active gateways using it must be deleted first. - [List clusters](https://docs.akua.dev/api-reference/clusters/list-clusters.md): Lists clusters visible to the authenticated workspace owner. - [Create cluster](https://docs.akua.dev/api-reference/clusters/create-cluster.md): Creates a managed cluster and returns an async Operation envelope. State for in-flight operations is eventually consistent and may lag actual execution by a few seconds. State for completed operations (`done: true`) is immutable. If you supply an Idempotency-Key and the workflow starts before its Op… - [Get cluster](https://docs.akua.dev/api-reference/clusters/get-cluster.md): Gets a cluster by id. - [Delete cluster](https://docs.akua.dev/api-reference/clusters/delete-cluster.md): Tears down the cluster asynchronously after active installs, managed workers, and machine snapshots have been removed. Returns an Operation envelope. Caller must be a workspace owner. - [Update cluster](https://docs.akua.dev/api-reference/clusters/update-cluster.md): Updates editable cluster fields. - [Import cluster](https://docs.akua.dev/api-reference/clusters/import-cluster.md): Imports an existing cluster from kubeconfig. - [Get cluster capabilities](https://docs.akua.dev/api-reference/clusters/get-cluster-capabilities.md): Gets the last observed Kubernetes capability snapshot for a cluster. - [Refresh cluster capabilities](https://docs.akua.dev/api-reference/clusters/refresh-cluster-capabilities.md): Refreshes observed cluster capability facts. The API returns an Operation envelope because cluster inspection runs asynchronously. - [Suspend cluster](https://docs.akua.dev/api-reference/clusters/suspend-cluster.md): Suspends a running cluster. The API returns an Operation envelope because teardown and drain are asynchronous. - [Resume cluster](https://docs.akua.dev/api-reference/clusters/resume-cluster.md): Resumes a suspended cluster and returns an async Operation envelope. - [Get cluster kubeconfig](https://docs.akua.dev/api-reference/clusters/get-cluster-kubeconfig.md): Returns a cluster admin kubeconfig for workspace owners and admins. Successful credential disclosure is fail-closed on a cluster-scoped audit record. - [Proxy cluster API](https://docs.akua.dev/api-reference/clusters/proxy-cluster-api.md): Proxy kube-apiserver traffic through the public API. The path parameter is forwarded verbatim to upstream. - [Execute command in cluster](https://docs.akua.dev/api-reference/clusters/execute-command-in-cluster.md): Runs a structured command in a pod and returns the result inline. No LRO wrapper by design. - [List cluster worker bootstraps](https://docs.akua.dev/api-reference/clusters/list-cluster-worker-bootstraps.md): Lists worker-bootstrap tokens for the cluster. Cursor-paginated. Includes revoked / expired tokens by default — filter via the `status` query when implemented. - [Create worker bootstrap](https://docs.akua.dev/api-reference/clusters/create-worker-bootstrap.md): Issues a new worker-bootstrap row and returns its metadata. - [Get cluster worker bootstrap](https://docs.akua.dev/api-reference/clusters/get-cluster-worker-bootstrap.md): Returns a single worker-bootstrap token by ID, including its current status and expiry timestamp. - [Revoke worker bootstrap](https://docs.akua.dev/api-reference/clusters/revoke-worker-bootstrap.md): Starts an asynchronous revoke of a worker bootstrap token. The bootstrap is soft-revoked immediately; k0s token invalidation completes when the managed control plane is reachable. - [Get cluster compute settings](https://docs.akua.dev/api-reference/clusters/get-cluster-compute-settings.md): Returns autoscaling state, current machine usage, the configured limit, and the etag required for updates. - [Update cluster compute settings](https://docs.akua.dev/api-reference/clusters/update-cluster-compute-settings.md): Updates autoscaling or machine limits. If-Match is required and must contain the etag from the latest settings response. - [List compute configs](https://docs.akua.dev/api-reference/computeconfigs/list-compute-configs.md): Lists compute configs in the workspace. - [Create compute config](https://docs.akua.dev/api-reference/computeconfigs/create-compute-config.md): Creates a compute config row. - [Get compute config](https://docs.akua.dev/api-reference/computeconfigs/get-compute-config.md): Returns a compute config by ID. - [Delete compute config](https://docs.akua.dev/api-reference/computeconfigs/delete-compute-config.md): Deletes a compute config. - [Update compute config](https://docs.akua.dev/api-reference/computeconfigs/update-compute-config.md): Updates mutable fields of a compute config. - [List custom domains](https://docs.akua.dev/api-reference/custom-domains/list-custom-domains.md): Lists custom domains belonging to a workspace. - [Create custom domain](https://docs.akua.dev/api-reference/custom-domains/create-custom-domain.md): Creates a custom domain and starts routing reconciliation. - [Get custom domain](https://docs.akua.dev/api-reference/custom-domains/get-custom-domain.md): Returns one custom domain belonging to a workspace. - [Delete custom domain](https://docs.akua.dev/api-reference/custom-domains/delete-custom-domain.md): Starts a workflow that releases a custom domain. - [Update custom domain](https://docs.akua.dev/api-reference/custom-domains/update-custom-domain.md): Updates mutable custom domain routing settings. - [List dashboards in workspace](https://docs.akua.dev/api-reference/dashboards/list-dashboards-in-workspace.md): Returns all dashboards belonging to the workspace specified in the workspace context. - [Create dashboard](https://docs.akua.dev/api-reference/dashboards/create-dashboard.md): Creates a dashboard in the workspace, optionally with an ordered set of initial snippet widgets. Blank dashboards remain valid. - [Get the workspace overview dashboard](https://docs.akua.dev/api-reference/dashboards/get-the-workspace-overview-dashboard.md): Returns the unique shared Workspace overview and its ordered widget configuration. - [Get dashboard details](https://docs.akua.dev/api-reference/dashboards/get-dashboard-details.md): Returns a dashboard including its widget layout and snippet references. - [Delete dashboard](https://docs.akua.dev/api-reference/dashboards/delete-dashboard.md): Permanently deletes a dashboard. Referenced snippets are not affected. - [Update dashboard](https://docs.akua.dev/api-reference/dashboards/update-dashboard.md): Update dashboard metadata. Widget mutations use the `/widgets` sub-collection. - [List dashboard revisions](https://docs.akua.dev/api-reference/dashboards/list-dashboard-revisions.md): Lists immutable dashboard revisions from newest to oldest. - [Create dashboard revision](https://docs.akua.dev/api-reference/dashboards/create-dashboard-revision.md): Atomically saves and activates a complete ordered dashboard snapshot as one immutable revision. - [Get dashboard revision](https://docs.akua.dev/api-reference/dashboards/get-dashboard-revision.md): Returns one immutable dashboard revision and its snippet version drift. - [Restore dashboard revision](https://docs.akua.dev/api-reference/dashboards/restore-dashboard-revision.md): Restores an immutable snapshot by creating and activating a new dashboard revision. - [Reset the Workspace overview to the recommended configuration](https://docs.akua.dev/api-reference/dashboards/reset-the-workspace-overview-to-the-recommended-configuration.md): Replaces the shared Workspace overview configuration with the current recommended built-ins and creates one immutable revision. - [List dashboard widgets](https://docs.akua.dev/api-reference/dashboards/list-dashboard-widgets.md): Lists widgets for a dashboard. - [Create dashboard widget](https://docs.akua.dev/api-reference/dashboards/create-dashboard-widget.md): Creates a widget as a child resource under a dashboard. - [Get dashboard widget](https://docs.akua.dev/api-reference/dashboards/get-dashboard-widget.md): Returns a single dashboard widget. - [Delete dashboard widget](https://docs.akua.dev/api-reference/dashboards/delete-dashboard-widget.md): Deletes a dashboard widget. Snippet references are preserved. - [Update dashboard widget](https://docs.akua.dev/api-reference/dashboards/update-dashboard-widget.md): Updates widget placement and display settings. - [List installs](https://docs.akua.dev/api-reference/installs/list-installs.md): Lists installs in the current workspace. With `product_id`, lists installs attributed to that product for product-owner support visibility, newest first. - [Create install](https://docs.akua.dev/api-reference/installs/create-install.md): Creates a product-based or direct installation. Akua processes the installation in the background and returns an Operation envelope to poll for progress. If you supply an Idempotency-Key and the workflow starts before its Operation is visible, retry with the same key to retrieve the same Operation. - [Get install details](https://docs.akua.dev/api-reference/installs/get-install-details.md): Returns current install metadata. - [Delete install](https://docs.akua.dev/api-reference/installs/delete-install.md): Deletes an install and cascades resource cleanup asynchronously. Returns an Operation envelope to poll for progress. If the workflow starts before its Operation is visible, retry with the same Idempotency-Key. - [Update install version](https://docs.akua.dev/api-reference/installs/update-install-version.md): Requests a selected PackageVersion from the same Package. The current version changes only after the new git-backed render deploys successfully. - [Restore install render](https://docs.akua.dev/api-reference/installs/restore-install-render.md): Restores a prior successful same-Package render by copying its git tree into a new forward commit. Existing git history is never rewritten. - [Set automatic install updates](https://docs.akua.dev/api-reference/installs/set-automatic-install-updates.md): Enables or disables automatic PackageVersion updates for one install. - [List install renders](https://docs.akua.dev/api-reference/installs/list-install-renders.md): Lists render artifacts for an install. - [Create install render](https://docs.akua.dev/api-reference/installs/create-install-render.md): Starts a render attempt and records the resulting render artifact metadata. - [Get install render](https://docs.akua.dev/api-reference/installs/get-install-render.md): Returns a single render artifact. - [Get install status](https://docs.akua.dev/api-reference/installs/get-install-status.md): Returns the live install deploy status for dashboards and health checks. - [List install pods](https://docs.akua.dev/api-reference/installs/list-install-pods.md): Returns current pod names and containers for the install. - [Stream install logs](https://docs.akua.dev/api-reference/installs/stream-install-logs.md): Streams log output for an install via Server-Sent Events. Use `Accept: text/event-stream`. - [List machines](https://docs.akua.dev/api-reference/machines/list-machines.md): Lists all machines in the workspace. - [Create machine](https://docs.akua.dev/api-reference/machines/create-machine.md): Creates a machine and returns a long-running operation envelope. - [Get machine](https://docs.akua.dev/api-reference/machines/get-machine.md): Returns a machine by ID. - [Delete machine](https://docs.akua.dev/api-reference/machines/delete-machine.md): Deletes a machine and returns a long-running operation envelope. - [Update machine](https://docs.akua.dev/api-reference/machines/update-machine.md): Updates machine metadata. - [Suspend machine](https://docs.akua.dev/api-reference/machines/suspend-machine.md): Suspends a machine and returns a long-running operation envelope. On providers that recycle instances during suspension, the machine ID stays stable but the public IP usually changes on resume unless a floating IP is attached. - [Resume machine](https://docs.akua.dev/api-reference/machines/resume-machine.md): Resumes a suspended machine and returns a long-running operation envelope. The machine ID stays stable, but provider_resource.public_ip can change after resume on providers that recycle instances during suspension. - [Quote a managed machine](https://docs.akua.dev/api-reference/machine-quotes/quote-a-managed-machine.md): Returns the fixed monthly net machine price and initial charge before ordering. VAT is calculated at checkout. Creating a quote does not order or provision a machine. - [Get a machine quote](https://docs.akua.dev/api-reference/machine-quotes/get-a-machine-quote.md): Returns the saved machine quote, payment confirmation and machine allocation. - [Order a quoted machine](https://docs.akua.dev/api-reference/machine-quotes/order-a-quoted-machine.md): Accepts the displayed quote and collects its initial charge on the workspace subscription. Payment authentication may be required. Provisioning starts only after payment is confirmed. - [List recent notifications](https://docs.akua.dev/api-reference/notifications/list-recent-notifications.md): Returns the authenticated user's most recent in-app notifications (max 50, newest first). Pass `unread=true` to filter to unread notifications only. - [Count unread notifications](https://docs.akua.dev/api-reference/notifications/count-unread-notifications.md): Returns the number of unread in-app notifications for the authenticated user. - [Mark a notification as read](https://docs.akua.dev/api-reference/notifications/mark-a-notification-as-read.md): Marks a single notification as read. Idempotent: calls for already-read or unowned notifications succeed without effect. - [Mark all notifications as read](https://docs.akua.dev/api-reference/notifications/mark-all-notifications-as-read.md): Marks every unread in-app notification for the authenticated user as read. Idempotent. - [List offers in workspace](https://docs.akua.dev/api-reference/offers/list-offers-in-workspace.md): Returns offers belonging to the workspace specified in the workspace context, newest first. - [Create offer](https://docs.akua.dev/api-reference/offers/create-offer.md): Creates an Offer for a product or a specific package version. Idempotency is workspace-scoped: reusing an `Idempotency-Key` with the same create intent returns the original Offer, while reusing it with a changed create intent returns HTTP 409 Conflict. Product-only requests that expire before an Off… - [Get offer details](https://docs.akua.dev/api-reference/offers/get-offer-details.md): Returns the full offer record including pre-fill values and email allowlist. Caller must be a member of the offer’s workspace. - [Archive offer](https://docs.akua.dev/api-reference/offers/archive-offer.md): Archives the offer and blocks new redemptions. The offer row remains for history and audit; callers receive the full Offer with `status: "archived"`. Idempotent: already-archived offers return unchanged. If-Match is required for optimistic concurrency. - [Unarchive offer](https://docs.akua.dev/api-reference/offers/unarchive-offer.md): Reverts a previously-archived offer back to `active`. Idempotent: already-active offers return unchanged. Does not auto-cascade to dependents or previously-archived child references. - [Resolve offer by short hash](https://docs.akua.dev/api-reference/offers/resolve-offer-by-short-hash.md): Resolves an offer from the customer-clicked URL `/i/`. Anonymous callers receive the publicly-safe subset of fields needed to render the landing page (product name, logo, seller name, status, tier). Authenticated callers authorized to claim through an open allowlist or a verified-email m… - [List operations](https://docs.akua.dev/api-reference/operations/list-operations.md): Workspace-scoped list of long-running operations, newest first. Without filters returns every operation in the workspace; with `?owner_type=install&owner_id=` narrows to a single entity. - [Get operation details + steps](https://docs.akua.dev/api-reference/operations/get-operation-details-+-steps.md): Returns the operation row plus its per-step progress events. Clients poll this endpoint while `done` is false; when `done` flips true, `response` carries the typed result (`SUCCEEDED`) or `error.message` carries the failure reason. Prefer `POST /v1/operations/{id}:wait` for sync "wait until done" se… - [Wait for an operation to reach a terminal state](https://docs.akua.dev/api-reference/operations/wait-for-an-operation-to-reach-a-terminal-state.md): Long-polls server-side until the operation reaches a terminal state (`SUCCEEDED`, `FAILED`, `CANCELLED`) or the timeout elapses. Returns the latest `Operation` either way — check `done` to distinguish. - [Request operation cancellation](https://docs.akua.dev/api-reference/operations/request-operation-cancellation.md): Requests cancellation of an in-flight operation. Cancellation is asynchronous: successful requests return the current operation envelope while the worker drains the current step before settling into a terminal result. Replaying the request with the same Idempotency-Key is supported. If the operation… - [Create order draft](https://docs.akua.dev/api-reference/order-drafts/create-order-draft.md): Creates a customer wizard session (OrderDraft) for the parent offer. The caller is the customer; their authenticated user becomes the draft's owner. Each idempotent create call returns the same draft for the same Idempotency-Key. Concurrency limits and email-allowlist gates apply per the offer's con… - [List order drafts](https://docs.akua.dev/api-reference/order-drafts/list-order-drafts.md): Returns order drafts for one offer. `?offer=` is required in v1; `?status=` can further filter by wizard phase. With a workspace context (token-implied or `Akua-Context`), only workspace-member-visible drafts are returned and `field_values` is omitted. - [Get order draft details](https://docs.akua.dev/api-reference/order-drafts/get-order-draft-details.md): Returns the order draft row. The order draft’s own customer sees the full record including `field_values`; workspace members of the parent offer see the row with `field_values` omitted. - [Cancel order draft](https://docs.akua.dev/api-reference/order-drafts/cancel-order-draft.md): Terminates an in-flight order draft, returning the updated record. Allowed for the order draft’s own customer or any member of the parent offer’s workspace. Idempotent — cancelling a terminated order draft returns it unchanged. Allocated cluster resources are released and any in-flight install workf… - [Claim order draft](https://docs.akua.dev/api-reference/order-drafts/claim-order-draft.md): Binds the calling authenticated user to an anonymous order draft using a one-time claim token (R13 + AIP-147 INPUT_ONLY). - [Select order workspace](https://docs.akua.dev/api-reference/order-drafts/select-order-workspace.md): Selects the customer workspace for an order draft, or creates a new workspace for the order. This advances the draft from workspace selection to compute allocation. - [Submit configure values](https://docs.akua.dev/api-reference/order-drafts/submit-configure-values.md): Persists the customer’s configure-form values on the order draft and advances it to the payment phase, returning the updated record. Values are validated against the package version’s schema. - [Create order draft worker bootstrap](https://docs.akua.dev/api-reference/order-drafts/create-order-draft-worker-bootstrap.md): Creates a short-lived worker bootstrap token and renders command/cloud-init data for the cluster allocated to this order draft. Only valid while the draft is waiting for compute bootstrap. - [List order draft checkout sessions](https://docs.akua.dev/api-reference/order-drafts/list-order-draft-checkout-sessions.md): Returns historical checkout session rows for the order draft (current and past) for resume/audit workflows. - [Create order draft checkout session](https://docs.akua.dev/api-reference/order-drafts/create-order-draft-checkout-session.md): Creates a Stripe Checkout Session for the current order-draft payment revision, or returns the existing open session when it still has enough remaining lifetime. Stale sessions are expired and superseded before a replacement is created. - [Get order draft checkout session](https://docs.akua.dev/api-reference/order-drafts/get-order-draft-checkout-session.md): Returns one historical checkout session by ID, including the current session state. - [List organizations](https://docs.akua.dev/api-reference/organizations/list-organizations.md): Lists all organizations the authenticated user belongs to. - [Create organization](https://docs.akua.dev/api-reference/organizations/create-organization.md): Creates a new organization. The authenticated user becomes the initial owner. - [Get organization details](https://docs.akua.dev/api-reference/organizations/get-organization-details.md): Returns details for an organization the authenticated user belongs to. - [Delete organization](https://docs.akua.dev/api-reference/organizations/delete-organization.md): Deletes an organization after validating membership, workspace ownership, and owner protection. - [Update organization](https://docs.akua.dev/api-reference/organizations/update-organization.md): Updates profile fields on an organization. Requires owner or admin role in the organization. - [List organization members](https://docs.akua.dev/api-reference/organizations/list-organization-members.md): Lists a page of organization members. Requires membership in the organization. - [Add organization member](https://docs.akua.dev/api-reference/organizations/add-organization-member.md): Adds a user to the organization with the supplied role (defaults to `member`). Requires owner or admin role. - [List pending organization invitations](https://docs.akua.dev/api-reference/organizations/list-pending-organization-invitations.md) - [Invite an organization member by email](https://docs.akua.dev/api-reference/organizations/invite-an-organization-member-by-email.md) - [Resend an organization invitation](https://docs.akua.dev/api-reference/organizations/resend-an-organization-invitation.md) - [Cancel an organization invitation](https://docs.akua.dev/api-reference/organizations/cancel-an-organization-invitation.md) - [Accept an organization invitation](https://docs.akua.dev/api-reference/organizations/accept-an-organization-invitation.md) - [Remove organization member](https://docs.akua.dev/api-reference/organizations/remove-organization-member.md): Removes a member from the organization. Self-removal is always allowed; removing other users requires owner or admin role. The last owner cannot be removed. - [Update member role](https://docs.akua.dev/api-reference/organizations/update-member-role.md): Updates the role of an existing member. Only the organization's owner may change roles. - [List managed workspaces](https://docs.akua.dev/api-reference/organizations/list-managed-workspaces.md): Lists workspaces managed by this organization. Requires membership in the organization. - [List packages](https://docs.akua.dev/api-reference/packages/list-packages.md): Returns all packages in the active workspace. - [Create package](https://docs.akua.dev/api-reference/packages/create-package.md): Creates a package from one OCI Helm or platform-hosted authored source as a long-running operation. If the workflow starts before its Operation is visible, retry with the same Idempotency-Key. - [Get package details](https://docs.akua.dev/api-reference/packages/get-package-details.md): Returns a single package and the `latest_version_id` pointer for this workspace. - [Delete package](https://docs.akua.dev/api-reference/packages/delete-package.md): Deletes a Package and its PackageVersions when no Install references a version. Also removes unused archived Products in the same Workspace. Active Products must be archived first. Archived Products with Offers, Orders, Installs, rollout history, Offer reservations, channel scopes, or Install routes… - [List package versions](https://docs.akua.dev/api-reference/packages/list-package-versions.md): Returns published versions of a package, newest first. - [Create package version](https://docs.akua.dev/api-reference/packages/create-package-version.md): Registers an immutable version for an existing Package. OCI-backed Packages verify the supplied version metadata against the published artifact before durable registration. Hosted Packages publish the immutable version from an authored repository while preserving the Package, Products, Offers, and e… - [Get package version details](https://docs.akua.dev/api-reference/packages/get-package-version-details.md): Returns a single version entry for a package. - [Get package version input schema](https://docs.akua.dev/api-reference/packages/get-package-version-input-schema.md): Returns the version input schema used by the install wizard, typically generated JSON Schema. - [Resolve Artifact Hub chart values + schema](https://docs.akua.dev/api-reference/packages/resolve-artifact-hub-chart-values-+-schema.md): Fetches a chart's values from Artifact Hub and returns them with a JSON Schema — the chart's published schema (when present) merged over a schema inferred from the values, so the editor always has defaults to show. - [Import published package](https://docs.akua.dev/api-reference/packages/import-published-package.md): Imports a published OCI-backed Akua package and registers its first immutable version. Akua verifies the supplied version metadata against the published artifact before durable registration. Requires published Package import access. - [List preview hostnames](https://docs.akua.dev/api-reference/preview-hostnames/list-preview-hostnames.md): Lists preview hostnames belonging to an install. - [Get preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/get-preview-hostname.md): Returns one preview hostname belonging to an install. - [Delete preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/delete-preview-hostname.md): Starts a workflow that releases a preview hostname. - [Bind pinned preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/bind-pinned-preview-hostname.md): Starts a workflow that binds an immutable preview hostname to one render. - [Bind floating preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/bind-floating-preview-hostname.md): Starts a workflow that binds or rebinds a stable preview hostname track. - [List products in workspace](https://docs.akua.dev/api-reference/products/list-products-in-workspace.md): Returns all products belonging to the workspace specified in the workspace context. - [Create product](https://docs.akua.dev/api-reference/products/create-product.md): Creates a Product backed by an existing Package and package version pin. Package source import belongs to the Packages API. - [Get product details](https://docs.akua.dev/api-reference/products/get-product-details.md): Returns product metadata including the backing Package and marketplace settings. - [Update product](https://docs.akua.dev/api-reference/products/update-product.md): Updates Product metadata, marketplace listing state, and the package version pin for future offers and installs. - [Archive product](https://docs.akua.dev/api-reference/products/archive-product.md): Archives the product and removes it from active marketplace listings. The row persists with state `archived` for audit/history/revenue-attribution. Active installs and past orders are unaffected; backing packages remain independently managed and unchanged. Dashboard callers can still render historic… - [Unarchive product](https://docs.akua.dev/api-reference/products/unarchive-product.md): Restores a previously-archived product to `active`. The row remains in place and history is preserved. Active installs continue; dependent offers stay untouched unless separately unarchived. - [List quota usage for the authenticated user](https://docs.akua.dev/api-reference/quotas/list-quota-usage-for-the-authenticated-user.md): Returns current usage and limits for all quota metrics. With workspace context, allocation quotas are scoped to that workspace. Without context, allocation quotas retain the user-wide view. Rate quotas are user-scoped, and concurrency quotas are per-cluster when `cluster_id` is supplied. - [Get quota usage for a specific metric](https://docs.akua.dev/api-reference/quotas/get-quota-usage-for-a-specific-metric.md): Returns current usage and limit for a single quota metric. The metric must be URL-encoded (e.g. `compute%2Fmachines`). With workspace context, allocation quotas are scoped to that workspace exactly as `quotas.list` reports them. Concurrency metrics are measured per cluster and need `cluster_id`. - [List regions in workspace](https://docs.akua.dev/api-reference/regions/list-regions-in-workspace.md): Returns all regions belonging to the workspace specified in the workspace context. - [Create region](https://docs.akua.dev/api-reference/regions/create-region.md): Creates a named region in the workspace. Regions group clusters geographically for marketplace display. - [Delete region](https://docs.akua.dev/api-reference/regions/delete-region.md): Permanently deletes a region. A region that is still in use by a cluster, an active offer, an open order or an enabled cluster pool cannot be deleted: the request fails with 409 and the error names what uses it, with the counts in `metadata` (`reason: region_in_use`, `clusters`, `active_offers`, `op… - [Update region](https://docs.akua.dev/api-reference/regions/update-region.md): Renames a region or changes its icon. Only the provided fields change, and the region keeps its id, so the clusters, offers and cluster pools that reference it are unaffected. Region names are unique within a workspace; a duplicate name returns 409. Requires workspace owner or admin. - [List registry credentials](https://docs.akua.dev/api-reference/registry/list-registry-credentials.md): Returns credentials for the workspace. Credential secrets are never exposed. - [Create registry credential](https://docs.akua.dev/api-reference/registry/create-registry-credential.md): Adds a registry credential to the workspace for OCI proxy authentication. - [Delete registry credential](https://docs.akua.dev/api-reference/registry/delete-registry-credential.md): Permanently removes a registry credential. Active installs using this credential may lose pull access. - [List repositories in workspace](https://docs.akua.dev/api-reference/repositories/list-repositories-in-workspace.md): Lists repositories visible in the workspace. Filterable by `purpose` (deploy / package / repository_change_request / workspace). Wire IDs prefixed `repo_...`. Cursor-paginated. - [Create workspace repository](https://docs.akua.dev/api-reference/repositories/create-workspace-repository.md): Creates an ephemeral platform-hosted repository for authoring package source. Write credentials are minted separately. - [Create workspace repository write token](https://docs.akua.dev/api-reference/repositories/create-workspace-repository-write-token.md): Mints a repository-scoped write token with scheduled revocation. Token material is returned only once. The schedule is cleanup intent, not provider-enforced expiry; access can continue until revocation succeeds. - [Get repository details](https://docs.akua.dev/api-reference/repositories/get-repository-details.md): Returns a single repository as a discriminated union per `purpose`; the shape varies by lifecycle. - [Create the initial repository commit](https://docs.akua.dev/api-reference/repositories/create-the-initial-repository-commit.md): Commits a small text-file snapshot to the main branch of an empty, unexpired Workspace authoring repository. Repeating the same snapshot and idempotency key returns the same commit. A different existing main commit returns a conflict. No Git credential is returned. - [Read the repository main branch](https://docs.akua.dev/api-reference/repositories/read-the-repository-main-branch.md): Reads the current main commit of an unexpired Workspace authoring repository. An empty repository has a null commit SHA. - [List repository change requests](https://docs.akua.dev/api-reference/repository-change-requests/list-repository-change-requests.md): Lists fork-backed repository change requests in the active workspace. - [Create repository change request](https://docs.akua.dev/api-reference/repository-change-requests/create-repository-change-request.md): Creates a fork-backed repository change request. Fork write credentials are minted separately. - [Create repository change request token](https://docs.akua.dev/api-reference/repository-change-requests/create-repository-change-request-token.md): Mints short-lived credentials for pushing changes to the fork repository. - [Get repository change request](https://docs.akua.dev/api-reference/repository-change-requests/get-repository-change-request.md): Returns one fork-backed repository change request. - [Accept repository change request](https://docs.akua.dev/api-reference/repository-change-requests/accept-repository-change-request.md): Validates and merges a repository change request into its parent repository. - [Reject repository change request](https://docs.akua.dev/api-reference/repository-change-requests/reject-repository-change-request.md): Rejects a repository change request and records the reason. - [Withdraw repository change request](https://docs.akua.dev/api-reference/repository-change-requests/withdraw-repository-change-request.md): Withdraws an editable repository change request and purges its fork. - [List secrets](https://docs.akua.dev/api-reference/secrets/list-secrets.md): Lists workspace secrets. Metadata only; plaintext values are never returned. - [Create secret](https://docs.akua.dev/api-reference/secrets/create-secret.md): Creates a workspace-scoped Secret with metadata and the first version. The plaintext value is consumed and never echoed. - [Get secret](https://docs.akua.dev/api-reference/secrets/get-secret.md): Returns secret metadata. Plaintext values are never returned. - [Delete secret](https://docs.akua.dev/api-reference/secrets/delete-secret.md): Soft-deletes a secret and keeps version payloads recoverable until purge_at. Use force=true to immediately destroy version payloads. - [Update secret](https://docs.akua.dev/api-reference/secrets/update-secret.md): Updates secret metadata only. Rotate values with POST /secrets/{id}/versions. - [Restore a soft-deleted secret](https://docs.akua.dev/api-reference/secrets/restore-a-soft-deleted-secret.md): Restores a Secret that was soft-deleted via DELETE /v1/secrets/{id}, provided the call happens before its purge_at deadline. The Secret returns to state=active and its retained version payloads become accessible again. Returns 409 ABORTED on stale If-Match. Returns 404 if the secret was hard-deleted… - [Validate a provider token](https://docs.akua.dev/api-reference/secrets/validate-a-provider-token.md): Probes a customer-supplied cloud-provider API token with a cheap read-only call to confirm it authenticates, without storing it. Use before creating a `cloud_provider/*` secret. - [List secret versions](https://docs.akua.dev/api-reference/secrets/list-secret-versions.md): Lists secret versions. Metadata only; plaintext values are never returned. - [Create secret version](https://docs.akua.dev/api-reference/secrets/create-secret-version.md): Appends a new immutable SecretVersion. Plaintext is never echoed. - [Get secret version](https://docs.akua.dev/api-reference/secrets/get-secret-version.md): Returns metadata for one secret version. Plaintext is never returned. - [Enable a disabled secret version](https://docs.akua.dev/api-reference/secrets/enable-a-disabled-secret-version.md): Re-enables a disabled SecretVersion. The newly-enabled version becomes eligible for `:access` calls again. Idempotent: enabling an already-enabled version returns 200 with no state change. Returns 409 ABORTED with a stale-revision hint if If-Match mismatches. Returns 409 if the version has been dest… - [Disable secret version](https://docs.akua.dev/api-reference/secrets/disable-secret-version.md): Marks a secret version as disabled. - [Destroy secret version](https://docs.akua.dev/api-reference/secrets/destroy-secret-version.md): Irreversibly destroys a secret version payload and keeps metadata for audit. - [Access secret version plaintext](https://docs.akua.dev/api-reference/secrets/access-secret-version-plaintext.md): Returns the plaintext value for an active secret version and writes an audit-log entry. Soft-deleted secrets return 404 until restored with :undelete. - [List workspace snippet runs](https://docs.akua.dev/api-reference/snippet-runs/list-workspace-snippet-runs.md): Returns durable snippet execution activity for the selected workspace, newest first. - [Get workspace snippet run](https://docs.akua.dev/api-reference/snippet-runs/get-workspace-snippet-run.md): Returns one durable snippet execution, including its terminal payload. - [List snippets in workspace](https://docs.akua.dev/api-reference/snippets/list-snippets-in-workspace.md): Returns all snippets belonging to the workspace specified in the workspace context. - [Create snippet](https://docs.akua.dev/api-reference/snippets/create-snippet.md): Creates a reusable code snippet in the workspace. Snippets are async JavaScript functions executed in a sandboxed runtime with access to platform.request() for API calls. - [List snippet dashboard usage in workspace](https://docs.akua.dev/api-reference/snippets/list-snippet-dashboard-usage-in-workspace.md): Returns dashboard references for snippets in the workspace specified in the workspace context. - [Get snippet dashboard usage](https://docs.akua.dev/api-reference/snippets/get-snippet-dashboard-usage.md): Returns dashboard references for one snippet. - [Get snippet details](https://docs.akua.dev/api-reference/snippets/get-snippet-details.md): Returns a snippet including its code and display type. - [Archive snippet](https://docs.akua.dev/api-reference/snippets/archive-snippet.md): Archives a snippet while preserving its runs and dashboard revision history. Fails with 409 while an active dashboard references it. - [Update snippet](https://docs.akua.dev/api-reference/snippets/update-snippet.md): Updates snippet properties. Only provided fields are changed. Dashboards using this snippet will pick up code changes on next run. - [Execute ad-hoc snippet code](https://docs.akua.dev/api-reference/snippets/execute-ad-hoc-snippet-code.md): Executes ad-hoc JavaScript in the snippet sandbox and returns the synchronous result. Does not persist a snippet or run resource. - [Execute stored snippet](https://docs.akua.dev/api-reference/snippets/execute-stored-snippet.md): Fetches a stored snippet by ID server-side, executes its code in the snippet sandbox, and returns the synchronous result. - [List snippet runs](https://docs.akua.dev/api-reference/snippets/list-snippet-runs.md): Returns runs for a snippet. Use `view=basic` for a compact listing. - [Create snippet run](https://docs.akua.dev/api-reference/snippets/create-snippet-run.md): Creates a new snippet run resource under a snippet and starts execution. Idempotent with Idempotency-Key; callers receive the created run resource and Location header. - [Get snippet run](https://docs.akua.dev/api-reference/snippets/get-snippet-run.md): Returns a single snippet run by ID. - [Get workspace subdomain](https://docs.akua.dev/api-reference/workspace-subdomains/get-workspace-subdomain.md): Returns the singleton workspace subdomain resource. - [Set workspace subdomain name](https://docs.akua.dev/api-reference/workspace-subdomains/set-workspace-subdomain-name.md): Starts the workspace subdomain rename workflow. - [List workspaces](https://docs.akua.dev/api-reference/workspaces/list-workspaces.md): Returns workspaces visible within the authenticated request scope. An unscoped user credential sees all of its workspaces; a workspace-scoped request sees only that workspace. - [Create workspace](https://docs.akua.dev/api-reference/workspaces/create-workspace.md): Creates a workspace for the authenticated user. - [Get workspace](https://docs.akua.dev/api-reference/workspaces/get-workspace.md): Returns the details of a workspace. - [Delete workspace](https://docs.akua.dev/api-reference/workspaces/delete-workspace.md): Asynchronously deletes a workspace and all of its workspace-owned resources. - [Update workspace](https://docs.akua.dev/api-reference/workspaces/update-workspace.md): Updates workspace metadata for the selected workspace. - [List workspace members](https://docs.akua.dev/api-reference/workspaces/list-workspace-members.md): Returns the members and roles for a workspace. - [Add workspace member](https://docs.akua.dev/api-reference/workspaces/add-workspace-member.md): Adds a user to a workspace with the requested role. - [Remove workspace member](https://docs.akua.dev/api-reference/workspaces/remove-workspace-member.md): Removes a user from a workspace. - [Update workspace member role](https://docs.akua.dev/api-reference/workspaces/update-workspace-member-role.md): Updates the role of a workspace member. - [Get workspace subscription](https://docs.akua.dev/api-reference/workspaces/get-workspace-subscription.md): Returns billing subscription information for a workspace. - [Get workspace access state](https://docs.akua.dev/api-reference/workspaces/get-workspace-access-state.md): Returns whether the workspace is currently accessible and why. - [Get workspace management access](https://docs.akua.dev/api-reference/workspaces/get-workspace-management-access.md): Returns the organization currently allowed to manage this customer-owned workspace. - [Revoke workspace management access](https://docs.akua.dev/api-reference/workspaces/revoke-workspace-management-access.md): Removes organization-level management access while preserving customer ownership and the running workspace. - [Cancel workspace subscription](https://docs.akua.dev/api-reference/workspaces/cancel-workspace-subscription.md): Cancels or schedules cancellation for a workspace subscription. - [Reactivate workspace subscription](https://docs.akua.dev/api-reference/workspaces/reactivate-workspace-subscription.md): Reactivates a workspace subscription and clears cancellation schedule. - [Change workspace subscription tier](https://docs.akua.dev/api-reference/workspaces/change-workspace-subscription-tier.md): Schedules a subscription tier change for the workspace. - [List subscription change requests](https://docs.akua.dev/api-reference/workspaces/list-subscription-change-requests.md): Returns subscription tier change requests for workspace. - [Get subscription change request](https://docs.akua.dev/api-reference/workspaces/get-subscription-change-request.md): Returns one subscription change request record. - [Suggest what you mainly do](https://docs.akua.dev/api-reference/dashboard-preferences/suggest-what-you-mainly-do.md): Ranks the four onboarding answers from visited landing roles, sign-up attribution, early dashboard pages and installed apps in the selected workspace. Returns both deterministic and available evaluated reader evidence with reasons. Confirmation through PATCH is required to save a choice; this operat… - [Get your dashboard preferences](https://docs.akua.dev/api-reference/dashboard-preferences/get-your-dashboard-preferences.md): Your language, what you mainly do (your role preset), and whether technical details are shown, for the workspace in Akua-Context or implied by the token. Unanswered fields are null. - [Update your dashboard preferences](https://docs.akua.dev/api-reference/dashboard-preferences/update-your-dashboard-preferences.md): Sets or corrects your language, role preset and the technical details switch. Only the fields you send change. A role preset cannot be cleared once chosen. - [List dashboard surfaces](https://docs.akua.dev/api-reference/dashboard-surfaces/list-dashboard-surfaces.md): Every dashboard page your release flags allow, in navigation order, with its label in your vocabulary and whether your navigation shows it and why. Pages your navigation does not show stay reachable by search and URL. - [Recover persisted agent Session state](https://docs.akua.dev/api-reference/agent-events/recover-persisted-agent-session-state.md): Reads the current stored Session, latest Turn and exact-bound approval references under current workspace authority. It does not start execution. Approval decisions are not successful tool results; a prepared Turn is not accepted. Response parts remain a separate cursor-based read. - [List agent events](https://docs.akua.dev/api-reference/agent-events/list-agent-events.md): Reads persisted events for the authenticated workspace, session, turn or lineage. - [Recover committed agent response parts](https://docs.akua.dev/api-reference/agent-events/recover-committed-agent-response-parts.md): Reads only persisted response chunks after a session cursor. This bounded recovery read is separate from the live Temporal Workflow Stream. - [Follow committed agent response parts](https://docs.akua.dev/api-reference/agent-events/follow-committed-agent-response-parts.md): Replays missing persisted UI chunks, then follows the existing Temporal Workflow Stream. SSE IDs are UI cursors, not Temporal offsets. Disconnect does not stop the Turn; reconnect with the last confirmed UI cursor. Cold clients replay from zero. Terminal and approval authority remain in persisted re… - [Open an agent conversation](https://docs.akua.dev/api-reference/agent-commands/open-an-agent-conversation.md): Creates one persisted conversation for an existing enabled Agent. Retry the identical Idempotency-Key and input to recover original creation; changed input conflicts. This acknowledgement does not start a model or assert Worker readiness. - [Submit an agent prompt](https://docs.akua.dev/api-reference/agent-commands/submit-an-agent-prompt.md): Acknowledges only confirmed Session acceptance. Retry the identical message ID and parts to recover the original acceptance; a stream disconnect is not Stop. - [Stop an exact agent Turn](https://docs.akua.dev/api-reference/agent-commands/stop-an-exact-agent-turn.md): Confirms persisted cancellation of the specified Session and Turn. Repeating the same target recovers cancellation and never stops a successor. Closing a stream is not Stop. This acknowledgement does not assert that an already-dispatched external operation terminated. The optional reason is advisory… - [Decide an exact agent tool approval](https://docs.akua.dev/api-reference/agent-commands/decide-an-exact-agent-tool-approval.md): Decides only the original immutable binding at the observed revision. Repeating an identical decision recovers its persisted result without dispatching a new command. A confirmed decision does not assert tool execution. Conflicting decisions or changed bindings are refused; uncertain responses requi… - [List entitlements](https://docs.akua.dev/api-reference/entitlements/list-entitlements.md): Returns active effective entitlements visible to the authenticated caller. - [CLI](https://docs.akua.dev/cli.md): Install, authenticate, and operate Akua from a terminal or coding agent - [akua pkg](https://docs.akua.dev/akua/cli/index.md): Author, render, test and publish Packages from the command line - [akua pkg init](https://docs.akua.dev/akua/cli/init.md): Scaffold a new Package - [akua pkg render](https://docs.akua.dev/akua/cli/render.md): Execute a package.k against inputs and write manifests - [akua pkg check](https://docs.akua.dev/akua/cli/check.md): Fast workspace check (parse + lint) - [akua pkg lint](https://docs.akua.dev/akua/cli/lint.md): Parse-only check of a package.k (KCL syntax + imports) - [akua pkg fmt](https://docs.akua.dev/akua/cli/fmt.md): Format a package.k via KCL's canonical formatter - [akua pkg export](https://docs.akua.dev/akua/cli/export.md): Emit the Package's Input schema (JSON Schema / OpenAPI) - [akua pkg inspect](https://docs.akua.dev/akua/cli/inspect.md): Report a Package's input surface or tarball metadata - [akua pkg test](https://docs.akua.dev/akua/cli/test.md): Run KCL tests (test_*.k, *_test.k) and, with --golden, snapshot tests - [akua pkg repl](https://docs.akua.dev/akua/cli/repl.md): Interactive KCL shell (.help lists meta commands) - [akua pkg diff](https://docs.akua.dev/akua/cli/diff.md): Structural diff between two rendered-output directories - [akua pkg add](https://docs.akua.dev/akua/cli/add.md): Add a dependency to akua.toml and lock it - [akua pkg remove](https://docs.akua.dev/akua/cli/remove.md): Remove a dependency from akua.toml - [akua pkg tree](https://docs.akua.dev/akua/cli/tree.md): Print the workspace's declared deps and lockfile entries - [akua pkg lock](https://docs.akua.dev/akua/cli/lock.md): Regenerate akua.lock from akua.toml - [akua pkg update](https://docs.akua.dev/akua/cli/update.md): Refresh akua.lock to what upstream serves now - [akua pkg vendor](https://docs.akua.dev/akua/cli/vendor.md): Materialize and inspect the vendor tree at .akua/vendor/ - [akua pkg pack](https://docs.akua.dev/akua/cli/pack.md): Pack the workspace into a local .tar.gz - [akua pkg pull](https://docs.akua.dev/akua/cli/pull.md): Pull a published Package from an OCI registry - [akua pkg push](https://docs.akua.dev/akua/cli/push.md): Upload a pre-packed tarball to an OCI registry - [akua pkg sign](https://docs.akua.dev/akua/cli/sign.md): Produce a cosign signature sidecar for a packed tarball - [akua pkg publish](https://docs.akua.dev/akua/cli/publish.md): Pack, push, sign and attest the workspace's Package - [akua pkg verify](https://docs.akua.dev/akua/cli/verify.md): Check akua.lock against akua.toml, or a tarball against its signature - [akua pkg cache](https://docs.akua.dev/akua/cli/cache.md): Manage the on-disk OCI, git, Helm and url caches - [akua pkg version](https://docs.akua.dev/akua/cli/version.md): Print the package toolchain version - [akua pkg errors](https://docs.akua.dev/akua/errors/index.md): Every structured error code the Package toolchain reports - [E_MANIFEST_MISSING](https://docs.akua.dev/akua/errors/E_MANIFEST_MISSING.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_PARSE](https://docs.akua.dev/akua/errors/E_MANIFEST_PARSE.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_GIT_USERINFO](https://docs.akua.dev/akua/errors/E_MANIFEST_GIT_USERINFO.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_HELM_MISSING_CHART](https://docs.akua.dev/akua/errors/E_MANIFEST_HELM_MISSING_CHART.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_HELM_MISSING_VERSION](https://docs.akua.dev/akua/errors/E_MANIFEST_HELM_MISSING_VERSION.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_HELM_USERINFO](https://docs.akua.dev/akua/errors/E_MANIFEST_HELM_USERINFO.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_HELM_CHART_INVALID](https://docs.akua.dev/akua/errors/E_MANIFEST_HELM_CHART_INVALID.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_OCI_USERINFO](https://docs.akua.dev/akua/errors/E_MANIFEST_OCI_USERINFO.md): Manifest and lockfile error reported by akua pkg - [E_MANIFEST_CRDS_INVALID](https://docs.akua.dev/akua/errors/E_MANIFEST_CRDS_INVALID.md): Manifest and lockfile error reported by akua pkg - [E_LOCK_MISSING](https://docs.akua.dev/akua/errors/E_LOCK_MISSING.md): Manifest and lockfile error reported by akua pkg - [E_LOCK_PARSE](https://docs.akua.dev/akua/errors/E_LOCK_PARSE.md): Manifest and lockfile error reported by akua pkg - [E_LOCK_DRIFT](https://docs.akua.dev/akua/errors/E_LOCK_DRIFT.md): Manifest and lockfile error reported by akua pkg - [E_DEP_KIND_MISMATCH](https://docs.akua.dev/akua/errors/E_DEP_KIND_MISMATCH.md): Manifest and lockfile error reported by akua pkg - [E_DEP_RESOLVE](https://docs.akua.dev/akua/errors/E_DEP_RESOLVE.md): Manifest and lockfile error reported by akua pkg - [E_CRDS_INVALID](https://docs.akua.dev/akua/errors/E_CRDS_INVALID.md): Manifest and lockfile error reported by akua pkg - [E_CRDS_STALE](https://docs.akua.dev/akua/errors/E_CRDS_STALE.md): Manifest and lockfile error reported by akua pkg - [E_AUTH_PARSE](https://docs.akua.dev/akua/errors/E_AUTH_PARSE.md): Manifest and lockfile error reported by akua pkg - [E_PACKAGE_MISSING](https://docs.akua.dev/akua/errors/E_PACKAGE_MISSING.md): Rendering error reported by akua pkg - [E_PACKAGE_PARSE](https://docs.akua.dev/akua/errors/E_PACKAGE_PARSE.md): Rendering error reported by akua pkg - [E_INPUTS_MISSING](https://docs.akua.dev/akua/errors/E_INPUTS_MISSING.md): Rendering error reported by akua pkg - [E_INPUTS_PARSE](https://docs.akua.dev/akua/errors/E_INPUTS_PARSE.md): Rendering error reported by akua pkg - [E_INVALID_FLAG](https://docs.akua.dev/akua/errors/E_INVALID_FLAG.md): Rendering error reported by akua pkg - [E_RENDER_KCL](https://docs.akua.dev/akua/errors/E_RENDER_KCL.md): Rendering error reported by akua pkg - [E_PATH_ESCAPE](https://docs.akua.dev/akua/errors/E_PATH_ESCAPE.md): Rendering error reported by akua pkg - [E_RENDER_CYCLE](https://docs.akua.dev/akua/errors/E_RENDER_CYCLE.md): Rendering error reported by akua pkg - [E_RENDER_BUDGET_DEPTH](https://docs.akua.dev/akua/errors/E_RENDER_BUDGET_DEPTH.md): Rendering error reported by akua pkg - [E_RENDER_BUDGET_DEADLINE](https://docs.akua.dev/akua/errors/E_RENDER_BUDGET_DEADLINE.md): Rendering error reported by akua pkg - [E_RENDER_BUDGET_MEMORY](https://docs.akua.dev/akua/errors/E_RENDER_BUDGET_MEMORY.md): Rendering error reported by akua pkg - [E_STRICT_UNTYPED_CHART](https://docs.akua.dev/akua/errors/E_STRICT_UNTYPED_CHART.md): Rendering error reported by akua pkg - [E_COSIGN_VERIFY](https://docs.akua.dev/akua/errors/E_COSIGN_VERIFY.md): Rendering error reported by akua pkg - [E_COSIGN_SIG_MISSING](https://docs.akua.dev/akua/errors/E_COSIGN_SIG_MISSING.md): Rendering error reported by akua pkg - [E_INIT_EXISTS](https://docs.akua.dev/akua/errors/E_INIT_EXISTS.md): Commands error reported by akua pkg - [E_INIT_EMPTY_NAME](https://docs.akua.dev/akua/errors/E_INIT_EMPTY_NAME.md): Commands error reported by akua pkg - [E_FMT_KCL](https://docs.akua.dev/akua/errors/E_FMT_KCL.md): Commands error reported by akua pkg - [E_LINT_FAIL](https://docs.akua.dev/akua/errors/E_LINT_FAIL.md): Commands error reported by akua pkg - [E_INSPECT_FAIL](https://docs.akua.dev/akua/errors/E_INSPECT_FAIL.md): Commands error reported by akua pkg - [E_DIFF_NOT_DIR](https://docs.akua.dev/akua/errors/E_DIFF_NOT_DIR.md): Commands error reported by akua pkg - [E_ADD_DEP_EXISTS](https://docs.akua.dev/akua/errors/E_ADD_DEP_EXISTS.md): Commands error reported by akua pkg - [E_ADD_INVALID_DEP](https://docs.akua.dev/akua/errors/E_ADD_INVALID_DEP.md): Commands error reported by akua pkg - [E_REMOVE_NOT_FOUND](https://docs.akua.dev/akua/errors/E_REMOVE_NOT_FOUND.md): Commands error reported by akua pkg - [E_VENDOR_DEP_MISSING](https://docs.akua.dev/akua/errors/E_VENDOR_DEP_MISSING.md): Commands error reported by akua pkg - [E_VENDOR_DRIFT](https://docs.akua.dev/akua/errors/E_VENDOR_DRIFT.md): Commands error reported by akua pkg - [E_PUBLISH_FAILED](https://docs.akua.dev/akua/errors/E_PUBLISH_FAILED.md): Distribution error reported by akua pkg - [E_PULL_FAILED](https://docs.akua.dev/akua/errors/E_PULL_FAILED.md): Distribution error reported by akua pkg - [E_IO](https://docs.akua.dev/akua/errors/E_IO.md): General error reported by akua pkg - [AI & Agents](https://docs.akua.dev/ai/index.md): Operate Akua with your coding agent through the CLI and optional MCP servers - [Documentation MCP](https://docs.akua.dev/ai/docs-mcp.md): Search and query Akua documentation in real-time from any MCP-compatible AI tool - [Platform MCP](https://docs.akua.dev/ai/platform-mcp.md): Connect AI agents to the Akua API via the Model Context Protocol - [Code Mode in Action](https://docs.akua.dev/ai/code-mode-in-action.md): See how agents compose complex multi-step operations in a single tool call - [Dashboard Generation](https://docs.akua.dev/ai/dashboard-generation.md): Use AI agents to generate and iterate on custom dashboards and snippets - [Kubernetes access](https://docs.akua.dev/ai/kubernetes-access.md): Give AI agents direct access to cluster resources through the Kubernetes API proxy and command execution - [Agents and installation repositories](https://docs.akua.dev/ai/repo-agents.md): How AI agents read, prepare, and review changes to Akua installations through their git repositories - [Parallel Log Analysis](https://docs.akua.dev/ai/examples/parallel-log-analysis.md): 35,000 log lines across 11 containers in 506ms, one tool call - [Resource Audit](https://docs.akua.dev/ai/examples/resource-audit.md): Cluster-wide CPU/memory capacity report in 56ms from a single API call - [Security Audit](https://docs.akua.dev/ai/examples/security-audit.md): 9 security checks across 7 parallel API calls: full cluster security posture in one tool call - [Incident Debugging](https://docs.akua.dev/ai/examples/incident-debugging.md): Full SRE triage in one conversation: pod status, events, error logs, and rollout history - [Database Operations](https://docs.akua.dev/ai/examples/database-operations.md): Run SQL queries, check Redis memory, and inspect databases, all through exec - [Cross-Cluster Comparison](https://docs.akua.dev/ai/examples/cross-cluster-comparison.md): Compare Kubernetes versions, images, and configurations across multiple clusters in one call - [CRD Discovery](https://docs.akua.dev/ai/examples/crd-discovery.md): Discover and interact with custom Kubernetes resources the agent has never seen before - [Full-Stack Dashboard in Minutes](https://docs.akua.dev/ai/examples/dashboard-in-minutes.md): One conversation → a live dashboard with database sizes, cache stats, app errors, and cluster health ## OpenAPI Specs - [openapi-public](/openapi-public.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.