# Akua | Docs ## Docs - [Ambient agents](https://docs.akua.dev/agents/ambient-agents.md): Configure agents that watch workspace signals and start investigations proactively - [Agents API](https://docs.akua.dev/agents/api.md): Public API resources for creating sessions, submitting turns, streaming events, and resolving approvals - [Communication style](https://docs.akua.dev/agents/communication.md): How agents adapt explanations, vocabulary, and detail level to each user - [Configure an agent](https://docs.akua.dev/agents/configure.md): Define an agent with skills, model policy, runtime policy, grants, and optional ambient triggers - [Agent dashboard](https://docs.akua.dev/agents/dashboard.md): Configure ambient agents and interpret agent-generated widgets in the Akua dashboard - [Examples](https://docs.akua.dev/agents/examples.md): Concrete examples of how hosted agents can guide deployment, infrastructure choices, investigations, and reviewable changes - [How agents work](https://docs.akua.dev/agents/how-it-works.md): The resource model behind Akua agents, sessions, turns, events, skills, and repository change requests - [Agents](https://docs.akua.dev/agents/index.md): Agents that deploy, investigate, and prepare reviewable changes with clear controls - [Limits and pricing](https://docs.akua.dev/agents/limits.md): Which limits and billing controls apply to hosted agents, retained runtimes, and provider usage - [Permissions and security](https://docs.akua.dev/agents/permissions-and-security.md): How Akua keeps agent work scoped, reviewable, and auditable - [Agent runbooks](https://docs.akua.dev/agents/runbooks.md): Operational checks for stuck sessions, stuck sandboxes, provider outages, runaway triggers, and retained filesystem cleanup - [Sessions and turns](https://docs.akua.dev/agents/sessions-and-turns.md): How agent work is submitted, streamed, approved, cancelled, and retained - [Agent API tasks](https://docs.akua.dev/agents/tasks.md): Create an agent, start a session, submit a turn, resolve an approval, and create a repository change request - [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 - [Documentation MCP](https://docs.akua.dev/ai/docs-mcp.md): Search and query Akua documentation in real-time from any MCP-compatible AI tool - [CRD Discovery](https://docs.akua.dev/ai/examples/crd-discovery.md): Discover and interact with custom Kubernetes resources the agent has never seen before - [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 - [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 - [Database Operations](https://docs.akua.dev/ai/examples/database-operations.md): Run SQL queries, check Redis memory, and inspect databases, all through exec - [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 - [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 - [AI & Agents](https://docs.akua.dev/ai/index.md): Connect AI assistants to Akua through MCP servers, or use the embedded dashboard agent for guided deployment and operations - [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 - [Platform MCP](https://docs.akua.dev/ai/platform-mcp.md): Connect AI agents to the Akua API via the Model Context Protocol - [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 - [Akua](https://docs.akua.dev/akua/index.md): The packaging substrate behind every Akua installation - [Package format](https://docs.akua.dev/akua/package-format.md): Authoring an akua Package: the Input schema, @ui annotations, and composition - [List agent events](https://docs.akua.dev/api-reference/agent-events/list-agent-events.md): Lists normalized events for a workspace, session, or turn. - [Stream agent events](https://docs.akua.dev/api-reference/agent-events/stream-agent-events.md): Streams normalized agent events as Server-Sent Events. - [Get agent preferences](https://docs.akua.dev/api-reference/agent-preferences/get-agent-preferences.md): Gets the current user's workspace-scoped agent preferences. - [Update agent preferences](https://docs.akua.dev/api-reference/agent-preferences/update-agent-preferences.md): Updates the current user's workspace-scoped agent preferences. - [List agent provider exchanges](https://docs.akua.dev/api-reference/agent-provider-exchanges/list-agent-provider-exchanges.md): Lists redacted provider proxy request and response metadata for one agent turn. - [Archive agent session](https://docs.akua.dev/api-reference/agent-sessions/archive-agent-session.md): Archives an agent session and requests runtime cleanup. - [Create agent session](https://docs.akua.dev/api-reference/agent-sessions/create-agent-session.md): Creates a durable workspace-scoped session for an agent. - [Detect agent work conflicts](https://docs.akua.dev/api-reference/agent-sessions/detect-agent-work-conflicts.md): Finds active agent sessions that have already referenced the same repository, install, cluster, or repository change request. - [Get agent session](https://docs.akua.dev/api-reference/agent-sessions/get-agent-session.md): Gets one agent session. - [List agent sessions](https://docs.akua.dev/api-reference/agent-sessions/list-agent-sessions.md): Lists agent sessions in the workspace. - [Set agent session retention](https://docs.akua.dev/api-reference/agent-sessions/set-agent-session-retention.md): Updates retained filesystem policy for an agent session. - [Get agent skill](https://docs.akua.dev/api-reference/agent-skills/get-agent-skill.md): Gets one agent skill. - [List agent skills](https://docs.akua.dev/api-reference/agent-skills/list-agent-skills.md): Lists published agent skills visible to the workspace. - [Get agent template](https://docs.akua.dev/api-reference/agent-templates/get-agent-template.md): Gets one platform-curated agent template. - [List agent templates](https://docs.akua.dev/api-reference/agent-templates/list-agent-templates.md): Lists platform-curated agent templates visible to the workspace. - [Cancel agent turn](https://docs.akua.dev/api-reference/agent-turns/cancel-agent-turn.md): Cancels a running or queued agent turn. - [Emit agent turn event](https://docs.akua.dev/api-reference/agent-turns/emit-agent-turn-event.md): Emits a constrained event intent for a running agent turn. - [Get agent turn](https://docs.akua.dev/api-reference/agent-turns/get-agent-turn.md): Gets one agent turn. - [List agent turns](https://docs.akua.dev/api-reference/agent-turns/list-agent-turns.md): Lists agent turns in the workspace or one session. - [Submit agent turn](https://docs.akua.dev/api-reference/agent-turns/submit-agent-turn.md): Submits one instruction to an agent session. - [Archive agent](https://docs.akua.dev/api-reference/agents/archive-agent.md): Archives an agent and stops future ambient triggers. - [Create agent](https://docs.akua.dev/api-reference/agents/create-agent.md): Creates a durable workspace-scoped agent identity. - [Enable agent](https://docs.akua.dev/api-reference/agents/enable-agent.md): Re-enables an archived agent so it can receive sessions and ambient triggers. - [Get agent](https://docs.akua.dev/api-reference/agents/get-agent.md): Gets one agent. - [List agents](https://docs.akua.dev/api-reference/agents/list-agents.md): Lists agents in the workspace. - [Update agent](https://docs.akua.dev/api-reference/agents/update-agent.md): Updates mutable agent configuration. Lifecycle state changes use archive. - [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. - [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. - [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 approval requests](https://docs.akua.dev/api-reference/approval-requests/list-approval-requests.md): Lists pending and resolved approval requests in the workspace. - [Resolve approval request](https://docs.akua.dev/api-reference/approval-requests/resolve-approval-request.md): Approves or rejects an approval request. - [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. - [Create cluster](https://docs.akua.dev/api-reference/clusters/create-cluster.md): Creates a managed cluster and returns the inserted row. Provisioning continues asynchronously; poll `state` / `kaas.status` for readiness. - [Create worker bootstrap](https://docs.akua.dev/api-reference/clusters/create-worker-bootstrap.md): Issues a new worker-bootstrap row and returns its metadata. - [Delete cluster](https://docs.akua.dev/api-reference/clusters/delete-cluster.md): Tears down the cluster and all of its owned resources. Returns an Operation envelope; the actual teardown happens asynchronously. Caller must be a workspace owner. - [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. - [Get cluster](https://docs.akua.dev/api-reference/clusters/get-cluster.md): Gets a cluster by id. - [Get cluster capabilities](https://docs.akua.dev/api-reference/clusters/get-cluster-capabilities.md): Gets the last observed Kubernetes capability snapshot for a cluster. - [Get cluster kubeconfig](https://docs.akua.dev/api-reference/clusters/get-cluster-kubeconfig.md): Returns cluster admin kubeconfig for workspace owners. R6 deliberate divergence retained with an audit-log requirement. - [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. - [Import cluster](https://docs.akua.dev/api-reference/clusters/import-cluster.md): Imports an existing cluster from kubeconfig. - [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. - [List clusters](https://docs.akua.dev/api-reference/clusters/list-clusters.md): Lists clusters visible to the authenticated workspace owner. - [Proxy cluster API](https://docs.akua.dev/api-reference/clusters/proxy-cluster-api.md): Proxy kube-apiserver traffic through the public API. `path:*` is forwarded verbatim to upstream. - [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. - [Resume cluster](https://docs.akua.dev/api-reference/clusters/resume-cluster.md): Resumes a suspended cluster and returns an async Operation envelope. - [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. - [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. - [Update cluster](https://docs.akua.dev/api-reference/clusters/update-cluster.md): Updates editable cluster fields. - [Check if machine has drifted](https://docs.akua.dev/api-reference/compute/check-if-machine-has-drifted.md): Checks if a machine has drifted from its desired compute configuration. - [Create a compute config](https://docs.akua.dev/api-reference/compute/create-a-compute-config.md) - [Create a machine](https://docs.akua.dev/api-reference/compute/create-a-machine.md): Provisions a new machine in the specified cluster with the given compute configuration. - [Delete a compute config](https://docs.akua.dev/api-reference/compute/delete-a-compute-config.md) - [Delete a machine](https://docs.akua.dev/api-reference/compute/delete-a-machine.md): Deletes a machine by provider ID. The node is drained before the cloud server is terminated. - [Delete a suspension](https://docs.akua.dev/api-reference/compute/delete-a-suspension.md): Deletes the snapshot and suspension record permanently. - [Get a compute config](https://docs.akua.dev/api-reference/compute/get-a-compute-config.md) - [Get cluster compute status](https://docs.akua.dev/api-reference/compute/get-cluster-compute-status.md): Returns auto-scaling state, machine count, and limits for a cluster. - [Get machine status](https://docs.akua.dev/api-reference/compute/get-machine-status.md): Returns current state of a machine including conditions and provider metadata. - [List available instance types](https://docs.akua.dev/api-reference/compute/list-available-instance-types.md): Returns instance types with pricing for a compute config. Returns available instance types for provisioning. Results are cached. - [List compute configs](https://docs.akua.dev/api-reference/compute/list-compute-configs.md): Lists compute configs for the workspace. - [List machines in cluster](https://docs.akua.dev/api-reference/compute/list-machines-in-cluster.md): Lists all machines for a cluster. - [List suspended machines](https://docs.akua.dev/api-reference/compute/list-suspended-machines.md): Lists all suspended machines for the workspace. - [Resume a suspended machine](https://docs.akua.dev/api-reference/compute/resume-a-suspended-machine.md): Restores the machine from its snapshot, creates a new cloud server. - [Suspend a machine](https://docs.akua.dev/api-reference/compute/suspend-a-machine.md): Snapshots the machine disk, deletes the cloud server to stop billing, and creates a suspension record. - [Update cluster compute settings](https://docs.akua.dev/api-reference/compute/update-cluster-compute-settings.md): Controls auto-scaling behavior and machine limits for a cluster. - [Create compute config](https://docs.akua.dev/api-reference/computeconfigs/create-compute-config.md): Creates a compute config row. - [Delete compute config](https://docs.akua.dev/api-reference/computeconfigs/delete-compute-config.md): Deletes a compute config. - [Get compute config](https://docs.akua.dev/api-reference/computeconfigs/get-compute-config.md): Returns a compute config by ID. - [List compute configs](https://docs.akua.dev/api-reference/computeconfigs/list-compute-configs.md): Lists compute configs in the workspace. - [Update compute config](https://docs.akua.dev/api-reference/computeconfigs/update-compute-config.md): Updates mutable fields of a compute config. - [Create custom domain](https://docs.akua.dev/api-reference/custom-domains/create-custom-domain.md): Creates a custom domain and starts routing reconciliation. - [Delete custom domain](https://docs.akua.dev/api-reference/custom-domains/delete-custom-domain.md): Starts a workflow that releases a custom domain. - [Get custom domain](https://docs.akua.dev/api-reference/custom-domains/get-custom-domain.md): Returns one custom domain belonging to a workspace. - [List custom domains](https://docs.akua.dev/api-reference/custom-domains/list-custom-domains.md): Lists custom domains belonging to a workspace. - [Update custom domain](https://docs.akua.dev/api-reference/custom-domains/update-custom-domain.md): Updates mutable custom domain routing settings. - [Create dashboard](https://docs.akua.dev/api-reference/dashboards/create-dashboard.md): Creates a dashboard in the workspace. Widgets are added through the dashboard widgets sub-collection. - [Create dashboard widget](https://docs.akua.dev/api-reference/dashboards/create-dashboard-widget.md): Creates a widget as a child resource under a dashboard. - [Delete dashboard](https://docs.akua.dev/api-reference/dashboards/delete-dashboard.md): Permanently deletes a dashboard. Referenced snippets are not affected. - [Delete dashboard widget](https://docs.akua.dev/api-reference/dashboards/delete-dashboard-widget.md): Deletes a dashboard widget. Snippet references are preserved. - [Get dashboard details](https://docs.akua.dev/api-reference/dashboards/get-dashboard-details.md): Returns a dashboard including its widget layout and snippet references. - [Get dashboard widget](https://docs.akua.dev/api-reference/dashboards/get-dashboard-widget.md): Returns a single dashboard widget. - [List dashboard widgets](https://docs.akua.dev/api-reference/dashboards/list-dashboard-widgets.md): Lists widgets for a dashboard. - [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. - [Update dashboard](https://docs.akua.dev/api-reference/dashboards/update-dashboard.md): Update dashboard metadata. Widget mutations use the `/widgets` sub-collection. - [Update dashboard widget](https://docs.akua.dev/api-reference/dashboards/update-dashboard-widget.md): Updates widget placement and display settings. - [List entitlements](https://docs.akua.dev/api-reference/entitlements/list-entitlements.md): Returns active effective entitlements visible to the authenticated caller. - [Create install](https://docs.akua.dev/api-reference/installs/create-install.md): Creates a product install via a long-running saga that may run for several minutes. Returns an Operation envelope to poll for progress. - [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. - [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. - [Get install details](https://docs.akua.dev/api-reference/installs/get-install-details.md): Returns current install 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. - [List install renders](https://docs.akua.dev/api-reference/installs/list-install-renders.md): Lists render artifacts for an install. - [List installs](https://docs.akua.dev/api-reference/installs/list-installs.md): Lists installs in the current workspace. - [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`. - [Create machine](https://docs.akua.dev/api-reference/machines/create-machine.md): Creates a machine and returns a long-running operation envelope. - [Create machine drift report](https://docs.akua.dev/api-reference/machines/create-machine-drift-report.md): Runs drift detection and stores a dedicated report row. - [Delete machine](https://docs.akua.dev/api-reference/machines/delete-machine.md): Deletes 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. - [Get machine drift report](https://docs.akua.dev/api-reference/machines/get-machine-drift-report.md): Returns a single drift report by ID. - [Get machine suspension event](https://docs.akua.dev/api-reference/machines/get-machine-suspension-event.md): Returns a single suspension event for a machine, including snapshot reference, cost, lifecycle state, and timing details. - [List machine drift reports](https://docs.akua.dev/api-reference/machines/list-machine-drift-reports.md): Lists historical drift reports for a machine. - [List machine suspension events](https://docs.akua.dev/api-reference/machines/list-machine-suspension-events.md): Lists historical suspension events for the machine. Events record suspend, resume, expiry, and snapshot-cost details for audit and billing reports. - [List machines](https://docs.akua.dev/api-reference/machines/list-machines.md): Lists all machines in the workspace. - [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. - [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. - [Update machine](https://docs.akua.dev/api-reference/machines/update-machine.md): Updates machine metadata. - [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. - [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. - [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. - [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. - [Create offer](https://docs.akua.dev/api-reference/offers/create-offer.md): Creates an install link for a specific package version. Customers reach the link at `/i/` to start an install. When `allowed_emails` is non-empty, only those email addresses can use the link; when empty or omitted, any authenticated customer can. - [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. - [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. - [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 whose verified email matches the offer's allowlist additionally rec… - [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. - [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… - [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. - [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… - [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. - [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). - [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… - [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. - [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. - [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. - [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. - [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. - [List order drafts](https://docs.akua.dev/api-reference/order-drafts/list-order-drafts.md): When called with a workspace context (token-implied or `Akua-Context`), returns order drafts for offers in that workspace (workspace members only; `field_values` omitted). Without a workspace context, returns the caller’s own order drafts across workspaces. Filterable by `?offer=` and `?status=`. - [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. - [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. - [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. - [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 organization members](https://docs.akua.dev/api-reference/organizations/list-organization-members.md): Lists every member of the organization. Requires membership in the organization. - [List organizations](https://docs.akua.dev/api-reference/organizations/list-organizations.md): Lists all organizations the authenticated user belongs to. - [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. - [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. - [Create package](https://docs.akua.dev/api-reference/packages/create-package.md): Creates a package from one or more sources as a long-running operation. - [Delete package](https://docs.akua.dev/api-reference/packages/delete-package.md): Deletes a Package and its PackageVersions only when no Product references the Package and no Install references any PackageVersion. - [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. - [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. - [List package versions](https://docs.akua.dev/api-reference/packages/list-package-versions.md): Returns published versions of a package, newest first. - [List packages](https://docs.akua.dev/api-reference/packages/list-packages.md): Returns all packages in the active workspace. - [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. - [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. - [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. - [Delete preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/delete-preview-hostname.md): Starts a workflow that releases a preview hostname. - [Get preview hostname](https://docs.akua.dev/api-reference/preview-hostnames/get-preview-hostname.md): Returns one preview hostname belonging to an install. - [List preview hostnames](https://docs.akua.dev/api-reference/preview-hostnames/list-preview-hostnames.md): Lists preview hostnames belonging to an install. - [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… - [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. - [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. - [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. - [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. - [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`). - [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. Allocation and rate quotas are per-user across all workspaces. Concurrency quotas are per-cluster — pass `cluster_id` to include them. - [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. - [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 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 registry credentials](https://docs.akua.dev/api-reference/registry/list-registry-credentials.md): Returns credentials for the workspace. Credential secrets are never exposed. - [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. - [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). Wire IDs prefixed `repo_...`. Cursor-paginated. - [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. - [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. - [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. - [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. - [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. - [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. - [Create secret version](https://docs.akua.dev/api-reference/secrets/create-secret-version.md): Appends a new immutable SecretVersion. Plaintext is never echoed. - [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. - [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. - [Disable secret version](https://docs.akua.dev/api-reference/secrets/disable-secret-version.md): Marks a secret version as disabled. - [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… - [Get secret](https://docs.akua.dev/api-reference/secrets/get-secret.md): Returns secret metadata. Plaintext values are never returned. - [Get secret version](https://docs.akua.dev/api-reference/secrets/get-secret-version.md): Returns metadata for one secret version. Plaintext is never returned. - [List secret versions](https://docs.akua.dev/api-reference/secrets/list-secret-versions.md): Lists secret versions. Metadata only; plaintext values are never returned. - [List secrets](https://docs.akua.dev/api-reference/secrets/list-secrets.md): Lists workspace secrets. Metadata only; plaintext values are never returned. - [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… - [Update secret](https://docs.akua.dev/api-reference/secrets/update-secret.md): Updates secret metadata only. Rotate values with POST /secrets/{id}/versions. - [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. - [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 V8 isolate with access to platform.request() for API calls. - [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. - [Delete snippet](https://docs.akua.dev/api-reference/snippets/delete-snippet.md): Permanently deletes a snippet. Fails with 409 if the snippet is referenced by any dashboard widgets. - [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. - [Get snippet details](https://docs.akua.dev/api-reference/snippets/get-snippet-details.md): Returns a snippet including its code and display type. - [Get snippet run](https://docs.akua.dev/api-reference/snippets/get-snippet-run.md): Returns a single snippet run by ID. - [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. - [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. - [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. - [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. - [Add workspace member](https://docs.akua.dev/api-reference/workspaces/add-workspace-member.md): Adds a user to a workspace with the requested role. - [Cancel workspace subscription](https://docs.akua.dev/api-reference/workspaces/cancel-workspace-subscription.md): Cancels or schedules cancellation for a workspace subscription. - [Change workspace subscription tier](https://docs.akua.dev/api-reference/workspaces/change-workspace-subscription-tier.md): Schedules a subscription tier change for the workspace. - [Create workspace](https://docs.akua.dev/api-reference/workspaces/create-workspace.md): Creates a workspace for the authenticated user. - [Delete workspace](https://docs.akua.dev/api-reference/workspaces/delete-workspace.md): Asynchronously deletes a workspace and all of its workspace-owned resources. - [Get subscription change request](https://docs.akua.dev/api-reference/workspaces/get-subscription-change-request.md): Returns one subscription change request record. - [Get workspace](https://docs.akua.dev/api-reference/workspaces/get-workspace.md): Returns the details of 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 subscription](https://docs.akua.dev/api-reference/workspaces/get-workspace-subscription.md): Returns billing subscription information for a workspace. - [List subscription change requests](https://docs.akua.dev/api-reference/workspaces/list-subscription-change-requests.md): Returns subscription tier change requests for workspace. - [List workspace members](https://docs.akua.dev/api-reference/workspaces/list-workspace-members.md): Returns the members and roles for a workspace. - [List workspaces](https://docs.akua.dev/api-reference/workspaces/list-workspaces.md): Returns all workspaces visible to the authenticated user. - [Reactivate workspace subscription](https://docs.akua.dev/api-reference/workspaces/reactivate-workspace-subscription.md): Reactivates a workspace subscription and clears cancellation schedule. - [Remove workspace member](https://docs.akua.dev/api-reference/workspaces/remove-workspace-member.md): Removes a user from a workspace. - [Update workspace](https://docs.akua.dev/api-reference/workspaces/update-workspace.md): Updates workspace metadata (name, slug) for the selected workspace. - [Update workspace member role](https://docs.akua.dev/api-reference/workspaces/update-workspace-member-role.md): Updates the role of a workspace member. - [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 - [Introduction](https://docs.akua.dev/apis/introduction.md): Programmatic access to Akua resources for automation, CLI tools, and integrations - [OpenAPI specification](https://docs.akua.dev/apis/openapi.md): Download the spec, generate type-safe clients, and stay in sync with API changes - [Application Sources](https://docs.akua.dev/app-sources.md): Choose how to deploy your application with Helm Charts, GitHub repositories, or Docker images - [Enterprise](https://docs.akua.dev/billing/enterprise.md): Custom limits, dedicated support, and compliance for organizations with larger requirements - [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 - [Changelog](https://docs.akua.dev/changelog.md): Product updates and announcements - [CLI](https://docs.akua.dev/cli.md): Manage Akua resources from your terminal - [Clusters](https://docs.akua.dev/cli/clusters.md): List, inspect, update, delete clusters, and download kubeconfigs from the terminal - [Installs](https://docs.akua.dev/cli/installs.md): Deploy products, stream logs, and open an interactive shell from the terminal - [Products](https://docs.akua.dev/cli/products.md): List, inspect, and delete products from the terminal - [Regions](https://docs.akua.dev/cli/regions.md): List available regions and create custom regions from the terminal - [Registry](https://docs.akua.dev/cli/registry.md): Manage container registry credentials from the terminal - [Workspaces](https://docs.akua.dev/cli/workspaces.md): Switch active workspace and list all workspaces from the terminal - [Clusters](https://docs.akua.dev/clusters.md): Understand how clusters work in Akua for deploying and managing your applications - [Add workers](https://docs.akua.dev/clusters/add-workers.md): Connect compute capacity to your managed cluster to run applications - [Create a cluster](https://docs.akua.dev/clusters/create.md): Set up a managed Kubernetes cluster in minutes - [Import a cluster](https://docs.akua.dev/clusters/import.md): Connect your existing Kubernetes infrastructure - [Limits and pricing](https://docs.akua.dev/clusters/limits.md): Which Akua limits apply to clusters, compute, and storage - [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 - [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 - [Machines](https://docs.akua.dev/compute/machines.md): Akua-managed compute that provisions and manages worker nodes for you - [Compute](https://docs.akua.dev/compute/overview.md): Provision and manage cloud servers for your Kubernetes clusters - [Hetzner Cloud](https://docs.akua.dev/compute/providers/hetzner.md): EU and US cloud servers — the first compute provider supported by Akua - [Suspend and resume machines](https://docs.akua.dev/compute/suspend-resume.md): Pause machines to stop billing while preserving data for later - [Concepts](https://docs.akua.dev/concepts.md): How packages, sources, products, and installations fit together - [Customizing values](https://docs.akua.dev/customizing-values.md): Configure and customize your applications using inputs and per-installation overrides - [Custom dashboards](https://docs.akua.dev/dashboards/custom-dashboards.md): Build live monitoring dashboards from reusable code snippets - [Deployments](https://docs.akua.dev/deployments.md): Install, version-control, and customize applications on your clusters - [Package generation](https://docs.akua.dev/deployments/chart-generation.md): How Akua turns your product configuration into a deployable package per installation - [Customize an installation via git](https://docs.akua.dev/deployments/install-repo.md): Edit your installation directly in a git repository: change inputs, override resources, and roll out updates with a push - [Installation repositories](https://docs.akua.dev/deployments/repositories.md): The git-backed model behind every Akua installation: what it stores, why it works this way, and how to use it - [Package versioning](https://docs.akua.dev/deployments/versioning.md): How installation packages track changes and how to roll back deployments - [Welcome to Akua](https://docs.akua.dev/index.md): Get started with Akua - deploy, manage, and monetize cloud-native applications - [Marketplace](https://docs.akua.dev/marketplace.md): Sell your software through Akua's public catalog or private customer links - [Offers and install links](https://docs.akua.dev/marketplace/install-links.md): Shareable offer URLs that drive the install wizard from your Package schema - [Limits and fees](https://docs.akua.dev/marketplace/limits.md): Which Akua limits apply to selling on the marketplace, plus Stripe processing fees - [Networking](https://docs.akua.dev/networking.md): Routes, gateways, and domains for your applications - [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 - [Direct IP](https://docs.akua.dev/networking/direct-ip.md): Route traffic directly to your worker nodes using Gateway API and DNS - [Preview domains](https://docs.akua.dev/networking/preview-domains.md): Get instant *.cnap.app URLs for every deployment — no DNS setup needed - [Marketplace payments](https://docs.akua.dev/payments.md): How your customers pay you for products deployed through the Akua marketplace - [GitHub integration](https://docs.akua.dev/platform/github-integration.md): Connect GitHub accounts and organizations for secure repository access and automated deployments - [Notifications](https://docs.akua.dev/platform/notifications.md): Stay informed about important events in your Akua account - [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 - [Private container registries](https://docs.akua.dev/platform/private-registries.md): Configure authentication for private Docker registries to deploy applications with private images - [Quotas and limits](https://docs.akua.dev/platform/quotas.md): How Akua manages resource limits, provisioning speed, and API usage - [Security](https://docs.akua.dev/platform/security.md): How Akua isolates workloads, protects data, and keeps your infrastructure secure - [Pricing](https://docs.akua.dev/pricing.md): Compare Akua plans, understand usage-based billing, and find the right tier for your workloads - [Products](https://docs.akua.dev/products.md): Package and sell your software to customers through the marketplace or private offer links - [Quickstart](https://docs.akua.dev/quickstart.md): Get your first product live and ready for customers in minutes - [Docker Compose to Kubernetes converter](https://docs.akua.dev/tools/compose-converter.md): Convert Docker Compose files to Kubernetes manifests and Helm charts - [Generic application chart](https://docs.akua.dev/tools/generic-chart.md): How Akua uses the generic Helm chart for GitHub repository and Docker image deployments - [GitHub Actions workflows](https://docs.akua.dev/tools/github-actions.md): Reusable GitHub Actions workflows for automatic builds and deployments with Railpack - [Workspaces](https://docs.akua.dev/workspaces.md): How workspaces organize clusters, products, and resources, and how organizations layer on top ## OpenAPI Specs - [openapi-public](https://docs.akua.dev/openapi-public.json) - [openapi-partner](https://docs.akua.dev/openapi-partner.json) - [openapi-internal](https://docs.akua.dev/openapi-internal.json) - [openapi-full](https://docs.akua.dev/openapi-full.json) - [openapi-admin](https://docs.akua.dev/openapi-admin.json)