# Stackdome

> Deploy, debug, and operate applications with coding agents, the Stackdome CLI, or the dashboard. Start on Stackdome Cloud or connect a self-hosted installation.

> ## Agent Instructions
> Treat Stackdome as an application-delivery platform for coding agents and developers, not as a Kubernetes dashboard.
> Prefer the Stackdome agent plugin as the user entry point and the stackdome CLI as the execution interface.
> Route agents who need the maintained deploy skill to npx skills add stackdome/skills and the complete operational workflow to /guides/ai-agents.
> Verify commands and flags with stackdome --help. Run stackdome init before authoring stackfile.yaml and stackdome validate before deploying.
> Use -o json for automation and verify documented terminal states before claiming success.
> Never request a user's account password. Use API-token authentication.
> During alpha, Stackdome Cloud is ephemeral and capacity-limited, and each organization can connect one cluster.
> Do not expose Kubernetes as a user concern unless the task is self-hosting or infrastructure architecture.

## Docs

- [Add a member to a project](https://docs.stackdome.com/api-reference/add-a-member-to-a-project.md)
- [Add a new cluster](https://docs.stackdome.com/api-reference/add-a-new-cluster.md)
- [Add a new ObjectStore for backup storage](https://docs.stackdome.com/api-reference/add-a-new-objectstore-for-backup-storage.md): Add a new ObjectStore configuration for storing PostgreSQL backups and WAL files
- [Apply a full stack document by name (declarative upsert)](https://docs.stackdome.com/api-reference/apply-a-full-stack-document-by-name-declarative-upsert.md): Name-addressed declarative whole-document apply. Stack identity is the `name` in the request body (unique per project). If a stack with that name exists in the project it is reconciled exactly like the id-addressed apply (resources and connections not present in the body are deleted, volumes are add…
- [Apply a full stack document (declarative reconcile)](https://docs.stackdome.com/api-reference/apply-a-full-stack-document-declarative-reconcile.md): Declarative whole-document apply. Reconciles the stack against the supplied document: resources and connections not present in the body are deleted, while volumes are add-only and are never deleted. This is the only endpoint that accepts a full stack document.
- [Create a git integration for the organization](https://docs.stackdome.com/api-reference/create-a-git-integration-for-the-organization.md)
- [Create a new API token](https://docs.stackdome.com/api-reference/create-a-new-api-token.md)
- [Create a new image registry](https://docs.stackdome.com/api-reference/create-a-new-image-registry.md)
- [Create a new PostgresAddon](https://docs.stackdome.com/api-reference/create-a-new-postgresaddon.md): Create a new PostgreSQL database cluster addon
- [Create a new project](https://docs.stackdome.com/api-reference/create-a-new-project.md)
- [Create a new secret](https://docs.stackdome.com/api-reference/create-a-new-secret.md)
- [Create a new stack](https://docs.stackdome.com/api-reference/create-a-new-stack.md): Creates a thin stack shell (name, labels, annotations, settings). Any inline `stack_resources`, `volumes`, or `connections` in the body are ignored — add children via `PUT /stacks/{id}/apply` or the individual sub-resource endpoints.
- [Create a new volume](https://docs.stackdome.com/api-reference/create-a-new-volume.md)
- [Create a new workspace user](https://docs.stackdome.com/api-reference/create-a-new-workspace-user.md)
- [Create a registry credential for the organization](https://docs.stackdome.com/api-reference/create-a-registry-credential-for-the-organization.md)
- [Create a stack resource](https://docs.stackdome.com/api-reference/create-a-stack-resource.md)
- [Create a volume and associate it with the stack](https://docs.stackdome.com/api-reference/create-a-volume-and-associate-it-with-the-stack.md)
- [Create an invite to the organization](https://docs.stackdome.com/api-reference/create-an-invite-to-the-organization.md)
- [Create new user](https://docs.stackdome.com/api-reference/create-new-user.md): Create a new user
- [Create stack connection](https://docs.stackdome.com/api-reference/create-stack-connection.md)
- [Delete a cluster](https://docs.stackdome.com/api-reference/delete-a-cluster.md)
- [Delete a git integration](https://docs.stackdome.com/api-reference/delete-a-git-integration.md)
- [Delete a PostgresAddon](https://docs.stackdome.com/api-reference/delete-a-postgresaddon.md)
- [Delete a project](https://docs.stackdome.com/api-reference/delete-a-project.md)
- [Delete a registry credential](https://docs.stackdome.com/api-reference/delete-a-registry-credential.md): Deletion is never blocked; the response lists stacks that were implicitly resolving against this credential so rotations are visible.
- [Delete a secret](https://docs.stackdome.com/api-reference/delete-a-secret.md)
- [Delete a stack](https://docs.stackdome.com/api-reference/delete-a-stack.md)
- [Delete a stack resource](https://docs.stackdome.com/api-reference/delete-a-stack-resource.md)
- [Delete a volume](https://docs.stackdome.com/api-reference/delete-a-volume.md)
- [Delete a workspace user](https://docs.stackdome.com/api-reference/delete-a-workspace-user.md)
- [Delete an image registry](https://docs.stackdome.com/api-reference/delete-an-image-registry.md)
- [Delete an ObjectStore](https://docs.stackdome.com/api-reference/delete-an-objectstore.md)
- [Delete stack connection](https://docs.stackdome.com/api-reference/delete-stack-connection.md)
- [Demote an organization admin](https://docs.stackdome.com/api-reference/demote-an-organization-admin.md): Demotes an OrgAdmin and places them in the specified project with the given role (defaults to Viewer).
- [Fence or unfence the PostgreSQL cluster](https://docs.stackdome.com/api-reference/fence-or-unfence-the-postgresql-cluster.md)
- [Get a git integration](https://docs.stackdome.com/api-reference/get-a-git-integration.md)
- [Get a registry credential](https://docs.stackdome.com/api-reference/get-a-registry-credential.md)
- [Get a specific build under a stack](https://docs.stackdome.com/api-reference/get-a-specific-build-under-a-stack.md)
- [Get a specific cluster](https://docs.stackdome.com/api-reference/get-a-specific-cluster.md)
- [Get a specific image registry](https://docs.stackdome.com/api-reference/get-a-specific-image-registry.md)
- [Get a specific ObjectStore](https://docs.stackdome.com/api-reference/get-a-specific-objectstore.md)
- [Get a specific PostgresAddon](https://docs.stackdome.com/api-reference/get-a-specific-postgresaddon.md)
- [Get a specific project by name](https://docs.stackdome.com/api-reference/get-a-specific-project-by-name.md)
- [Get a specific secret](https://docs.stackdome.com/api-reference/get-a-specific-secret.md)
- [Get a specific stack](https://docs.stackdome.com/api-reference/get-a-specific-stack.md)
- [Get a specific stack resource by name](https://docs.stackdome.com/api-reference/get-a-specific-stack-resource-by-name.md)
- [Get a specific volume](https://docs.stackdome.com/api-reference/get-a-specific-volume.md)
- [Get a user](https://docs.stackdome.com/api-reference/get-a-user.md): Get a user
- [Get a workspace user by ID](https://docs.stackdome.com/api-reference/get-a-workspace-user-by-id.md)
- [Get an API token by ID](https://docs.stackdome.com/api-reference/get-an-api-token-by-id.md)
- [Get an invite by ID](https://docs.stackdome.com/api-reference/get-an-invite-by-id.md)
- [Get an organization](https://docs.stackdome.com/api-reference/get-an-organization.md)
- [Get JIT credentials for a PostgresAddon database](https://docs.stackdome.com/api-reference/get-jit-credentials-for-a-postgresaddon-database.md)
- [Get logs for a stack](https://docs.stackdome.com/api-reference/get-logs-for-a-stack.md)
- [Get logs for a stack resource](https://docs.stackdome.com/api-reference/get-logs-for-a-stack-resource.md)
- [Get logs for an image build](https://docs.stackdome.com/api-reference/get-logs-for-an-image-build.md)
- [Get metrics for a stack](https://docs.stackdome.com/api-reference/get-metrics-for-a-stack.md): Returns metrics for a stack. If `stream=true` is passed, the server responds using Server-Sent Events (SSE).
- [Get metrics for a stack resource](https://docs.stackdome.com/api-reference/get-metrics-for-a-stack-resource.md): Returns metrics for a stack resource. If `stream=true` is passed, the server responds using Server-Sent Events (SSE).
- [Get public application configuration](https://docs.stackdome.com/api-reference/get-public-application-configuration.md): Returns feature flags the web client needs before authentication, such as whether GitHub OAuth is enabled.
- [Get public invite info (unauthenticated)](https://docs.stackdome.com/api-reference/get-public-invite-info-unauthenticated.md)
- [Get repository details through the GitHub App installation](https://docs.stackdome.com/api-reference/get-repository-details-through-the-github-app-installation.md)
- [Get stack topology](https://docs.stackdome.com/api-reference/get-stack-topology.md)
- [Get the current authenticated user](https://docs.stackdome.com/api-reference/get-the-current-authenticated-user.md)
- [Get the workspace user for the current user](https://docs.stackdome.com/api-reference/get-the-workspace-user-for-the-current-user.md)
- [GitHub App manifest redirect target (unauthenticated, state-validated)](https://docs.stackdome.com/api-reference/github-app-manifest-redirect-target-unauthenticated-state-validated.md)
- [GitHub OAuth callback](https://docs.stackdome.com/api-reference/github-oauth-callback.md): Handles the callback from GitHub after OAuth authorization
- [GitHub webhook receiver (unauthenticated, HMAC-verified)](https://docs.stackdome.com/api-reference/github-webhook-receiver-unauthenticated-hmac-verified.md)
- [Hibernate or wake the PostgreSQL cluster](https://docs.stackdome.com/api-reference/hibernate-or-wake-the-postgresql-cluster.md)
- [Initiate GitHub OAuth flow](https://docs.stackdome.com/api-reference/initiate-github-oauth-flow.md): Redirects the user to GitHub for OAuth authorization
- [List all API tokens for the current user](https://docs.stackdome.com/api-reference/list-all-api-tokens-for-the-current-user.md)
- [List all available API token scopes](https://docs.stackdome.com/api-reference/list-all-available-api-token-scopes.md): Returns the list of resources and their allowed actions that can be used when creating API tokens
- [List all builds for a stack resource](https://docs.stackdome.com/api-reference/list-all-builds-for-a-stack-resource.md)
- [List all builds under a stack](https://docs.stackdome.com/api-reference/list-all-builds-under-a-stack.md)
- [List all clusters for an organization](https://docs.stackdome.com/api-reference/list-all-clusters-for-an-organization.md)
- [List all image registries for a cluster](https://docs.stackdome.com/api-reference/list-all-image-registries-for-a-cluster.md)
- [List all image registries for an organisation](https://docs.stackdome.com/api-reference/list-all-image-registries-for-an-organisation.md)
- [List all object stores the user has access to across all projects](https://docs.stackdome.com/api-reference/list-all-object-stores-the-user-has-access-to-across-all-projects.md): Returns object stores from all projects the user belongs to. OrgAdmins see all object stores in the org.
- [List all ObjectStores for a project](https://docs.stackdome.com/api-reference/list-all-objectstores-for-a-project.md)
- [List all PostgresAddons for a project](https://docs.stackdome.com/api-reference/list-all-postgresaddons-for-a-project.md)
- [List all projects in an organization](https://docs.stackdome.com/api-reference/list-all-projects-in-an-organization.md)
- [List all secrets for a project](https://docs.stackdome.com/api-reference/list-all-secrets-for-a-project.md)
- [List all secrets the user has access to across all projects](https://docs.stackdome.com/api-reference/list-all-secrets-the-user-has-access-to-across-all-projects.md): Returns secrets from all projects the user belongs to. OrgAdmins see all secrets in the org.
- [List all stack resources under a stack](https://docs.stackdome.com/api-reference/list-all-stack-resources-under-a-stack.md)
- [List all stacks for a project](https://docs.stackdome.com/api-reference/list-all-stacks-for-a-project.md)
- [List all stacks the user has access to across all projects](https://docs.stackdome.com/api-reference/list-all-stacks-the-user-has-access-to-across-all-projects.md): Returns stacks from all projects the user belongs to. OrgAdmins see all stacks in the org.
- [List all users in an organization](https://docs.stackdome.com/api-reference/list-all-users-in-an-organization.md)
- [List available project membership roles](https://docs.stackdome.com/api-reference/list-available-project-membership-roles.md): Returns the list of roles that can be assigned to project members.
- [List backups for a PostgresAddon](https://docs.stackdome.com/api-reference/list-backups-for-a-postgresaddon.md)
- [List git integrations for the organization](https://docs.stackdome.com/api-reference/list-git-integrations-for-the-organization.md)
- [List GitHub App installations](https://docs.stackdome.com/api-reference/list-github-app-installations.md)
- [List invites for an organization](https://docs.stackdome.com/api-reference/list-invites-for-an-organization.md)
- [List members of a project](https://docs.stackdome.com/api-reference/list-members-of-a-project.md)
- [List organization admins](https://docs.stackdome.com/api-reference/list-organization-admins.md)
- [List projects for the current authenticated user](https://docs.stackdome.com/api-reference/list-projects-for-the-current-authenticated-user.md)
- [List registry credentials for the organization](https://docs.stackdome.com/api-reference/list-registry-credentials-for-the-organization.md)
- [List repositories visible to the GitHub App installation](https://docs.stackdome.com/api-reference/list-repositories-visible-to-the-github-app-installation.md)
- [List repository branches through the GitHub App installation](https://docs.stackdome.com/api-reference/list-repository-branches-through-the-github-app-installation.md)
- [List stack connections](https://docs.stackdome.com/api-reference/list-stack-connections.md)
- [Platform GitHub App setup redirect target (unauthenticated, state-validated)](https://docs.stackdome.com/api-reference/platform-github-app-setup-redirect-target-unauthenticated-state-validated.md)
- [Create a new preview config](https://docs.stackdome.com/api-reference/preview-configs/create-a-new-preview-config.md)
- [Delete a preview config](https://docs.stackdome.com/api-reference/preview-configs/delete-a-preview-config.md)
- [Get a specific preview config](https://docs.stackdome.com/api-reference/preview-configs/get-a-specific-preview-config.md)
- [List preview configs for a project](https://docs.stackdome.com/api-reference/preview-configs/list-preview-configs-for-a-project.md)
- [Update a preview config](https://docs.stackdome.com/api-reference/preview-configs/update-a-preview-config.md)
- [Create a new preview stack](https://docs.stackdome.com/api-reference/preview-stacks/create-a-new-preview-stack.md)
- [Delete a preview stack](https://docs.stackdome.com/api-reference/preview-stacks/delete-a-preview-stack.md)
- [Get a specific preview stack](https://docs.stackdome.com/api-reference/preview-stacks/get-a-specific-preview-stack.md)
- [List preview stacks for a project](https://docs.stackdome.com/api-reference/preview-stacks/list-preview-stacks-for-a-project.md)
- [Sync a preview stack](https://docs.stackdome.com/api-reference/preview-stacks/sync-a-preview-stack.md)
- [Promote a user to organization admin](https://docs.stackdome.com/api-reference/promote-a-user-to-organization-admin.md)
- [Re-queue invite email for delivery](https://docs.stackdome.com/api-reference/re-queue-invite-email-for-delivery.md)
- [Refresh JWT token](https://docs.stackdome.com/api-reference/refresh-jwt-token.md): Exchange a refresh token for a new access token
- [Cancel a pending or rendering release](https://docs.stackdome.com/api-reference/releases/cancel-a-pending-or-rendering-release.md)
- [Create a new release (deploy)](https://docs.stackdome.com/api-reference/releases/create-a-new-release-deploy.md)
- [Get a release by ID](https://docs.stackdome.com/api-reference/releases/get-a-release-by-id.md)
- [List release events ordered by sequence](https://docs.stackdome.com/api-reference/releases/list-release-events-ordered-by-sequence.md)
- [List releases for a stack](https://docs.stackdome.com/api-reference/releases/list-releases-for-a-stack.md)
- [Stream release events via Server-Sent Events](https://docs.stackdome.com/api-reference/releases/stream-release-events-via-server-sent-events.md)
- [Remove a member from a project](https://docs.stackdome.com/api-reference/remove-a-member-from-a-project.md)
- [Restart a stack resource](https://docs.stackdome.com/api-reference/restart-a-stack-resource.md): Triggers a rolling restart of the stack resource by setting a new restart request timestamp.
- [Revoke a pending invite](https://docs.stackdome.com/api-reference/revoke-a-pending-invite.md)
- [Revoke an API token](https://docs.stackdome.com/api-reference/revoke-an-api-token.md)
- [Start the GitHub App manifest flow for the organization](https://docs.stackdome.com/api-reference/start-the-github-app-manifest-flow-for-the-organization.md)
- [Trigger an immediate backup](https://docs.stackdome.com/api-reference/trigger-an-immediate-backup.md)
- [Update a git integration (credential rotation)](https://docs.stackdome.com/api-reference/update-a-git-integration-credential-rotation.md)
- [Update a PostgresAddon](https://docs.stackdome.com/api-reference/update-a-postgresaddon.md)
- [Update a project](https://docs.stackdome.com/api-reference/update-a-project.md)
- [Update a project member's role](https://docs.stackdome.com/api-reference/update-a-project-members-role.md)
- [Update a registry credential (username/password rotation)](https://docs.stackdome.com/api-reference/update-a-registry-credential-usernamepassword-rotation.md)
- [Update a secret](https://docs.stackdome.com/api-reference/update-a-secret.md)
- [Update a stack](https://docs.stackdome.com/api-reference/update-a-stack.md): Updates only shell fields (name, labels, annotations, settings). `namespace` is immutable. Child collections (`stack_resources`, `volumes`, `connections`) in the body are ignored — use `PUT /stacks/{id}/apply` for a full reconcile.
- [Update a stack resource](https://docs.stackdome.com/api-reference/update-a-stack-resource.md)
- [Update a workspace user](https://docs.stackdome.com/api-reference/update-a-workspace-user.md)
- [Update an ObjectStore](https://docs.stackdome.com/api-reference/update-an-objectstore.md)
- [Update an organization](https://docs.stackdome.com/api-reference/update-an-organization.md)
- [Update stack connection](https://docs.stackdome.com/api-reference/update-stack-connection.md)
- [User login](https://docs.stackdome.com/api-reference/user-login.md): Authenticate user and generate an access token
- [Verify a git integration against a repository](https://docs.stackdome.com/api-reference/verify-a-git-integration-against-a-repository.md)
- [Verify a registry credential against a repository](https://docs.stackdome.com/api-reference/verify-a-registry-credential-against-a-repository.md)
- [Releases](https://docs.stackdome.com/concepts/releases.md): Identify, verify, inspect, cancel, and roll back Stackdome releases.
- [Stacks and resources](https://docs.stackdome.com/concepts/stacks-and-resources.md): How Stackdome models an application: stacks, resources, sources, and ports.
- [Deploy using the dashboard](https://docs.stackdome.com/deploy-first-app.md): Use the visual Stackdome editor to take a git repository from zero to a live URL.
- [Quickstart with the CLI](https://docs.stackdome.com/get-started/cli.md): Authenticate, create a Stackfile, deploy an application, and verify its status with the Stackdome CLI.
- [Stackdome Cloud during alpha](https://docs.stackdome.com/get-started/cloud-alpha.md): Availability, ephemerality, and fallback options for Stackdome Cloud during alpha.
- [Deploy with a coding agent](https://docs.stackdome.com/guides/ai-agents.md): The canonical Stackdome workflow for coding agents, including verification and failure recovery.
- [Diagnose build failures](https://docs.stackdome.com/guides/build-failures.md): Trace a failed image build from its structured status to condition evidence and build logs.
- [Deploy from git](https://docs.stackdome.com/guides/deploy-from-git.md): Connect a git provider and build your repository into a running resource.
- [Deploy from an image](https://docs.stackdome.com/guides/deploy-from-image.md): Run an existing container image, including images from private registries.
- [Domains and TLS](https://docs.stackdome.com/guides/domains-and-tls.md): Configure your organization domain and understand the hostnames Stackdome generates.
- [Environment variables and secrets](https://docs.stackdome.com/guides/environment-variables.md): Set configuration on a resource, reference secrets and addons, and wire one resource's address into another.
- [Inspect runtime logs](https://docs.stackdome.com/guides/logs.md): Read and follow stack or resource runtime logs, select time windows, and distinguish runtime logs from build logs.
- [Postgres](https://docs.stackdome.com/guides/postgres.md): Create a managed Postgres instance and connect it to your resources.
- [Preview environments](https://docs.stackdome.com/guides/preview-environments.md): Create a temporary environment for every pull request.
- [Restart a resource](https://docs.stackdome.com/guides/restart.md): Restart one running resource without changing stack configuration or creating a rollback.
- [Create a Stackfile](https://docs.stackdome.com/guides/stackfile.md): Generate a Stackfile from repository evidence, review Compose conversion warnings, and validate it before deployment.
- [Inspect stack status](https://docs.stackdome.com/guides/status.md): Check release convergence, runtime health, resource state, and condition history with the Stackdome CLI.
- [Volumes and object stores](https://docs.stackdome.com/guides/volumes-and-object-stores.md): Give a resource persistent storage, and register object stores for backups.
- [Stackdome documentation](https://docs.stackdome.com/index.md): Deploy, debug, and operate applications with coding agents, the CLI, or the dashboard.
- [Quickstart with a coding agent](https://docs.stackdome.com/quickstart.md): Ask a coding agent to deploy your repository and return its live Stackdome URL.
- [Alpha limitations](https://docs.stackdome.com/reference/alpha-limitations.md): Current Stackdome Cloud availability, lifecycle, connected-compute, and multi-cluster limits.
- [Authentication and API tokens](https://docs.stackdome.com/reference/authentication.md): Authenticate agents and CI with API tokens, control scope with environment variables, and keep passwords out of automation.
- [CLI reference](https://docs.stackdome.com/reference/cli.md): Stackdome CLI commands, global flags, structured output behavior, environment variables, and exit codes.
- [Stackfile reference](https://docs.stackdome.com/reference/stackfile.md): Author Stackfiles for images, git builds, networking, environment, secrets, addons, volumes, and workload types.
- [Self-hosted architecture](https://docs.stackdome.com/self-host/architecture.md): How the Stackdome hub, PostgreSQL, cluster agent, and Kubernetes custom resources reconcile application state.
- [Configuration](https://docs.stackdome.com/self-host/configuration.md): Environment variables that configure the Stackdome API server.
- [Connect compute](https://docs.stackdome.com/self-host/connect-compute.md): Connect the single Kubernetes compute target an organization can use during alpha.
- [Install Stackdome](https://docs.stackdome.com/self-host/install.md): Installer flags, prerequisites, DNS, and what a fresh install creates.

## OpenAPI Specs

- [openapi](https://docs.stackdome.com/openapi.yaml)