# Nuon documentation

> Nuon is the BYOC (bring-your-own-cloud) deployment platform for software vendors. Deploy applications — Terraform, Helm, Kubernetes manifests, container images — into customer AWS, Azure, or GCP accounts with no cross-account IAM. Includes runners, operation roles for least-privilege IAM, drift detection, approval workflows, and policies for compliance.

- [Quickstart](https://docs.nuon.co/get-started/quickstart.md): Deploy your first app with Nuon in a few minutes by shipping an example Kubernetes app into an AWS account.
- [Create Your First App](https://docs.nuon.co/get-started/create-your-first-app.md): Use an example app to learn Nuon or package your app with Nuon.
- [Roll out a change](https://docs.nuon.co/get-started/app-branches-walkthrough.md): Sync the eks-simple example app's built-in branch config, then plan and deploy a change across its installs.
- [Docs Home](https://docs.nuon.co/get-started/introduction.md): Continuous delivery into your customer's cloud.
- [Deployment Options](https://docs.nuon.co/guides/deployment-options.md): Choose how to run Nuon
- [Nuon Cloud](https://docs.nuon.co/guides/nuon-cloud.md): The fastest way to get started with Nuon
- [Nuon BYOC](https://docs.nuon.co/guides/byoc.md): A single tenant instance of Nuon, that you own
- [Nuon BYOC Requirements](https://docs.nuon.co/guides/byoc/requirements.md): Prerequisites for installing Nuon BYOC on AWS or GCP
- [Install Nuon BYOC](https://docs.nuon.co/guides/byoc/installation.md): Install Nuon BYOC in your cloud
- [Optional Nuon BYOC Configuration](https://docs.nuon.co/guides/byoc/optional.md): Additional configuration options for Nuon BYOC
- [Set Up Install Telemetry](https://docs.nuon.co/guides/byoc/telemetry.md): Connect your Nuon BYOC deployment to your observability backend and start collecting telemetry from customer installs.
- [Updating Nuon BYOC](https://docs.nuon.co/guides/byoc/updates.md): Update Nuon BYOC and the Stack
- [Nuon Self-Hosted](https://docs.nuon.co/guides/self-hosted.md): Run Nuon entirely within your own infrastructure, with no path for Nuon to reach in
- [Nuon Self-Hosted Dependencies](https://docs.nuon.co/guides/self-hosted/dependencies.md): Dependencies required to self-host Nuon
- [Concepts](https://docs.nuon.co/concepts/overview.md): Get up to speed on BYOC and Nuon.
- [Glossary](https://docs.nuon.co/concepts/glossary.md): Basic terminology of the Nuon Platform.
- [Nuon Apps](https://docs.nuon.co/concepts/apps.md): Package your existing application code and infrastructure to create Bring Your Own Cloud installable versions of your product.
- [Components](https://docs.nuon.co/concepts/components.md): Connect and configure your app using your existing container images, Helm charts, Kubernetes Manifests and Terraform code.
- [Auto Retries](https://docs.nuon.co/concepts/components/auto-retries.md): Configure components to automatically re-plan and re-apply on transient failures by setting max_auto_retries.
- [Sandboxes](https://docs.nuon.co/concepts/sandboxes.md): Sandboxes manage the base layer infrastructure for your application in each customer's cloud account.
- [Inputs](https://docs.nuon.co/concepts/app-inputs.md): Inputs allow you to define customer provided values that can be used to configure your app.
- [Secrets](https://docs.nuon.co/concepts/app-secrets.md): Define and manage sensitive values — credentials, API keys, tokens — used to configure app components and actions.
- [App Variables](https://docs.nuon.co/concepts/app-variables.md): App Variables allow you to store values through the API to be used across installs of an app.
- [Runners](https://docs.nuon.co/concepts/runners.md): Egress-only agents deployed in customer cloud accounts that execute all provisioning, deployment, and day-2 operations.
- [App and Install Life Cycle](https://docs.nuon.co/guides/app-install-life-cycle.md): Understand the life cycle of apps and installs in Nuon.
- [Stacks](https://docs.nuon.co/concepts/stacks.md): Customers use Stacks to install an app in their account.
- [Stand-alone VPC](https://docs.nuon.co/concepts/stacks/stand-alone-vpc.md): The Stack template creates a brand-new VPC dedicated to the install.
- [Customer VPC](https://docs.nuon.co/concepts/stacks/customer-vpc.md): The Stack deploys into a VPC the customer already owns.
- [Customer Cluster](https://docs.nuon.co/concepts/stacks/customer-cluster.md): The Stack deploys into a Kubernetes cluster the customer already runs.
- [CLI](https://docs.nuon.co/concepts/cli.md): Manage the full install lifecycle from your terminal.
- [Day-2 Operations Overview](https://docs.nuon.co/get-started/day-2-operations.md): BYOC primitives for scaling your deployments
- [Workflows](https://docs.nuon.co/concepts/workflows.md): Workflows are scheduled and manual lifecycles of deploying, updating or tearing down apps, components, and actions.
- [App Branches](https://docs.nuon.co/concepts/app-branches.md): App branches connect a git branch to your app, so a push rolls the change out across your fleet of customer installs through ordered deployment groups with a plan and an approval at every step.
- [Actions](https://docs.nuon.co/concepts/actions.md): Automate operational tasks and workflows in installs.
- [Policies](https://docs.nuon.co/concepts/policies.md): Enforce compliance, security, and operational standards across your infrastructure deployments.
- [Operation Roles](https://docs.nuon.co/concepts/operation-roles.md): Assign different IAM roles to different operations for least-privilege access across sandbox, components, and actions.
- [Install Telemetry](https://docs.nuon.co/concepts/install-telemetry.md): How application telemetry travels from customer installs to your observability backend.
- [Triggers](https://docs.nuon.co/concepts/triggers.md): Automate Nuon using external events with triggers.
- [Access Control](https://docs.nuon.co/concepts/access-control.md): How to control what team members and service accounts can do in your Nuon org.
- [API Tokens](https://docs.nuon.co/concepts/api-tokens.md): Durable tokens for authenticating to the Nuon Control Plane API.
- [Service Accounts](https://docs.nuon.co/concepts/service-accounts.md): Named machine identities for automation, CI/CD.
- [OIDC Federation](https://docs.nuon.co/concepts/oidc-federation.md): Exchange OIDC tokens from any trusted workload for short-lived Nuon API tokens — no stored secrets.
- [Managing Apps](https://docs.nuon.co/guides/managing-apps.md): Create, configure, and manage apps using the CLI and dashboard.
- [Managing Components](https://docs.nuon.co/guides/managing-components.md): List, build, and manage components using the CLI.
- [Component Dependencies](https://docs.nuon.co/guides/component-dependencies.md): Component dependencies allow you to create dependencies between components, and model your app as a graph.
- [Toggleable Components](https://docs.nuon.co/guides/toggleable-components.md): Turn components on and off per install, with the install config as the source of truth.
- [Configuring Inputs & Secrets](https://docs.nuon.co/guides/configuring-inputs-and-secrets.md): Define and use inputs, variables, and secrets in your app.
- [Configuring Sandboxes](https://docs.nuon.co/guides/configuring-sandboxes.md): Configure sandbox infrastructure for your app.
- [Cloud Connections](https://docs.nuon.co/guides/cloud-connections.md): Connect Nuon to AWS with short-lived OIDC credentials and an access preset.
- [Sandbox Builds](https://docs.nuon.co/guides/sandbox-builds.md): Provision from an immutable artifact instead of cloning Git at apply time. Reproducible reprovisions, no VCS dependency in your customer's account, failures caught before they touch infrastructure.
- [Using Variables](https://docs.nuon.co/guides/using-variables.md): Using variables with your Nuon configurations.
- [Connect GitHub](https://docs.nuon.co/guides/vcs.md): Connect your GitHub account to use both public and private repositories in your Nuon apps.
- [Container Image Components](https://docs.nuon.co/guides/container-image-components.md): Container image components allow you to use prebuilt container images.
- [Verify Container Image Signatures](https://docs.nuon.co/guides/image-signature-verification.md): Require container images to be signed by trusted Sigstore identities or Cosign keys before Nuon copies them.
- [Track image patches with update policies](https://docs.nuon.co/guides/image-update-policies.md): Use a semver constraint so each app sync picks up the latest matching patch tag without editing your app config.
- [Helm Chart Components](https://docs.nuon.co/guides/helm-chart-components.md): Helm chart components allow you to connect an existing Helm chart and deploy it into your customer's cloud account.
- [Kubernetes Manifest Components](https://docs.nuon.co/guides/kubernetes-manifest-components.md): Kubernetes manifest components allow you to deploy raw Kubernetes resources directly into your customer's cloud account.
- [Pulumi Components](https://docs.nuon.co/guides/pulumi-components.md): Pulumi components allow you to provision infrastructure in your customer's cloud account to power your install.
- [Terraform Components](https://docs.nuon.co/guides/terraform-components.md): Terraform components allow you to provision infrastructure in your customer's cloud account to power your install.
- [Positioning Safety of BYOC](https://docs.nuon.co/guides/vendor-customers.md): Learn how to position Nuon's security and user experience to customers.
- [Creating Installs](https://docs.nuon.co/guides/install-configs.md): Configuring the installs for your customers
- [Syncing Install Configs from Git](https://docs.nuon.co/guides/install-config-syncing.md): Connect a Git repo of install config files to your app so pushes keep every install's config in sync
- [Component Overrides](https://docs.nuon.co/guides/component-overrides.md): Override Helm values and Terraform variables on a per-install basis, without changing your app config.
- [Customer-Controlled Runner Shutdown](https://docs.nuon.co/guides/runner-kill-switch.md): How customers can pause or permanently stop the Nuon Runner from their own AWS account.
- [Custom Domains](https://docs.nuon.co/guides/custom-domains.md): Manage custom domains for an install.
- [Provision Stacks with CloudFormation](https://docs.nuon.co/guides/provision-stacks-with-cloudformation.md): Provision Nuon install stacks on AWS with CloudFormation.
- [Provision Stacks with a Terraform Module](https://docs.nuon.co/guides/provision-stacks-with-terraform-module.md): Use the nuon stack provider to provision a stack using a module
- [Provision Stacks with Terraform](https://docs.nuon.co/guides/provision-stacks-with-terraform.md): Provision the Nuon install stacks with Terraform.
- [Provision Stacks with Spacelift](https://docs.nuon.co/guides/provision-stacks-with-spacelift.md): Provision stacks using a Spacelift Blueprint or the Terraform provider.
- [Configure app branches](https://docs.nuon.co/guides/app-branches.md): Connect a git branch to your app, group your installs, and roll changes out across your fleet from a git push.
- [Roll back an install](https://docs.nuon.co/guides/rollback-install-config.md): Re-apply a previous app config version to one install, or to a whole deployment group, with a plan in front of it.
- [Reprovision an install](https://docs.nuon.co/guides/reprovision-installs.md): Re-run provisioning against the current app config to recreate an install's stack, sandbox, and components.
- [Configure actions](https://docs.nuon.co/guides/actions.md): Define and remotely execute custom action workflows in your installs.
- [Run adhoc actions](https://docs.nuon.co/guides/adhoc-actions.md): Run a one-off command or bash script on an install without defining it in your app's TOML config.
- [Container Actions](https://docs.nuon.co/guides/container-actions.md): Execute actions inside a user-managed container image.
- [Configure runbooks](https://docs.nuon.co/guides/runbooks.md): Define named, multi-step procedures and run them against your installs on demand.
- [Configuring Policies](https://docs.nuon.co/guides/configuring-policies.md): Step-by-step guide to adding compliance and security policies to your Nuon app.
- [Operation Roles](https://docs.nuon.co/guides/operation-roles.md): Assign different roles to different operations across sandbox, components, and actions.
- [Runner Management Mode](https://docs.nuon.co/guides/runner-management-mode.md): Configure runner management mode for new installs or migrate existing installs.
- [Manage Install Telemetry](https://docs.nuon.co/guides/manage-install-telemetry.md): Enable or disable install telemetry and choose your organization default.
- [Team Management](https://docs.nuon.co/guides/team-management.md): Add team members to your Nuon Org
- [Add BYOC installation to your app](https://docs.nuon.co/guides/control-plane-integration.md): Enable customers to manage their installs through your UI
- [Idempotent operations](https://docs.nuon.co/guides/idempotent-operations.md): Pass request_id on endpoints that create a workflow so a retry returns the original workflow instead of starting a second one.
- [GitHub Actions](https://docs.nuon.co/guides/github-actions.md): Integrate with Nuon from your GitHub Actions workflows.
- [Webhooks](https://docs.nuon.co/guides/webhooks.md): Receive workflow lifecycle events from your Nuon Org as CloudEvents over HTTP.
- [Configure Triggers](https://docs.nuon.co/guides/triggers.md): Create a trigger, route events with rules, and inspect events and dispatches.
- [Export Runner Audit Logs](https://docs.nuon.co/guides/export-runner-audit-logs.md): Forward Nuon runner audit events to your own OTLP-compatible logging backend.
- [Health Checks](https://docs.nuon.co/guides/health-checks.md): Health checks tell you whether every component on every install is running right now.
- [Slack](https://docs.nuon.co/guides/slack.md): Install the Nuon Slack app, link it to your org, and subscribe channels to deploy, action, and approval events.
- [Using READMEs](https://docs.nuon.co/guides/using-readmes.md): Use READMEs to support operating Installs.
- [Programmable READMEs](https://docs.nuon.co/guides/programmable-readmes.md): READMEs that render each install's live values and embed real-time dashboard components.
- [Custom Install Stacks](https://docs.nuon.co/guides/custom-nested-stacks.md): Provision additional AWS, Azure, or GCP resources with the install stack.
- [Nuon Stack Terraform Provider](https://docs.nuon.co/guides/nuon-stack-terraform-provider.md): Read install configuration and report Terraform install-stack results.
- [Customizing Terraform Stack Templates](https://docs.nuon.co/guides/customizing-terraform-stack-templates.md): Fork or wrap an open-source Terraform install-stack module.
- [CLI Extensions](https://docs.nuon.co/guides/cli-extensions.md): Extend the Nuon CLI with community and first-party plugins.
- [External Image Policies](https://docs.nuon.co/guides/external-image-policies.md): Write OPA policies to enforce security requirements on external container images
- [Using Terraform CLI](https://docs.nuon.co/guides/terraform-cli.md): Run Terraform commands locally against your Nuon-managed sandbox and component workspaces.
- [Agents](https://docs.nuon.co/guides/agents/overview.md): Operate and build Nuon from LLM clients.
- [MCP walkthrough](https://docs.nuon.co/guides/agents/mcp-walkthrough.md): Connect an LLM client to Nuon and run your first queries.
- [Tools](https://docs.nuon.co/guides/agents/tools.md): Control-plane tools available to LLM clients via MCP.
- [Skills](https://docs.nuon.co/guides/agents/skills.md): Guidance for completing tasks in Nuon.
- [Sample prompts](https://docs.nuon.co/guides/agents/sample-queries.md): Prompts to paste into an LLM client after Nuon MCP is connected.
- [AI and App Building](https://docs.nuon.co/guides/agents/ai-and-apps.md): Use AI agents to generate and manage your Nuon app configuration.
- [Introduction](https://docs.nuon.co/platform-support/introduction.md): Overview of supported cloud platforms — AWS, Azure, and Google Cloud — and what's available on each.
- [AWS](https://docs.nuon.co/platform-support/aws.md): Deploy and manage BYOC apps on AWS.
- [Azure](https://docs.nuon.co/platform-support/azure.md): Deploy and manage BYOC apps on Microsoft Azure.
- [Google Cloud](https://docs.nuon.co/platform-support/gcp.md): Deploy and manage BYOC apps on Google Cloud.
- [CLI](https://docs.nuon.co/cli.md): Install the Nuon CLI.
- [Common commands](https://docs.nuon.co/cli-commands.md): The Nuon CLI commands you'll reach for most, from auth to deploy.
- [TUI](https://docs.nuon.co/tui.md): Run entire workflows and trigger install actions via our TUIs
- [API](https://docs.nuon.co/nuon-api.md): Get started using the Nuon API endpoints.
- [Go SDK](https://docs.nuon.co/sdks.md): Use the Nuon Go SDK to integrate with organizations, apps, installs, components, workflows, and other Nuon resources.
- [Configuration Reference](https://docs.nuon.co/config-ref/index.md): Complete reference for Nuon configuration file schemas
- [Configuration Files](https://docs.nuon.co/configuration-files.md): Configure apps using TOML configuration files
- [Container Image](https://docs.nuon.co/config-ref/container-image.md): JSON Schema reference for container-image configuration
- [Helm](https://docs.nuon.co/config-ref/helm.md): JSON Schema reference for helm configuration
- [Kubernetes Manifest](https://docs.nuon.co/config-ref/kubernetes-manifest.md): JSON Schema reference for kubernetes-manifest configuration
- [Pulumi](https://docs.nuon.co/config-ref/pulumi.md): JSON Schema reference for pulumi configuration
- [Terraform](https://docs.nuon.co/config-ref/terraform.md): JSON Schema reference for terraform configuration
- [Action](https://docs.nuon.co/config-ref/action.md): JSON Schema reference for action configuration
- [Branch](https://docs.nuon.co/config-ref/branch.md): JSON Schema reference for branch configuration
- [Break Glass](https://docs.nuon.co/config-ref/break-glass.md): JSON Schema reference for break-glass configuration
- [Inputs](https://docs.nuon.co/config-ref/inputs.md): JSON Schema reference for inputs configuration
- [Install](https://docs.nuon.co/config-ref/install.md): JSON Schema reference for install configuration
- [Installer](https://docs.nuon.co/config-ref/installer.md): JSON Schema reference for installer configuration
- [Metadata](https://docs.nuon.co/config-ref/metadata.md): JSON Schema reference for metadata configuration
- [Permissions](https://docs.nuon.co/config-ref/permissions.md): JSON Schema reference for permissions configuration
- [Permission Policy](https://docs.nuon.co/config-ref/permission-policy.md): JSON Schema reference for permission-policy configuration
- [Policies](https://docs.nuon.co/config-ref/policies.md): JSON Schema reference for policies configuration
- [Runner](https://docs.nuon.co/config-ref/runner.md): JSON Schema reference for runner configuration
- [Sandbox](https://docs.nuon.co/config-ref/sandbox.md): JSON Schema reference for sandbox configuration
- [Secrets](https://docs.nuon.co/config-ref/secrets.md): JSON Schema reference for secrets configuration
- [Stack](https://docs.nuon.co/config-ref/stack.md): JSON Schema reference for stack configuration
- [Platform Architecture](https://docs.nuon.co/architecture/platform.md): How the Nuon Control Plane and Runners work together to orchestrate BYOC deployments.
- [Your App Deployment Diagram](https://docs.nuon.co/architecture/app-deployment.md): Understand what gets deployed into a customer's cloud account when you ship your app through Nuon.
- [Runner Authentication](https://docs.nuon.co/architecture/runner-auth.md): How runners prove their cloud identity to the Nuon Control Plane without storing credentials.
- [Security](https://docs.nuon.co/security.md): How Nuon keeps customer cloud accounts secure throughout the BYOC deployment lifecycle.
- [Changelog](https://docs.nuon.co/updates/updates.md): Learn about new product updates, and what we are working on.
- [041 - Nuon MCP, Health Checks, and Triggers](https://docs.nuon.co/updates/041-agents-health-checks-and-triggers.md): Making your BYOC deployments actionable whether directed by your agent, or an automatic action triggered by an alert.
- [040 - App Branches](https://docs.nuon.co/updates/040-app-branches.md): Connect a git branch to your app and roll changes out across your customer fleet through ordered deployment groups. Plus a read-only role and a cleaner installs CLI.
- [039 - OIDC federation](https://docs.nuon.co/updates/039-oidc-federation.md): Grant access to your Nuon org without storing long-lived tokens.
- [038 - Spacelift install stacks and CLI automation](https://docs.nuon.co/updates/038-spacelift-and-cli-automation.md): Provision install stacks through Spacelift, get improved error messages, and drive the nuon CLI reliably from CI/CD.
- [037 - Split install stack tfvars](https://docs.nuon.co/updates/037-split-install-stack-tfvars.md): Install stack Terraform config is now split into inputs.auto.tfvars and secrets.auto.tfvars.
- [036 - Toggleable Components](https://docs.nuon.co/updates/036-toggleable-components.md): Turn components on and off per install, plus Kubernetes contexts and YAML/HCL inputs.
- [035 - Runbooks and rendered READMEs](https://docs.nuon.co/updates/035-runbooks-and-readmes.md): Notebooks that define common actions you need so you've got a runbook for the next incident or upgrade
- [034 - Slack Integration, Webhooks, and AWS Terraform Stacks](https://docs.nuon.co/updates/034-aws-terraform-install-stack.md): Slack notifications, org-scoped webhooks, and Terraform stacks for AWS.
- [033 - Parallel Workflows, Policy Analytics, and Improved GCP/Azure](https://docs.nuon.co/updates/033-Workflow-Policy-and-improved-cloud-support.md): **New**: Parallel Workflows, Retries, Policy Analytics, Labels  **Improved**: Azure, GCP, Plan Diffs, Runner Management
- [032 - Nuon TUIs and Extensions, Dashboard UX, and Role Management Updates](https://docs.nuon.co/updates/032-extensions-and-roles.md): We're shipping CLI workflow TUIs, CLI Extensions to GA, dashboard-ui shipped major workflow and onboarding improvements, and ctl-api expanded operation role support.
- [031 - Operation Roles](https://docs.nuon.co/updates/031-operation-roles.md): Assign different roles to different operations across sandbox, components, and actions for least-privilege access control.
- [030 - Policies](https://docs.nuon.co/updates/030-policies.md): Enforce compliance, security, and operational standards across component deploys, sandbox runs, and external images.
- [029 - BYO-VPC, Auth & UX Improvements](https://docs.nuon.co/updates/029-auth-inputs-better-nested-templates.md): BYO-VPC support, Nuon Auth service, Runner Auth, and numerous UX improvements
- [028 - Nuon is now Open Source](https://docs.nuon.co/updates/028-open-source.md): Nuon's core platform is now open source, plus new features and improvements.
- [027 - Install config toggle](https://docs.nuon.co/updates/027-install-config-toggle.md): Clearer install config mode switching.
- [026 - Helm Repository Support](https://docs.nuon.co/updates/026-helm-repository-support.md): Deploy charts directly from public Helm repositories.
- [025 - Temporal Workflow Stability Improvements](https://docs.nuon.co/updates/025-temporal-stability.md): Fix issues with component workflows retrying.
- [024 - Improvements to Install Inputs](https://docs.nuon.co/updates/024-install-inputs-ui-redesign.md): Install inputs via CloudFormation stacks, and user-configurable inputs.
- [023 - Drift Scanning Improvements](https://docs.nuon.co/updates/023-drift-workflow-improvements.md): Enhanced drift detection capabilities.
- [022 - Nuon CLI Github Action](https://docs.nuon.co/updates/022-nuon-cli-github-actions.md): GitHub Action for setting up the Nuon CLI in CI/CD workflows
- [021 - Drift Detection for Components and Sandboxes](https://docs.nuon.co/updates/021-drift-detection.md): Detect infrastructure drift automatically on your installations
- [020 - Break glass actions](https://docs.nuon.co/updates/020-break-glass-actions.md): Define actions that customers can enable to break glass.
- [019 - Self-Service Cloud Registration](https://docs.nuon.co/updates/019-self-service.md): Anyone can now sign up for Nuon Cloud
- [018 - Management Mode](https://docs.nuon.co/updates/018-management-mode.md): Runner Management Mode, input updates, and App Variables for storing values across installs.
- [017 - Noop Approvals, Install Config Improvements and more](https://docs.nuon.co/updates/017-noop-approvals-stability-updates.md): Approvals with no changes will automatically be approved, and more stability fixes.
- [016 - Enhanced Install Config Files and Improved Plans](https://docs.nuon.co/updates/016-enhanced-install-config-files-and-improved-plans.md): Directory and file-level install config file syncing. More clear Helm diffs. Improved performance with optimized state management.
- [015 - Azure Support](https://docs.nuon.co/updates/015-azure-support.md): Deploy and manage installs on Azure
- [014 - Install Config Files](https://docs.nuon.co/updates/014-install-config-files.md): Manage Installs via Source Control
- [013 - Kubernetes Manifest Component](https://docs.nuon.co/updates/013-kubernetes-manifest-component.md): New Kubernetes Manifest component type for deploying raw Kubernetes resources into customer cloud accounts.
- [012 - Approval Diffs](https://docs.nuon.co/updates/012-approval-diffs-plan-only.md): Helm teardown diffs, plan-only workflow mode, manual secret sync, and CLI pagination flags.
- [011 - Approval Improvements](https://docs.nuon.co/updates/011-approval-updates.md): Inline workflow retries, auto-approve all steps, UI renames, and team member removal.
- [010 - Approvals](https://docs.nuon.co/updates/010-approvals.md): Workflows now support approvals, so you can verify the helm / terraform plan.
- [009 - Action Triggers, improved configs, default secrets](https://docs.nuon.co/updates/009-action-triggers-secrets-configs.md): Action triggers, improved configs, default secrets.
- [008 - Stack Tab, VCS Import, and Component Build Updates](https://docs.nuon.co/updates/008-vcs-stacks-fixes.md): New stack management features, VCS connection importing, and improved component build system
- [007 - Secret formats, bug fixes](https://docs.nuon.co/updates/007-secret-formats.md): Secrets formats, bug fixes
- [006 - Secrets improvements, workflow retries and bug fixes](https://docs.nuon.co/updates/006-secrets-workflows.md): Secrets improvements, workflow retries and bug fixes.
- [005 - nuon dev and improvements](https://docs.nuon.co/updates/005-developer-experience.md): `nuon dev` allows you to iterate on configs with a single command, view install state, view an app dependency graph and more.
- [004 - Secrets Syncing](https://docs.nuon.co/updates/004-secrets.md): Automatically sync customer secrets into Kubernetes
- [003 - Improvements to deletions, cancellations and more.](https://docs.nuon.co/updates/003-install-deletes-cancel-improvements.md): Improvements to deletions, cancellations and more.
- [002 - Install Inputs, dependencies, and more](https://docs.nuon.co/updates/002-inputs-dependencies.md): Install Inputs, dependencies and more
- [001 - Install Workflow Updates](https://docs.nuon.co/updates/001-install-workflows-actions.md): Updates to install workflows, bug fixes and actions improvements.
- [create a static API token for your org](https://docs.nuon.co/api-ref/accounts/create-an-api-token.md): Creates a long-lived static API token. By default (token_identity "service_account") each token gets its own dedicated service account and only grants access to the current org; the role param controls the token's permissions (any role assignable to API tokens; see GET /v1/roles?context=api_token) a…
- [delete a static API token](https://docs.nuon.co/api-ref/accounts/delete-an-api-token.md): Deletes a static API token belonging to your current org. For service account tokens, the dedicated service account is deleted as well; for personal tokens, only the token is deleted and your account is untouched. Once deleted, the token can no longer be used to access the API.
- [list your org's static API tokens](https://docs.nuon.co/api-ref/accounts/list-api-tokens.md): Lists the static API tokens for your current org. Token secrets are never returned.
- [create action workflow config](https://docs.nuon.co/api-ref/actions/create-action-workflow-config.md): Create an action workflow configuration.
- [create an action workflow run for an install](https://docs.nuon.co/api-ref/actions/create-an-action-workflow-run-for-an-install.md): AppWorkflowConfigId param has been deprecated and is no longer being consumed, the api uses currently install id to lookup related appworkflowconfigId
- [create an app action workflow](https://docs.nuon.co/api-ref/actions/create-an-app.md): Create an action workflow for an app.
- [delete an action workflow](https://docs.nuon.co/api-ref/actions/delete-an-app.md): Delete an action workflow.
- [get action workflow for an app](https://docs.nuon.co/api-ref/actions/get-action-workflow-for-an-app.md): Returns all action workflow configurations.
- [get action workflow runs by install id](https://docs.nuon.co/api-ref/actions/get-action-workflow-runs-by-install-id.md): Returns all action workflow runs for an install.
- [get action workflow runs by install id and run id](https://docs.nuon.co/api-ref/actions/get-action-workflow-runs-by-install-id-and-run-id.md): Return an install action workflow run by id.
- [get action workflows for an app](https://docs.nuon.co/api-ref/actions/get-action-workflows-for-an-app.md): Returns all action workflows for the provided app.
- [get an app action workflow by action workflow id](https://docs.nuon.co/api-ref/actions/get-an-app-action-workflow.md): Return an app action workflow by id.
- [get an app action workflow](https://docs.nuon.co/api-ref/actions/get-an-app-action-workflow-1.md): Return an app action workflow by id.
- [get an app action workflow config](https://docs.nuon.co/api-ref/actions/get-an-app-action-workflow-config.md): Return an action workflow configuration by id.
- [get latest runs for all action workflows by install id](https://docs.nuon.co/api-ref/actions/get-latest-runs-for-all-action-workflows-by-install-id.md): Returns the most recent workflow run for each install action workflow.
- [get recent runs for an action workflow by install id](https://docs.nuon.co/api-ref/actions/get-recent-runs-for-an-action-workflow-by-install-id.md): Returns recent workflow runs for an install action workflow.
- [patch an app](https://docs.nuon.co/api-ref/actions/patch-an-app.md): Update an app action workflow configuration.
- [create an app](https://docs.nuon.co/api-ref/apps/create-an-app.md): Create a new app.
- [Create an app installer](https://docs.nuon.co/api-ref/apps/create-an-app-installer.md)
- [Create an app runner config](https://docs.nuon.co/api-ref/apps/create-an-app-runner-config.md)
- [create an app sandbox config](https://docs.nuon.co/api-ref/apps/create-an-app-sandbox-config.md): Create a sandbox configuration for an app.
- [create an app secret](https://docs.nuon.co/api-ref/apps/create-an-app-secret.md): Create an app secret that can be used to configure components. To reference an app secret, use `.nuon.secrets.<secret_name>`.
- [Create app input configs](https://docs.nuon.co/api-ref/apps/create-app-input-configs.md): App input configs allow you to declare the inputs for your application, and do things such as require customer inputs or  expose configuration knobs in your application.
- [delete an app](https://docs.nuon.co/api-ref/apps/delete-an-app.md): Delete an app.
- [Delete an app installer](https://docs.nuon.co/api-ref/apps/delete-an-app-installer.md)
- [delete an app secret](https://docs.nuon.co/api-ref/apps/delete-an-app-secret.md): Delete an app secret.
- [get all apps for the current org](https://docs.nuon.co/api-ref/apps/get-all-apps-for-the-current-org.md): Returns all apps for the authenticated user.
- [get an app](https://docs.nuon.co/api-ref/apps/get-an-app.md): Return an app.
- [get an app config](https://docs.nuon.co/api-ref/apps/get-an-app-config.md): Fetch an app config by id.
- [get an app config template](https://docs.nuon.co/api-ref/apps/get-an-app-config-template.md): Create an application template which provides a fully rendered config that can be modified and used to kickstart any application.
- [Get an app installer](https://docs.nuon.co/api-ref/apps/get-an-app-installer.md)
- [get app configs](https://docs.nuon.co/api-ref/apps/get-app-configs.md): Returns all configs for the app.
- [Get app input configs](https://docs.nuon.co/api-ref/apps/get-app-input-configs.md)
- [get app runner configs](https://docs.nuon.co/api-ref/apps/get-app-runner-configs.md): Returns all runner configurations for the provided app.
- [get app sandbox configs](https://docs.nuon.co/api-ref/apps/get-app-sandbox-configs.md): Returns all sandbox configurations for the provided app.
- [get app secrets](https://docs.nuon.co/api-ref/apps/get-app-secrets.md): List all secrets for an app.
- [get latest app config](https://docs.nuon.co/api-ref/apps/get-latest-app-config.md): Returns the most recent config for the provided app.
- [get latest app input config](https://docs.nuon.co/api-ref/apps/get-latest-app-input-config.md): Returns the most recent input config for the provided app.
- [get latest app runner config](https://docs.nuon.co/api-ref/apps/get-latest-app-runner-config.md): Returns the most recent runner config for the provided app.
- [get latest app sandbox config](https://docs.nuon.co/api-ref/apps/get-latest-app-sandbox-config.md): Returns the most recent sandbox config for the provided app.
- [Patch v1apps config](https://docs.nuon.co/api-ref/apps/patch-v1apps-config.md): Update an app config, setting status and state.
- [Post v1apps config](https://docs.nuon.co/api-ref/apps/post-v1apps-config.md): Create an app config, by pushing the contents of a config file.
- [Post v1apps input config](https://docs.nuon.co/api-ref/apps/post-v1apps-input-config.md): App input configs allow you to declare the inputs for your application, and do things such as require customer inputs or  expose configuration knobs in your application.
- [Render an app installer](https://docs.nuon.co/api-ref/apps/render-an-app-installer.md)
- [update an app](https://docs.nuon.co/api-ref/apps/update-an-app.md): Update an app's configuration.
- [Update an app installer](https://docs.nuon.co/api-ref/apps/update-an-app-installer.md)
- [create a component](https://docs.nuon.co/api-ref/components/create-a-component.md): Create a new component for an app.
- [create a helm component config](https://docs.nuon.co/api-ref/components/create-a-helm-component-config.md): Create a helm component config.
- [create a terraform component config](https://docs.nuon.co/api-ref/components/create-a-terraform-component-config.md): Create a terraform component config.
- [create an external image component config](https://docs.nuon.co/api-ref/components/create-an-external-image-component-config.md): Create an external image component config.
- [create component build](https://docs.nuon.co/api-ref/components/create-component-build.md): Create a build for a component.
- [delete a component](https://docs.nuon.co/api-ref/components/delete-a-component.md): Delete a component.
- [get a build](https://docs.nuon.co/api-ref/components/get-a-build.md): Returns builds for one or all components in an app.
- [get a build for a component](https://docs.nuon.co/api-ref/components/get-a-build-for-a-component.md): Returns builds for one or all components in an app.
- [get a component](https://docs.nuon.co/api-ref/components/get-a-component.md): Return a component by id.
- [get a component's dependencies](https://docs.nuon.co/api-ref/components/get-a-components-dependencies.md): Returns all dependencies for the provided component.
- [get a components for a specific app](https://docs.nuon.co/api-ref/components/get-a-components-for-a-specific-app.md): Return an app component by id or name.
- [Get all builds for a component](https://docs.nuon.co/api-ref/components/get-all-builds-for-a-component.md)
- [get all components for an app](https://docs.nuon.co/api-ref/components/get-all-components-for-an-app.md): Returns all components for the provided app.
- [get all components for an org](https://docs.nuon.co/api-ref/components/get-all-components-for-an-org.md): Returns all components for the provided organization.
- [get all configs for a component](https://docs.nuon.co/api-ref/components/get-all-configs-for-a-component.md): Returns all configurations for the provided component.
- [get builds for components](https://docs.nuon.co/api-ref/components/get-builds-for-components.md): Returns all builds for the provided component.
- [Get component build logs](https://docs.nuon.co/api-ref/components/get-component-build-logs.md)
- [Get component build plan](https://docs.nuon.co/api-ref/components/get-component-build-plan.md)
- [get latest build for a component](https://docs.nuon.co/api-ref/components/get-latest-build-for-a-component.md): Returns the most recent build for the provided component.
- [get latest config for a component](https://docs.nuon.co/api-ref/components/get-latest-config-for-a-component.md): Returns the most recent config for the provided component.
- [update a component](https://docs.nuon.co/api-ref/components/update-a-component.md): Update a component's configuration.
- [Allow user to be added to an org waitlist.](https://docs.nuon.co/api-ref/general/allow-user-to-be-added-to-an-org-waitlist.md): Add an entry to the waitlist.
- [Get config for cli](https://docs.nuon.co/api-ref/general/get-config-for-cli.md): Returns CLI configuration and settings.
- [Get current user](https://docs.nuon.co/api-ref/general/get-current-user.md): Returns the current authenticated user account.
- [Get jsonschema for config file (deprecated query form)](https://docs.nuon.co/api-ref/general/get-jsonschema-for-config-file.md): Return jsonschemas for Nuon configs. These can be used in frontmatter in most editors that have a TOML LSP (such as [Taplo](https://taplo.tamasfe.dev/) configured.
- [Get regions for a cloud platform](https://docs.nuon.co/api-ref/general/get-regions-for-a-cloud-platform.md): Return region metadata for the Nuon supported cloud platforms.
- [Publish a metric from different nuon clients for telemetry purposes](https://docs.nuon.co/api-ref/general/publish-a-metric-from-different-nuon-clients-for-telemetry-purposes.md)
- [Create an installer](https://docs.nuon.co/api-ref/installers/create-an-installer.md)
- [Delete an installer](https://docs.nuon.co/api-ref/installers/delete-an-installer.md)
- [Get an installer](https://docs.nuon.co/api-ref/installers/get-an-installer.md)
- [Get installers for current org](https://docs.nuon.co/api-ref/installers/get-installers-for-current-org.md)
- [Render an installer](https://docs.nuon.co/api-ref/installers/render-an-installer.md)
- [Update an installer](https://docs.nuon.co/api-ref/installers/update-an-installer.md)
- [create an app install](https://docs.nuon.co/api-ref/installs/create-an-app-install.md): Create a new install for an app.
- [Create an app install from an installer](https://docs.nuon.co/api-ref/installs/create-an-app-install-from-an-installer.md)
- [create install inputs](https://docs.nuon.co/api-ref/installs/create-install-inputs.md): Create input values for an install.
- [delete an install](https://docs.nuon.co/api-ref/installs/delete-an-install.md): Delete an install.
- [deploy a build to an install](https://docs.nuon.co/api-ref/installs/deploy-a-build-to-an-install.md): Create a new deployment for an install.
- [deploy all components on an install](https://docs.nuon.co/api-ref/installs/deploy-all-components-on-an-install.md): Deploy all components to an install.
- [deprovision an install](https://docs.nuon.co/api-ref/installs/deprovision-an-install.md): Deprovision an install sandbox.
- [get all deploys to an install](https://docs.nuon.co/api-ref/installs/get-all-deploys-to-an-install.md): Returns all deployments for an install.
- [get all installs for an app](https://docs.nuon.co/api-ref/installs/get-all-installs-for-an-app.md): Returns all installs for the provided app.
- [get all installs for an org](https://docs.nuon.co/api-ref/installs/get-all-installs-for-an-org.md): Returns all installs for the provided organization.
- [get an install](https://docs.nuon.co/api-ref/installs/get-an-install.md): Return an install by id.
- [Get an install component](https://docs.nuon.co/api-ref/installs/get-an-install-component.md)
- [get an install component outputs](https://docs.nuon.co/api-ref/installs/get-an-install-component-outputs.md): Return the latest outputs for a component.
- [get an install components deploys](https://docs.nuon.co/api-ref/installs/get-an-install-components-deploys.md): Returns all deployments for an install component.
- [get an install's latest deploy](https://docs.nuon.co/api-ref/installs/get-an-install-deploy.md): Returns the most recent deployment for an install.
- [get an install deploy](https://docs.nuon.co/api-ref/installs/get-an-install-deploy-1.md): Return a deployment for an install by id.
- [get an install event](https://docs.nuon.co/api-ref/installs/get-an-install-event.md): Get a single install event.
- [Get an installer install](https://docs.nuon.co/api-ref/installs/get-an-installer-install.md)
- [get an installs components](https://docs.nuon.co/api-ref/installs/get-an-installs-components.md): Returns all components for an install.
- [get an installs current inputs](https://docs.nuon.co/api-ref/installs/get-an-installs-current-inputs.md): Returns input values for an install.
- [get an installs inputs](https://docs.nuon.co/api-ref/installs/get-an-installs-inputs.md): Returns input values for an install.
- [Get an install's runner group](https://docs.nuon.co/api-ref/installs/get-an-installs-runner-group.md): Return the runner group, including runners and settings for the provided install.
- [get an installs sandbox runs](https://docs.nuon.co/api-ref/installs/get-an-installs-sandbox-runs.md): Returns all sandbox runs for an install.
- [get events for an install](https://docs.nuon.co/api-ref/installs/get-events-for-an-install.md): # Get Install Events
- [Get install deploy plan](https://docs.nuon.co/api-ref/installs/get-install-deploy-plan.md)
- [get install readme rendered with](https://docs.nuon.co/api-ref/installs/get-install-readme-rendered-with.md): Returns the `app.readme` markdown with the values interpolated from the install inputs and component outputs.
- [Get install sandbox run logs](https://docs.nuon.co/api-ref/installs/get-install-sandbox-run-logs.md)
- [get the latest deploy for an install component](https://docs.nuon.co/api-ref/installs/get-the-latest-deploy-for-an-install-component.md): Returns the most recent deployment for an install component.
- [reprovision an install](https://docs.nuon.co/api-ref/installs/reprovision-an-install.md): Reprovision an install sandbox.
- [teardown an install component](https://docs.nuon.co/api-ref/installs/teardown-an-install-component.md): Teardown and remove an install component's resources.
- [teardown an install's components](https://docs.nuon.co/api-ref/installs/teardown-an-installs-components.md): Teardown all components on an install.
- [update an install](https://docs.nuon.co/api-ref/installs/update-an-install.md): Update an install's settings.
- [Updates install input config for app](https://docs.nuon.co/api-ref/installs/update-an-install-input.md): Update input values for an install.
- [Updates install input config for app](https://docs.nuon.co/api-ref/installs/updates-install-input-config-for-app.md): Update input values for an install.
- [Add a user to the current org](https://docs.nuon.co/api-ref/orgs/add-a-user-to-the-current-org.md): Add a user to an organization.
- [create a new org](https://docs.nuon.co/api-ref/orgs/create-a-new-org.md): Create a new organization.
- [Delete an org](https://docs.nuon.co/api-ref/orgs/delete-an-org.md): Delete an organization.
- [Get an org](https://docs.nuon.co/api-ref/orgs/get-an-org.md): Return an organization by id.
- [Get an orgs health checks](https://docs.nuon.co/api-ref/orgs/get-an-orgs-health-checks.md)
- [Get an orgs runner group](https://docs.nuon.co/api-ref/orgs/get-an-orgs-runner-group.md)
- [Invite a user to the current org](https://docs.nuon.co/api-ref/orgs/invite-a-user-to-the-current-org.md): Invite a user (by email) to an org.
- [Return current user's orgs](https://docs.nuon.co/api-ref/orgs/return-current-users-orgs.md): Returns all organizations for the authenticated user.
- [Return org invites](https://docs.nuon.co/api-ref/orgs/return-org-invites.md): Returns a list of all invites to the org.
- [Update current org](https://docs.nuon.co/api-ref/orgs/update-current-org.md): Update an organization's settings.
- [Create a release](https://docs.nuon.co/api-ref/releases/create-a-release.md)
- [Get a release](https://docs.nuon.co/api-ref/releases/get-a-release.md)
- [Get a release 1](https://docs.nuon.co/api-ref/releases/get-a-release-1.md)
- [Get all releases for a component](https://docs.nuon.co/api-ref/releases/get-all-releases-for-a-component.md)
- [Get all releases for an app](https://docs.nuon.co/api-ref/releases/get-all-releases-for-an-app.md)
- [List your org's roles](https://docs.nuon.co/api-ref/roles/list-roles.md): List your org's roles. Each role carries its display metadata (`title`, `description`) and the assignment surfaces it may be offered on via the `applies_to` field (`team`, `service_account`, `api_token`, `oidc_trust_policy`). A role with no `applies_to` entries exists and may be displayed, but canno…
- [Cancel runner job](https://docs.nuon.co/api-ref/runners/cancel-runner-job.md)
- [get a log stream](https://docs.nuon.co/api-ref/runners/get-a-log-stream.md): Return a log stream.
- [get runner job](https://docs.nuon.co/api-ref/runners/get-runner-job.md): Return a runner job.
- [Get runner job execution](https://docs.nuon.co/api-ref/runners/get-runner-job-execution.md)
- [get runner job plan](https://docs.nuon.co/api-ref/runners/get-runner-job-plan.md): Return a plan for a runner job.
- [get runner jobs](https://docs.nuon.co/api-ref/runners/get-runner-jobs.md): Return runner jobs.
- [read a log stream's logs](https://docs.nuon.co/api-ref/runners/read-a-log-streams-logs.md): Read OTEL formatted logs for a log stream.
- [Get a runner](https://docs.nuon.co/api-ref/runnersrunner/get-a-runner.md)
- [Get runner job executions](https://docs.nuon.co/api-ref/runnersrunner/get-runner-job-executions.md)
- [get runner settings](https://docs.nuon.co/api-ref/runnersrunner/get-runner-settings.md): Return runner settings for the provided runner.
- [Get a sandbox](https://docs.nuon.co/api-ref/sandboxes/get-a-sandbox.md)
- [Get all sandboxes](https://docs.nuon.co/api-ref/sandboxes/get-all-sandboxes.md)
- [Get sandbox releases](https://docs.nuon.co/api-ref/sandboxes/get-sandbox-releases.md)
- [Create a service account for the current org](https://docs.nuon.co/api-ref/service-accounts/create-a-service-account.md): Create a service account for the current org. Service accounts can be used to generate API tokens for automation and CI/CD workflows.
- [Create a token for a service account in the current org](https://docs.nuon.co/api-ref/service-accounts/create-a-service-account-token.md): Create an API token for a service account in the current org.
- [Delete a service account for the current org](https://docs.nuon.co/api-ref/service-accounts/delete-a-service-account.md): Delete a service account from the current org.
- [List service accounts for the current org](https://docs.nuon.co/api-ref/service-accounts/list-service-accounts.md): List the service accounts that belong to the current organization, along with their roles. Supports offset-based pagination.
- [Update a service account for the current org](https://docs.nuon.co/api-ref/service-accounts/update-a-service-account.md): Update a service account's human-friendly name. The account's email and ID are immutable; only the display name changes.
- [Update the role of a service account for the current org](https://docs.nuon.co/api-ref/service-accounts/update-a-service-account-role.md): Update the role assigned to a service account in the current org.
- [create a vcs connection for Github](https://docs.nuon.co/api-ref/vcs/create-a-vcs-connection-for-github.md): Create a VCS connection for version control integration.
- [Get all vcs connected repos for an org](https://docs.nuon.co/api-ref/vcs/get-all-vcs-connected-repos-for-an-org.md)
- [get vcs connection for an org](https://docs.nuon.co/api-ref/vcs/get-vcs-connection-for-an-org.md): Returns all VCS connections for the provided organization.
- [public connection to create a vcs connection via a callback](https://docs.nuon.co/api-ref/vcs/public-connection-to-create-a-vcs-connection-via-a-callback.md): Handle VCS connection callback for OAuth flow.
- [returns a vcs connection for an org](https://docs.nuon.co/api-ref/vcs/returns-a-vcs-connection-for-an-org.md): Return a VCS connection by id.
- [API](https://docs.nuon.co/concepts/api.md): Create and manage installs programmatically via the Nuon Control Plane API.
- [Dashboard](https://docs.nuon.co/concepts/dashboard.md): What you can do for installs in the Nuon dashboard.
- [Input](https://docs.nuon.co/config-ref/input.md): JSON Schema reference for input configuration
- [Input Group](https://docs.nuon.co/config-ref/input-group.md): JSON Schema reference for input-group configuration
- [Installs Config](https://docs.nuon.co/config-ref/installs-config.md): JSON Schema reference for installs-config configuration
- [Job](https://docs.nuon.co/config-ref/job.md): JSON Schema reference for job configuration
- [Kubernetes Context](https://docs.nuon.co/config-ref/kubernetes-context.md): JSON Schema reference for kubernetes-context configuration
- [Kubernetes Contexts](https://docs.nuon.co/config-ref/kubernetes-contexts.md): JSON Schema reference for kubernetes-contexts configuration
- [Permission](https://docs.nuon.co/config-ref/permission.md): JSON Schema reference for permission configuration
- [Policy](https://docs.nuon.co/config-ref/policy.md): JSON Schema reference for policy configuration
- [Runbook](https://docs.nuon.co/config-ref/runbook.md): JSON Schema reference for runbook configuration
- [Secret](https://docs.nuon.co/config-ref/secret.md): JSON Schema reference for secret configuration
- [Dashboard](https://docs.nuon.co/dashboard.md): Manage your Nuon apps and installs using the web-based dashboard
- [Create An AWS EC2 App](https://docs.nuon.co/get-started/app-aws-ec2.md): Learn how to package and install a Cloud Development Environment (CDE) on AWS EC2.
- [Create an AWS EKS App](https://docs.nuon.co/get-started/app-aws-k8s.md): Learn how to package and deploy a Helm app to AWS EKS.
- [Create An AWS Lambda App](https://docs.nuon.co/get-started/app-aws-lambda.md): Learn how to package and install an AWS Lambda app.
- [Support](https://docs.nuon.co/support/support.md): Get help with the Nuon platform.
- [AGENTS](https://docs.nuon.co/updates/AGENTS.md)

## OpenAPI Specs

- [v3](https://api.nuon.co/oapi/v3)
- [v3](/v3)

## Optional

- [Knowledge Base](https://support.nuon.co)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.