# Kapten Docs > Deploy applications, jobs and databases to your own Kubernetes clusters with Kapten. Kapten is a platform that deploys applications, cron and one-off jobs, and databases (PostgreSQL, MySQL, MongoDB, Redis) to Kubernetes clusters in the customer's own cloud account. - Hierarchy: organization > project > environment (development, staging or production, each on one cluster) > components (applications, jobs, databases). - Applications deploy from a GitHub repository (Kapten builds the image) or from a container image. - Configuration is passed as variables and secrets at project, environment or component level. - Pipelines deploy several components in ordered stages. - Every page is available as Markdown by appending `.md` to its URL. ## Docs - [Kapten documentation](https://docs.kapten.io/): Kapten deploys your applications, jobs and databases to Kubernetes clusters in your own cloud account, with environments, pipelines and secrets built in. - [Quickstart](https://docs.kapten.io/quickstart): Connect a Kubernetes cluster, create a project and an environment, and deploy your first service from a container image. ## Concepts - [How Kapten works](https://docs.kapten.io/concepts): The objects Kapten is built on, from the organization down to the components it deploys, and how they relate to each other. - [Organizations and roles](https://docs.kapten.io/concepts/organizations-and-roles): An organization owns your clusters, projects and integrations; roles decide what each member can see and change. - [Projects](https://docs.kapten.io/concepts/projects): A project groups the services that ship together, like an application and its database, across all of their environments. - [Environments](https://docs.kapten.io/concepts/environments): An environment is one deployment of a project, such as staging or production, running on one cluster with its own components and configuration. - [Clusters](https://docs.kapten.io/concepts/clusters): Kapten deploys into Kubernetes clusters in your own cloud account; you connect each one with its kubeconfig and Kapten installs an agent on it. - [Components](https://docs.kapten.io/concepts/components): Components are what Kapten runs in an environment, applications built from GitHub or pulled from an image, jobs that run once or on a schedule, and databases. - [Variables and secrets](https://docs.kapten.io/concepts/variables-and-secrets): Configure components with environment variables and files, set on a project, an environment or a single component, with secrets stored encrypted. - [Pipelines](https://docs.kapten.io/concepts/pipelines): A pipeline deploys several components of an environment in ordered stages, in parallel within a stage, stopping or continuing when a stage fails. - [Billing](https://docs.kapten.io/concepts/billing): Kapten bills each environment for the minutes it exists, not per seat, and runs on clusters you pay your cloud provider for directly. ## Guides - [Guides](https://docs.kapten.io/guides): Step-by-step instructions for the tasks you do most often with Kapten, from connecting a cluster to deploying with a pipeline. - [Connect a cluster](https://docs.kapten.io/guides/connect-a-cluster): Give Kapten access to a Kubernetes cluster in your cloud account with its kubeconfig, and check that the agent is installed. - [Deploy from GitHub](https://docs.kapten.io/guides/deploy-from-github): Connect your GitHub account, then build and deploy an application from a repository and redeploy it on every push. - [Deploy a container image](https://docs.kapten.io/guides/deploy-a-container-image): Run an application from an existing container image and tag, with its ports, resources and health checks. - [Add a database](https://docs.kapten.io/guides/add-a-database): Create a PostgreSQL, MySQL, MongoDB or Redis database in an environment and connect your application to it with the secrets Kapten generates. - [Schedule a job](https://docs.kapten.io/guides/schedule-a-job): Run a container on a cron schedule, or once, with limits on restarts and duration. - [Build a pipeline](https://docs.kapten.io/guides/build-a-pipeline): Deploy several components of an environment in a set order, for example a migration job, then the API and worker, then the frontend. ## Reference - [Reference](https://docs.kapten.io/reference): Exact values, units and behaviors of Kapten settings, for when you need the details rather than a walkthrough. - [Resources](https://docs.kapten.io/reference/resources): Units for CPU, memory, GPU, storage and instances of applications, jobs and builds, and how requests and limits behave. - [Environment types](https://docs.kapten.io/reference/environment-types): The three environment types, development, staging and production, and what each one is meant for. ## API - [API overview](https://docs.kapten.io/api): Call the Kapten Platform and Auth APIs from scripts and CI with an OAuth application's access token. ### Platform API - [Platform API](https://docs.kapten.io/api/platform): Manage projects, environments, applications, jobs, databases, pipelines, clusters and their configuration. Every request carries an access token from the Auth… #### Environments - [Query environment logs](https://docs.kapten.io/api/platform/environment/query-environment-logs): Returns the environment's log entries that match… Reference for the POST /project/{project_id}/environment/{environment_id}/logs endpoint in the Platform API. #### Components - [Query component logs](https://docs.kapten.io/api/platform/component/query-component-logs): Returns the component's… Reference for the POST /project/{project_id}/environment/{environment_id}/component/{component_id}/logs endpoint in the Platform API. #### Pipelines - [List pipeline stages](https://docs.kapten.io/api/platform/pipeline/list-pipeline-stages): Returns a pipeline's… Reference for the GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages endpoint in the Platform API. - [Create a pipeline stage](https://docs.kapten.io/api/platform/pipeline/create-pipeline-stage): Adds a stage to a… Reference for the POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages endpoint in the Platform API. - [Reorder pipeline stages](https://docs.kapten.io/api/platform/pipeline/reorder-pipeline-stages): Sets the order… Reference for the PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/reorder endpoint in the Platform API. - [Update a pipeline stage](https://docs.kapten.io/api/platform/pipeline/update-pipeline-stage): Upda… Reference for the PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id} endpoint in the Platform API. - [Delete a pipeline stage](https://docs.kapten.io/api/platform/pipeline/delete-pipeline-stage): D… Reference for the DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id} endpoint in the Platform API. - [List pipeline stage components](https://docs.kapten.io/api/platform/pipeline/list-pipeline-stage-components): Reference for the GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components endpoint in the… - [Add a component to a pipeline stage](https://docs.kapten.io/api/platform/pipeline/create-pipeline-stage-component): Reference for the POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components endpoint in the… - [Update a pipeline stage component](https://docs.kapten.io/api/platform/pipeline/update-pipeline-stage-component): Reference for the PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_componen… - [Remove a component from a pipeline stage](https://docs.kapten.io/api/platform/pipeline/delete-pipeline-stage-component): Reference for the DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_compo… #### Project variables - [List project variables](https://docs.kapten.io/api/platform/project-variables/list-project-variables): Returns the variables set on the project, a page at a time. Reference for the GET /project/{project_id}/variable endpoint in the Platform API. - [Create a project variable](https://docs.kapten.io/api/platform/project-variables/create-project-variable): Sets a variable on the project, as a key-value pair or a file. Reference for the POST /project/{project_id}/variable endpoint in the Platform API. - [Delete a project variable](https://docs.kapten.io/api/platform/project-variables/delete-project-variable): Deletes a variable from the project. Reference for the DELETE /project/{project_id}/variable/{variable_id} endpoint in the Platform API. - [Update a project variable](https://docs.kapten.io/api/platform/project-variables/update-project-variable): Updates a variable's key, value or type. Reference for the PATCH /project/{project_id}/variable/{variable_id} endpoint in the Platform API. #### Project secrets - [List project secrets](https://docs.kapten.io/api/platform/project-secret/list-project-secrets): Returns the secrets set on the project, a page at a time. Reference for the GET /project/{project_id}/secret endpoint in the Platform API. - [Create a project secret](https://docs.kapten.io/api/platform/project-secret/create-project-secret): Sets a secret on the project, as a key-value pair or a file. Reference for the POST /project/{project_id}/secret endpoint in the Platform API. - [Delete a project secret](https://docs.kapten.io/api/platform/project-secret/delete-project-secret): Deletes a secret from the project. Reference for the DELETE /project/{project_id}/secret/{variable_id} endpoint in the Platform API. - [Update a project secret](https://docs.kapten.io/api/platform/project-secret/update-project-secret): Updates a secret's key, value or type. Reference for the PATCH /project/{project_id}/secret/{variable_id} endpoint in the Platform API. #### Environment variables - [List environment variables](https://docs.kapten.io/api/platform/environment-variables/list-environment-variables): Returns the variables set on the environment,… Reference for the GET /project/{project_id}/environment/{environment_id}/variable endpoint in the Platform API. - [Create an environment variable](https://docs.kapten.io/api/platform/environment-variables/create-environment-variable): Sets a variable on the environment, as a… Reference for the POST /project/{project_id}/environment/{environment_id}/variable endpoint in the Platform API. - [Delete an environment variable](https://docs.kapten.io/api/platform/environment-variables/delete-environment-variable): Deletes a variable from the… Reference for the DELETE /project/{project_id}/environment/{environment_id}/variable/{variable_id} endpoint in the Platform API. - [Update an environment variable](https://docs.kapten.io/api/platform/environment-variables/update-environment-variable): Updates a variable's key,… Reference for the PATCH /project/{project_id}/environment/{environment_id}/variable/{variable_id} endpoint in the Platform API. #### Environment secrets - [List environment secrets](https://docs.kapten.io/api/platform/environment-secret/list-environment-secrets): Returns the secrets set on the environment, a… Reference for the GET /project/{project_id}/environment/{environment_id}/secret endpoint in the Platform API. - [Create an environment secret](https://docs.kapten.io/api/platform/environment-secret/create-environment-secret): Sets a secret on the environment, as a… Reference for the POST /project/{project_id}/environment/{environment_id}/secret endpoint in the Platform API. - [Delete an environment secret](https://docs.kapten.io/api/platform/environment-secret/delete-environment-secret): Deletes a secret from the… Reference for the DELETE /project/{project_id}/environment/{environment_id}/secret/{variable_id} endpoint in the Platform API. - [Update an environment secret](https://docs.kapten.io/api/platform/environment-secret/update-environment-secret): Updates a secret's key, value… Reference for the PATCH /project/{project_id}/environment/{environment_id}/secret/{variable_id} endpoint in the Platform API. #### Component variables - [List component variables](https://docs.kapten.io/api/platform/component-variables/list-component-variables): Returns the variables set on the… Reference for the GET /project/{project_id}/environment/{environment_id}/component/variable endpoint in the Platform API. - [Create a component variable](https://docs.kapten.io/api/platform/component-variables/create-component-variable): Sets a variable on the component,… Reference for the POST /project/{project_id}/environment/{environment_id}/component/variable endpoint in the Platform API. - [Delete a component variable](https://docs.kapten.io/api/platform/component-variables/delete-component-variable): Deletes a variable… Reference for the DELETE /project/{project_id}/environment/{environment_id}/component/variable/{variable_id} endpoint in the Platform API. - [Update a component variable](https://docs.kapten.io/api/platform/component-variables/update-component-variable): Updates a variable's… Reference for the PATCH /project/{project_id}/environment/{environment_id}/component/variable/{variable_id} endpoint in the Platform API. #### Component secrets - [List component secrets](https://docs.kapten.io/api/platform/component-secret/list-component-secrets): Returns the secrets set on the… Reference for the GET /project/{project_id}/environment/{environment_id}/component/secret endpoint in the Platform API. - [Create a component secret](https://docs.kapten.io/api/platform/component-secret/create-component-secret): Sets a secret on the component, as a… Reference for the POST /project/{project_id}/environment/{environment_id}/component/secret endpoint in the Platform API. - [Delete a component secret](https://docs.kapten.io/api/platform/component-secret/delete-component-secret): Deletes a secret… Reference for the DELETE /project/{project_id}/environment/{environment_id}/component/secret/{variable_id} endpoint in the Platform API. - [Update a component secret](https://docs.kapten.io/api/platform/component-secret/update-component-secret): Updates a secret's… Reference for the PATCH /project/{project_id}/environment/{environment_id}/component/secret/{variable_id} endpoint in the Platform API. #### Clusters - [Sync a cluster](https://docs.kapten.io/api/platform/cluster/sync-cluster): Runs the cluster's setup again, as when it was connected. Reference for the POST /cluster/{cluster_id}/sync endpoint in the Platform API. #### Container registries - [List container registries](https://docs.kapten.io/api/platform/container-registry/list-container-registries): Returns the organization's container registries, a page at a time. Reference for the GET /container-registry endpoint in the Platform API. - [Create a container registry](https://docs.kapten.io/api/platform/container-registry/create-container-registry): Adds a container registry to the organization, with the credentials Kapten uses to… Reference for the POST /container-registry endpoint in the Platform API. - [Get a container registry](https://docs.kapten.io/api/platform/container-registry/get-container-registry): Returns a container registry. Reference for the GET /container-registry/{container_registry_id} endpoint in the Platform API. - [Update a container registry](https://docs.kapten.io/api/platform/container-registry/update-container-registry): Updates a container registry and its credentials. Reference for the PUT /container-registry/{container_registry_id} endpoint in the Platform API. - [Delete a container registry](https://docs.kapten.io/api/platform/container-registry/delete-container-registry): Removes a container registry and deletes its stored… Reference for the DELETE /container-registry/{container_registry_id} endpoint in the Platform API. #### GitHub - [Start connecting GitHub](https://docs.kapten.io/api/platform/github/create-git-hub-connection-session): Starts installing Kapten's GitHub App for the organization.… Reference for the POST /integration/github/connection-sessions endpoint in the Platform API. - [List GitHub installations](https://docs.kapten.io/api/platform/github/list-git-hub-installations): Returns the organization's GitHub App installations. Reference for the GET /integration/github/installations endpoint in the Platform API. - [Disconnect a GitHub installation](https://docs.kapten.io/api/platform/github/disconnect-git-hub-installation): Disconnects a GitHub installation from the… Reference for the DELETE /integration/github/installations/{installation_id} endpoint in the Platform API. - [List installation repositories](https://docs.kapten.io/api/platform/github/list-git-hub-repositories): Returns the repositories the GitHub… Reference for the GET /integration/github/installations/{installation_id}/repositories endpoint in the Platform API. - [List repository branches](https://docs.kapten.io/api/platform/github/list-git-hub-repository-branches): Returns a… Reference for the GET /integration/github/installations/{installation_id}/repositories/{repository_id}/branches endpoint in the Platform API. #### Authorization - [List resources for Role grants](https://docs.kapten.io/api/platform/authorization/list-authorization-resources): Names and IDs of the organization's resources that a Role grant can target.… Reference for the GET /authorization/resources endpoint in the Platform API. #### Audit log - [List audit events](https://docs.kapten.io/api/platform/audit/list-audit-events): Events recorded in the token's organization about projects, environments, components,… Reference for the GET /audit-events endpoint in the Platform API. #### Usage - [Get environment usage](https://docs.kapten.io/api/platform/usage/get-environment-usage): How long each environment of the token's organization was active in the period… Reference for the GET /usage/environments endpoint in the Platform API. #### clusters - [List clusters](https://docs.kapten.io/api/platform/clusters/list-clusters): Returns the organization's clusters, a page at a time. Reference for the GET /cluster endpoint in the Platform API. - [Connect a cluster](https://docs.kapten.io/api/platform/clusters/create-cluster): Connects a Kubernetes cluster from its kubeconfig. Kapten then installs its agent on the cluster. Reference for the POST /cluster endpoint in the Platform API. - [Get a cluster](https://docs.kapten.io/api/platform/clusters/get-cluster): Returns a cluster. Reference for the GET /cluster/{cluster_id} endpoint in the Platform API. - [Update a cluster](https://docs.kapten.io/api/platform/clusters/update-cluster): Updates a cluster's settings. Reference for the PUT /cluster/{cluster_id} endpoint in the Platform API. - [Delete a cluster](https://docs.kapten.io/api/platform/clusters/delete-cluster): Removes a cluster from the organization. Reference for the DELETE /cluster/{cluster_id} endpoint in the Platform API. #### projects - [List projects](https://docs.kapten.io/api/platform/projects/list-projects): Returns the organization's projects, a page at a time. Reference for the GET /project endpoint in the Platform API. - [Create a project](https://docs.kapten.io/api/platform/projects/create-project): Creates a project and returns it. Reference for the POST /project endpoint in the Platform API. - [Get a project](https://docs.kapten.io/api/platform/projects/get-project): Returns a project. Reference for the GET /project/{project_id} endpoint in the Platform API. - [Update a project](https://docs.kapten.io/api/platform/projects/update-project): Updates a project's name and description. Reference for the PUT /project/{project_id} endpoint in the Platform API. - [Delete a project](https://docs.kapten.io/api/platform/projects/delete-project): Deletes a project. Reference for the DELETE /project/{project_id} endpoint in the Platform API. #### environments - [List environments](https://docs.kapten.io/api/platform/environments/list-environments): Returns a project's environments, a page at a time. Reference for the GET /project/{project_id}/environment endpoint in the Platform API. - [Create an environment](https://docs.kapten.io/api/platform/environments/create-environment): Creates an environment in a project, on one of the organization's… Reference for the POST /project/{project_id}/environment endpoint in the Platform API. - [Get an environment](https://docs.kapten.io/api/platform/environments/get-environment): Returns an environment. Reference for the GET /project/{project_id}/environment/{environment_id} endpoint in the Platform API. - [Update an environment](https://docs.kapten.io/api/platform/environments/update-environment): Updates an environment. Fields left out keep their… Reference for the PUT /project/{project_id}/environment/{environment_id} endpoint in the Platform API. - [Delete an environment](https://docs.kapten.io/api/platform/environments/delete-environment): Deletes an environment, with its variables and… Reference for the DELETE /project/{project_id}/environment/{environment_id} endpoint in the Platform API. #### components - [List environment components](https://docs.kapten.io/api/platform/components/list-environment-components): Returns the applications, jobs and… Reference for the GET /project/{project_id}/environment/{environment_id}/components endpoint in the Platform API. #### pipelines - [List pipelines](https://docs.kapten.io/api/platform/pipelines/list-pipelines): Returns an environment's pipelines, a page… Reference for the GET /project/{project_id}/environment/{environment_id}/pipelines endpoint in the Platform API. - [Create a pipeline](https://docs.kapten.io/api/platform/pipelines/create-pipeline): Creates a pipeline in an environment. Add… Reference for the POST /project/{project_id}/environment/{environment_id}/pipelines endpoint in the Platform API. - [Get a pipeline](https://docs.kapten.io/api/platform/pipelines/get-pipeline): Returns a pipeline. Reference for the GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} endpoint in the Platform API. - [Update a pipeline](https://docs.kapten.io/api/platform/pipelines/update-pipeline): Updates a pipeline's own… Reference for the PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} endpoint in the Platform API. - [Delete a pipeline](https://docs.kapten.io/api/platform/pipelines/delete-pipeline): Deletes a pipeline. Reference for the DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} endpoint in the Platform API. - [Run a pipeline](https://docs.kapten.io/api/platform/pipelines/run-pipeline): Starts a run of the… Reference for the POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/run endpoint in the Platform API. - [List pipeline runs](https://docs.kapten.io/api/platform/pipelines/list-pipeline-runs): Returns a pipeline's… Reference for the GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/runs endpoint in the Platform API. - [Get a pipeline run](https://docs.kapten.io/api/platform/pipelines/get-pipeline-run): Returns a pipeline… Reference for the GET /project/{project_id}/environment/{environment_id}/pipeline-runs/{pipeline_run_id} endpoint in the Platform API. #### jobs - [Create a job](https://docs.kapten.io/api/platform/jobs/create-job): Creates a cron or one-off job in an environment. Reference for the POST /project/{project_id}/environment/{environment_id}/job endpoint in the Platform API. - [Get a job](https://docs.kapten.io/api/platform/jobs/get-job): Returns a job. Reference for the GET /project/{project_id}/environment/{environment_id}/job/{job_id} endpoint in the Platform API. - [Update a job](https://docs.kapten.io/api/platform/jobs/update-job): Updates a job. Fields left out keep their… Reference for the PUT /project/{project_id}/environment/{environment_id}/job/{job_id} endpoint in the Platform API. - [Deploy a job](https://docs.kapten.io/api/platform/jobs/deploy-job): Starts a deployment of the job. Reference for the POST /project/{project_id}/environment/{environment_id}/job/{job_id}/deploy endpoint in the Platform API. - [List job runs](https://docs.kapten.io/api/platform/jobs/list-job-runs): Returns the job's deployment runs, a… Reference for the GET /project/{project_id}/environment/{environment_id}/job/{job_id}/runs endpoint in the Platform API. - [Get a job run](https://docs.kapten.io/api/platform/jobs/get-job-run): Returns one… Reference for the GET /project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id} endpoint in the Platform API. - [Query job run logs](https://docs.kapten.io/api/platform/jobs/query-job-run-logs): Returns the… Reference for the POST /project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id}/logs endpoint in the Platform API. #### applications - [Create an application](https://docs.kapten.io/api/platform/applications/create-application): Creates a long-running application in an… Reference for the POST /project/{project_id}/environment/{environment_id}/application endpoint in the Platform API. - [Get an application](https://docs.kapten.io/api/platform/applications/get-application): Returns an application. Reference for the GET /project/{project_id}/environment/{environment_id}/application/{application_id} endpoint in the Platform API. - [Update an application](https://docs.kapten.io/api/platform/applications/update-application): Updates an application.… Reference for the PUT /project/{project_id}/environment/{environment_id}/application/{application_id} endpoint in the Platform API. - [Deploy an application](https://docs.kapten.io/api/platform/applications/deploy-application): Starts a deploymen… Reference for the POST /project/{project_id}/environment/{environment_id}/application/{application_id}/deploy endpoint in the Platform API. - [List application runs](https://docs.kapten.io/api/platform/applications/list-application-runs): Returns the… Reference for the GET /project/{project_id}/environment/{environment_id}/application/{application_id}/runs endpoint in the Platform API. - [Get an application run](https://docs.kapten.io/api/platform/applications/get-application-run): Re… Reference for the GET /project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id} endpoint in the Platform API. - [Query application run logs](https://docs.kapten.io/api/platform/applications/query-application-run-logs): Reference for the POST /project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id}/logs endpoint in the Platform… #### databases - [Create a PostgreSQL database](https://docs.kapten.io/api/platform/databases/create-postgresql-database): Creates a PostgreSQL database in… Reference for the POST /project/{project_id}/environment/{environment_id}/database/postgresql endpoint in the Platform API. - [Get a PostgreSQL database](https://docs.kapten.io/api/platform/databases/get-postgresql-database): Returns a PostgreSQL… Reference for the GET /project/{project_id}/environment/{environment_id}/database/postgresql/{database_id} endpoint in the Platform API. - [Update a PostgreSQL database](https://docs.kapten.io/api/platform/databases/update-postgresql-database): Updates a PostgreSQL… Reference for the PUT /project/{project_id}/environment/{environment_id}/database/postgresql/{database_id} endpoint in the Platform API. - [Create a MySQL database](https://docs.kapten.io/api/platform/databases/create-mysql-database): Creates a MySQL database in an… Reference for the POST /project/{project_id}/environment/{environment_id}/database/mysql endpoint in the Platform API. - [Get a MySQL database](https://docs.kapten.io/api/platform/databases/get-mysql-database): Returns a MySQL database. Reference for the GET /project/{project_id}/environment/{environment_id}/database/mysql/{database_id} endpoint in the Platform API. - [Update a MySQL database](https://docs.kapten.io/api/platform/databases/update-mysql-database): Updates a MySQL… Reference for the PUT /project/{project_id}/environment/{environment_id}/database/mysql/{database_id} endpoint in the Platform API. - [Create a MongoDB database](https://docs.kapten.io/api/platform/databases/create-mongodb-database): Creates a MongoDB database in an… Reference for the POST /project/{project_id}/environment/{environment_id}/database/mongodb endpoint in the Platform API. - [Get a MongoDB database](https://docs.kapten.io/api/platform/databases/get-mongodb-database): Returns a MongoDB… Reference for the GET /project/{project_id}/environment/{environment_id}/database/mongodb/{database_id} endpoint in the Platform API. - [Update a MongoDB database](https://docs.kapten.io/api/platform/databases/update-mongodb-database): Updates a MongoDB… Reference for the PUT /project/{project_id}/environment/{environment_id}/database/mongodb/{database_id} endpoint in the Platform API. - [Create a Redis database](https://docs.kapten.io/api/platform/databases/create-redis-database): Creates a Redis database in an… Reference for the POST /project/{project_id}/environment/{environment_id}/database/redis endpoint in the Platform API. - [Get a Redis database](https://docs.kapten.io/api/platform/databases/get-redis-database): Returns a Redis database. Reference for the GET /project/{project_id}/environment/{environment_id}/database/redis/{database_id} endpoint in the Platform API. - [Update a Redis database](https://docs.kapten.io/api/platform/databases/update-redis-database): Updates a Redis… Reference for the PUT /project/{project_id}/environment/{environment_id}/database/redis/{database_id} endpoint in the Platform API. - [Delete a database](https://docs.kapten.io/api/platform/databases/delete-database): Deletes a database, with the… Reference for the DELETE /project/{project_id}/environment/{environment_id}/database/{database_id} endpoint in the Platform API. - [Deploy a database](https://docs.kapten.io/api/platform/databases/deploy-database): Starts a deployment of… Reference for the POST /project/{project_id}/environment/{environment_id}/database/{database_id}/deploy endpoint in the Platform API. - [List database runs](https://docs.kapten.io/api/platform/databases/list-database-runs): Returns the database's… Reference for the GET /project/{project_id}/environment/{environment_id}/database/{database_id}/runs endpoint in the Platform API. - [Get a database run](https://docs.kapten.io/api/platform/databases/get-database-run): Returns… Reference for the GET /project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id} endpoint in the Platform API. - [Query database run logs](https://docs.kapten.io/api/platform/databases/query-database-run-logs): Re… Reference for the POST /project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id}/logs endpoint in the Platform API. ### Auth API - [Auth API](https://docs.kapten.io/api/auth): Manage organizations, members, invitations, Roles, OAuth applications, single sign-on and billing. Every request carries an access token: see Authentication. #### Organizations - [List the caller's organizations](https://docs.kapten.io/api/auth/organizations/list-organizations): Returns the organizations the caller is a member of, oldest first. Reference for the GET /organizations endpoint in the Auth API. - [Create an organization](https://docs.kapten.io/api/auth/organizations/create-organization): Creates an organization with the owner, admin and member Roles, and makes the caller its… Reference for the POST /organizations endpoint in the Auth API. - [Get an organization](https://docs.kapten.io/api/auth/organizations/get-organization): Requires being a member of the organization. Reference for the GET /organizations/{organizationId} endpoint in the Auth API. - [Update an organization](https://docs.kapten.io/api/auth/organizations/update-organization): Requires organization:update. Reference for the PATCH /organizations/{organizationId} endpoint in the Auth API. - [Delete an organization](https://docs.kapten.io/api/auth/organizations/delete-organization): Requires organization:delete. Refused with 409 while the organization… Reference for the DELETE /organizations/{organizationId} endpoint in the Auth API. #### Members - [List members](https://docs.kapten.io/api/auth/members/list-members): Requires being a member of the organization. Reference for the GET /organizations/{organizationId}/members endpoint in the Auth API. - [Remove a member](https://docs.kapten.io/api/auth/members/remove-member): Takes every Role of the organization away from the user.… Reference for the DELETE /organizations/{organizationId}/members/{userId} endpoint in the Auth API. - [Set a member's Roles](https://docs.kapten.io/api/auth/members/set-member-roles): Replaces the Roles the member holds; requires member:update.… Reference for the PUT /organizations/{organizationId}/members/{userId} endpoint in the Auth API. #### Invitations - [List pending invitations](https://docs.kapten.io/api/auth/invitations/list-invitations): Requires invitation:create or invitation:cancel. Reference for the GET /organizations/{organizationId}/invitations endpoint in the Auth API. - [Invite someone by email](https://docs.kapten.io/api/auth/invitations/create-invitation): Requires invitation:create, and being an owner to invite an… Reference for the POST /organizations/{organizationId}/invitations endpoint in the Auth API. - [Cancel a pending invitation](https://docs.kapten.io/api/auth/invitations/cancel-invitation): Requires invitation:cancel. Reference for the DELETE /organizations/{organizationId}/invitations/{invitationId} endpoint in the Auth API. - [Accept an invitation](https://docs.kapten.io/api/auth/invitations/accept-invitation): Makes the caller a member with the invitation's Role. The caller's verified email must… Reference for the POST /invitations/accept endpoint in the Auth API. #### Roles and permissions - [List Roles](https://docs.kapten.io/api/auth/roles/list-roles): Requires ac:read. The built-in Roles (owner, admin, member) are listed… Reference for the GET /organizations/{organizationId}/roles endpoint in the Auth API. - [Create a custom Role](https://docs.kapten.io/api/auth/roles/create-role): Requires ac:create; granting organization:delete also requires… Reference for the POST /organizations/{organizationId}/roles endpoint in the Auth API. - [Rename a custom Role or replace its Grants](https://docs.kapten.io/api/auth/roles/update-role): Requires ac:update; replacing the Grants of a Role that… Reference for the PATCH /organizations/{organizationId}/roles/{roleId} endpoint in the Auth API. - [Delete a custom Role](https://docs.kapten.io/api/auth/roles/delete-role): Requires ac:delete, and organization:delete for a Role that… Reference for the DELETE /organizations/{organizationId}/roles/{roleId} endpoint in the Auth API. - [Check the caller's Permissions](https://docs.kapten.io/api/auth/roles/check-permissions): Answers each check for the caller, for example to show… Reference for the POST /organizations/{organizationId}/permission-checks endpoint in the Auth API. - [Get the Permission catalog](https://docs.kapten.io/api/auth/roles/get-permission-catalog): Every Permission a Grant can give, and for each scope the Permissions it can hold, for example… Reference for the GET /permissions endpoint in the Auth API. #### OAuth applications - [List OAuth applications](https://docs.kapten.io/api/auth/oauth-clients/list-o-auth-clients): Requires being a member. Revoked applications are listed with… Reference for the GET /organizations/{organizationId}/oauth-clients endpoint in the Auth API. - [Create an OAuth application](https://docs.kapten.io/api/auth/oauth-clients/create-o-auth-client): Requires organization:update; giving the application a Role… Reference for the POST /organizations/{organizationId}/oauth-clients endpoint in the Auth API. - [Get an OAuth application](https://docs.kapten.io/api/auth/oauth-clients/get-o-auth-client): Requires being a member. Reference for the GET /organizations/{organizationId}/oauth-clients/{clientId} endpoint in the Auth API. - [Update an OAuth application](https://docs.kapten.io/api/auth/oauth-clients/update-o-auth-client): Renames an application, or replaces its scopes or… Reference for the PATCH /organizations/{organizationId}/oauth-clients/{clientId} endpoint in the Auth API. - [Revoke an OAuth application](https://docs.kapten.io/api/auth/oauth-clients/revoke-o-auth-client): Requires organization:update, and… Reference for the DELETE /organizations/{organizationId}/oauth-clients/{clientId} endpoint in the Auth API. - [Register a public key](https://docs.kapten.io/api/auth/oauth-clients/add-o-auth-client-key): Registers a public key the application signs… Reference for the POST /organizations/{organizationId}/oauth-clients/{clientId}/keys endpoint in the Auth API. - [Revoke a public key](https://docs.kapten.io/api/auth/oauth-clients/revoke-o-auth-client-key): Requires organization:update. Token… Reference for the DELETE /organizations/{organizationId}/oauth-clients/{clientId}/keys/{keyId} endpoint in the Auth API. - [Create a client secret](https://docs.kapten.io/api/auth/oauth-clients/add-o-auth-client-secret): Creates a secret for the application, to… Reference for the POST /organizations/{organizationId}/oauth-clients/{clientId}/secrets endpoint in the Auth API. - [Revoke a client secret](https://docs.kapten.io/api/auth/oauth-clients/revoke-o-auth-client-secret): Requires organization:update.… Reference for the DELETE /organizations/{organizationId}/oauth-clients/{clientId}/secrets/{secretId} endpoint in the Auth API. #### Single sign-on - [Get the organization's identity provider](https://docs.kapten.io/api/auth/sso/get-sso-connection): Requires organization:update. Answers 404 when the organization has none. Reference for the GET /organizations/{organizationId}/sso endpoint in the Auth API. - [Create or replace the organization's identity provider](https://docs.kapten.io/api/auth/sso/configure-sso-connection): Requires organization:update. Kapten fetches the issuer's discovery… Reference for the PUT /organizations/{organizationId}/sso endpoint in the Auth API. - [Remove the organization's identity provider](https://docs.kapten.io/api/auth/sso/delete-sso-connection): Requires organization:update. Members sign in with email links and… Reference for the DELETE /organizations/{organizationId}/sso endpoint in the Auth API. - [Verify an email domain of the identity provider](https://docs.kapten.io/api/auth/sso/verify-sso-domain): Requires organization:update. Kapten looks up… Reference for the POST /organizations/{organizationId}/sso/domains/{domain}/verify endpoint in the Auth API. #### Billing - [List the subscription plans](https://docs.kapten.io/api/auth/billing/list-billing-plans): Requires being a member. Answers 503 when billing is not… Reference for the GET /organizations/{organizationId}/billing/plans endpoint in the Auth API. - [Get the organization's current subscription](https://docs.kapten.io/api/auth/billing/get-billing-subscription): Requires organization:update. Answers 404 when the… Reference for the GET /organizations/{organizationId}/billing/subscription endpoint in the Auth API. - [Cancel the subscription](https://docs.kapten.io/api/auth/billing/cancel-billing-subscription): Requires organization:update. Returns the URL of… Reference for the POST /organizations/{organizationId}/billing/subscription/cancel endpoint in the Auth API. - [Undo a scheduled cancellation](https://docs.kapten.io/api/auth/billing/resume-billing-subscription): Requires organization:update. Answers 404… Reference for the POST /organizations/{organizationId}/billing/subscription/resume endpoint in the Auth API. - [Estimate the recurring invoice](https://docs.kapten.io/api/auth/billing/preview-billing): Estimates the recurring invoice for a plan and a number of… Reference for the POST /organizations/{organizationId}/billing/preview endpoint in the Auth API. - [Subscribe, or change the plan or seats](https://docs.kapten.io/api/auth/billing/create-billing-checkout): Requires organization:update. Without a current… Reference for the POST /organizations/{organizationId}/billing/checkout endpoint in the Auth API. - [Open the Stripe Customer Portal](https://docs.kapten.io/api/auth/billing/create-billing-portal): Returns the URL of the Stripe Customer Portal, for invoices… Reference for the POST /organizations/{organizationId}/billing/portal endpoint in the Auth API. #### Passkeys - [List the caller's passkeys](https://docs.kapten.io/api/auth/passkeys/list-passkeys): Returns the caller's passkeys, oldest first. Reference for the GET /passkeys endpoint in the Auth API. - [Rename a passkey](https://docs.kapten.io/api/auth/passkeys/rename-passkey): Renames one of the caller's passkeys. Reference for the PATCH /passkeys/{passkeyId} endpoint in the Auth API. - [Revoke a passkey](https://docs.kapten.io/api/auth/passkeys/revoke-passkey): The passkey can no longer sign in; the sessions it started stay. The passkey… Reference for the DELETE /passkeys/{passkeyId} endpoint in the Auth API. #### Audit log - [List audit events](https://docs.kapten.io/api/auth/audit/list-audit-events): Requires audit:read. Events about Roles, memberships,… Reference for the GET /organizations/{organizationId}/audit-events endpoint in the Auth API. #### Discovery - [Get the authorization server metadata](https://docs.kapten.io/api/auth/oauth/get-openid-configuration): Returns the issuer, the endpoints and the supported values that OAuth… Reference for the GET /.well-known/openid-configuration endpoint in the Auth API. #### Token keys - [Get token verification keys](https://docs.kapten.io/api/auth/tokens/get-jwks): Returns the public keys that verify access tokens, including retired keys whose tokens… Reference for the GET /.well-known/jwks.json endpoint in the Auth API. ## CLI - [CLI overview](https://docs.kapten.io/cli): Install the kapten command-line tool and manage projects, environments and deployments from a terminal, CI jobs and coding agents. - [Authentication](https://docs.kapten.io/cli/authentication): Log in to Kapten from the CLI, switch between organizations with saved contexts, and authenticate CI jobs as an OAuth application. - [Output and errors](https://docs.kapten.io/cli/output): Read kapten results as tables or JSON, filter them for scripts, and handle errors and exit codes. - [Request bodies](https://docs.kapten.io/cli/request-bodies): Pass the fields of a resource to create or update commands, as shorthand arguments or as JSON on stdin. - [Coding agents](https://docs.kapten.io/cli/mcp): Set up a coding agent such as Claude Code, Codex or Cursor to manage Kapten, with the Kapten agent skill and the CLI's local MCP server. ### Command reference - [Command reference](https://docs.kapten.io/cli/reference): Every kapten command, its arguments and its flags. - [kapten auth](https://docs.kapten.io/cli/reference/auth): Log in, check who commands run as, and switch between saved logins (contexts). - [kapten applications](https://docs.kapten.io/cli/reference/applications): Deploy and run long-running applications. - [kapten clusters](https://docs.kapten.io/cli/reference/clusters): Connect and manage Kubernetes clusters. - [kapten components](https://docs.kapten.io/cli/reference/components): List the components of an environment. - [kapten databases](https://docs.kapten.io/cli/reference/databases): Create and manage databases. - [kapten environments](https://docs.kapten.io/cli/reference/environments): Create and manage the environments of a project. - [kapten jobs](https://docs.kapten.io/cli/reference/jobs): Run and schedule jobs. - [kapten pipelines](https://docs.kapten.io/cli/reference/pipelines): Build and run deployment pipelines. - [kapten projects](https://docs.kapten.io/cli/reference/projects): Create and manage projects. - [kapten usage](https://docs.kapten.io/cli/reference/usage): Show environment usage for billing. - [kapten mcp](https://docs.kapten.io/cli/reference/mcp): Serve Kapten operations as MCP tools to a coding agent, over stdio. - [kapten skills](https://docs.kapten.io/cli/reference/skills): Install the Kapten agent skill and MCP servers for coding agents. ## Agent skills - [kapten-docs](https://docs.kapten.io/.well-known/agent-skills/kapten-docs/SKILL.md): Read the Kapten Docs instead of answering from memory. Deploy applications, jobs and databases to your own Kubernetes clusters with Kapten. Use when a task involves Kapten Docs: how it works, how to set it up or configure it, or its API. - [kapten](https://docs.kapten.io/.well-known/agent-skills/kapten.tar.gz): Operates Kapten through the kapten CLI and its MCP server, and explains Kapten's resource model. Use when deploying or inspecting Kapten projects, environments, clusters, applications, jobs, databases or pipelines, logging in to Kapten, running Kapten from CI, or connecting an agent to Kapten. ## Agent resources - [llms-full.txt](https://docs.kapten.io/llms-full.txt): The full Markdown of every page in one file. - [Page Markdown](https://docs.kapten.io/index.md): Append `.md` to any page URL to fetch that page as raw Markdown. - [JSON API](https://docs.kapten.io/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://docs.kapten.io/openapi.json. - [MCP server](https://docs.kapten.io/mcp): Streamable HTTP Model Context Protocol server with search_docs, get_page, list_pages, and get_navigation tools, plus every page as a resource. Discovery document: https://docs.kapten.io/.well-known/mcp.json - [Agent skills](https://docs.kapten.io/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes. - [API catalog](https://docs.kapten.io/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here. - [AI catalog](https://docs.kapten.io/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs). - [agent-readability.json](https://docs.kapten.io/agent-readability.json): Manifest of every agent-facing artifact on this site. - [Sitemap](https://docs.kapten.io/sitemap.xml): Every indexable page URL with its last-modified date.