---
seo:
  description: >-
    Manage projects, environments, applications, jobs, databases, pipelines,
    clusters and their configuration. Every request carries an access token from
    the Auth…
sidebar:
  label: Overview
title: Platform API
---
Manage projects, environments, applications, jobs, databases, pipelines, clusters and their configuration. Every request carries an access token from the [Auth API](/api/auth): see [Authentication](/api#authentication).

Version 1.0.0

Base URL: `https://api.kapten.io`

## Environments

Environments run components on one cluster.

- [`POST /project/{project_id}/environment/{environment_id}/logs`](/api/platform/environment/query-environment-logs) — Query environment logs.

## Components

Every component of an environment, and their logs.

- [`POST /project/{project_id}/environment/{environment_id}/component/{component_id}/logs`](/api/platform/component/query-component-logs) — Query component logs.

## Pipelines

Deploy several components in ordered stages.

- [`GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages`](/api/platform/pipeline/list-pipeline-stages) — List pipeline stages.
- [`POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages`](/api/platform/pipeline/create-pipeline-stage) — Create a pipeline stage.
- [`PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/reorder`](/api/platform/pipeline/reorder-pipeline-stages) — Reorder pipeline stages.
- [`PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}`](/api/platform/pipeline/update-pipeline-stage) — Update a pipeline stage.
- [`DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}`](/api/platform/pipeline/delete-pipeline-stage) — Delete a pipeline stage.
- [`GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components`](/api/platform/pipeline/list-pipeline-stage-components) — List pipeline stage components.
- [`POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components`](/api/platform/pipeline/create-pipeline-stage-component) — Add a component to a pipeline stage.
- [`PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_component_id}`](/api/platform/pipeline/update-pipeline-stage-component) — Update a pipeline stage component.
- [`DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_component_id}`](/api/platform/pipeline/delete-pipeline-stage-component) — Remove a component from a pipeline stage.

## Project variables

Variables shared by every environment of a project.

- [`GET /project/{project_id}/variable`](/api/platform/project-variables/list-project-variables) — List project variables.
- [`POST /project/{project_id}/variable`](/api/platform/project-variables/create-project-variable) — Create a project variable.
- [`DELETE /project/{project_id}/variable/{variable_id}`](/api/platform/project-variables/delete-project-variable) — Delete a project variable.
- [`PATCH /project/{project_id}/variable/{variable_id}`](/api/platform/project-variables/update-project-variable) — Update a project variable.

## Project secrets

Secrets shared by every environment of a project.

- [`GET /project/{project_id}/secret`](/api/platform/project-secret/list-project-secrets) — List project secrets.
- [`POST /project/{project_id}/secret`](/api/platform/project-secret/create-project-secret) — Create a project secret.
- [`DELETE /project/{project_id}/secret/{variable_id}`](/api/platform/project-secret/delete-project-secret) — Delete a project secret.
- [`PATCH /project/{project_id}/secret/{variable_id}`](/api/platform/project-secret/update-project-secret) — Update a project secret.

## Environment variables

Variables shared by every component of an environment.

- [`GET /project/{project_id}/environment/{environment_id}/variable`](/api/platform/environment-variables/list-environment-variables) — List environment variables.
- [`POST /project/{project_id}/environment/{environment_id}/variable`](/api/platform/environment-variables/create-environment-variable) — Create an environment variable.
- [`DELETE /project/{project_id}/environment/{environment_id}/variable/{variable_id}`](/api/platform/environment-variables/delete-environment-variable) — Delete an environment variable.
- [`PATCH /project/{project_id}/environment/{environment_id}/variable/{variable_id}`](/api/platform/environment-variables/update-environment-variable) — Update an environment variable.

## Environment secrets

Secrets shared by every component of an environment.

- [`GET /project/{project_id}/environment/{environment_id}/secret`](/api/platform/environment-secret/list-environment-secrets) — List environment secrets.
- [`POST /project/{project_id}/environment/{environment_id}/secret`](/api/platform/environment-secret/create-environment-secret) — Create an environment secret.
- [`DELETE /project/{project_id}/environment/{environment_id}/secret/{variable_id}`](/api/platform/environment-secret/delete-environment-secret) — Delete an environment secret.
- [`PATCH /project/{project_id}/environment/{environment_id}/secret/{variable_id}`](/api/platform/environment-secret/update-environment-secret) — Update an environment secret.

## Component variables

Variables of one component.

- [`GET /project/{project_id}/environment/{environment_id}/component/variable`](/api/platform/component-variables/list-component-variables) — List component variables.
- [`POST /project/{project_id}/environment/{environment_id}/component/variable`](/api/platform/component-variables/create-component-variable) — Create a component variable.
- [`DELETE /project/{project_id}/environment/{environment_id}/component/variable/{variable_id}`](/api/platform/component-variables/delete-component-variable) — Delete a component variable.
- [`PATCH /project/{project_id}/environment/{environment_id}/component/variable/{variable_id}`](/api/platform/component-variables/update-component-variable) — Update a component variable.

## Component secrets

Secrets of one component.

- [`GET /project/{project_id}/environment/{environment_id}/component/secret`](/api/platform/component-secret/list-component-secrets) — List component secrets.
- [`POST /project/{project_id}/environment/{environment_id}/component/secret`](/api/platform/component-secret/create-component-secret) — Create a component secret.
- [`DELETE /project/{project_id}/environment/{environment_id}/component/secret/{variable_id}`](/api/platform/component-secret/delete-component-secret) — Delete a component secret.
- [`PATCH /project/{project_id}/environment/{environment_id}/component/secret/{variable_id}`](/api/platform/component-secret/update-component-secret) — Update a component secret.

## Clusters

Kubernetes clusters connected to the organization.

- [`POST /cluster/{cluster_id}/sync`](/api/platform/cluster/sync-cluster) — Sync a cluster.

## Container registries

Registries Kapten pulls images from and pushes builds to.

- [`GET /container-registry`](/api/platform/container-registry/list-container-registries) — List container registries.
- [`POST /container-registry`](/api/platform/container-registry/create-container-registry) — Create a container registry.
- [`GET /container-registry/{container_registry_id}`](/api/platform/container-registry/get-container-registry) — Get a container registry.
- [`PUT /container-registry/{container_registry_id}`](/api/platform/container-registry/update-container-registry) — Update a container registry.
- [`DELETE /container-registry/{container_registry_id}`](/api/platform/container-registry/delete-container-registry) — Delete a container registry.

## GitHub

GitHub App installations, their repositories and branches.

- [`POST /integration/github/connection-sessions`](/api/platform/github/create-git-hub-connection-session) — Start connecting GitHub.
- [`GET /integration/github/installations`](/api/platform/github/list-git-hub-installations) — List GitHub installations.
- [`DELETE /integration/github/installations/{installation_id}`](/api/platform/github/disconnect-git-hub-installation) — Disconnect a GitHub installation.
- [`GET /integration/github/installations/{installation_id}/repositories`](/api/platform/github/list-git-hub-repositories) — List installation repositories.
- [`GET /integration/github/installations/{installation_id}/repositories/{repository_id}/branches`](/api/platform/github/list-git-hub-repository-branches) — List repository branches.

## Authorization

Resource names to use in Role grants.

- [`GET /authorization/resources`](/api/platform/authorization/list-authorization-resources) — List resources for Role grants.

## Audit log

Changes made to the organization's resources.

- [`GET /audit-events`](/api/platform/audit/list-audit-events) — List audit events.

## Usage

Environment usage, metered per minute.

- [`GET /usage/environments`](/api/platform/usage/get-environment-usage) — Get environment usage.

## clusters

- [`GET /cluster`](/api/platform/clusters/list-clusters) — List clusters.
- [`POST /cluster`](/api/platform/clusters/create-cluster) — Connect a cluster.
- [`GET /cluster/{cluster_id}`](/api/platform/clusters/get-cluster) — Get a cluster.
- [`PUT /cluster/{cluster_id}`](/api/platform/clusters/update-cluster) — Update a cluster.
- [`DELETE /cluster/{cluster_id}`](/api/platform/clusters/delete-cluster) — Delete a cluster.

## projects

- [`GET /project`](/api/platform/projects/list-projects) — List projects.
- [`POST /project`](/api/platform/projects/create-project) — Create a project.
- [`GET /project/{project_id}`](/api/platform/projects/get-project) — Get a project.
- [`PUT /project/{project_id}`](/api/platform/projects/update-project) — Update a project.
- [`DELETE /project/{project_id}`](/api/platform/projects/delete-project) — Delete a project.

## environments

- [`GET /project/{project_id}/environment`](/api/platform/environments/list-environments) — List environments.
- [`POST /project/{project_id}/environment`](/api/platform/environments/create-environment) — Create an environment.
- [`GET /project/{project_id}/environment/{environment_id}`](/api/platform/environments/get-environment) — Get an environment.
- [`PUT /project/{project_id}/environment/{environment_id}`](/api/platform/environments/update-environment) — Update an environment.
- [`DELETE /project/{project_id}/environment/{environment_id}`](/api/platform/environments/delete-environment) — Delete an environment.

## components

- [`GET /project/{project_id}/environment/{environment_id}/components`](/api/platform/components/list-environment-components) — List environment components.

## pipelines

- [`GET /project/{project_id}/environment/{environment_id}/pipelines`](/api/platform/pipelines/list-pipelines) — List pipelines.
- [`POST /project/{project_id}/environment/{environment_id}/pipelines`](/api/platform/pipelines/create-pipeline) — Create a pipeline.
- [`GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}`](/api/platform/pipelines/get-pipeline) — Get a pipeline.
- [`PUT /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}`](/api/platform/pipelines/update-pipeline) — Update a pipeline.
- [`DELETE /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}`](/api/platform/pipelines/delete-pipeline) — Delete a pipeline.
- [`POST /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/run`](/api/platform/pipelines/run-pipeline) — Run a pipeline.
- [`GET /project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/runs`](/api/platform/pipelines/list-pipeline-runs) — List pipeline runs.
- [`GET /project/{project_id}/environment/{environment_id}/pipeline-runs/{pipeline_run_id}`](/api/platform/pipelines/get-pipeline-run) — Get a pipeline run.

## jobs

- [`POST /project/{project_id}/environment/{environment_id}/job`](/api/platform/jobs/create-job) — Create a job.
- [`GET /project/{project_id}/environment/{environment_id}/job/{job_id}`](/api/platform/jobs/get-job) — Get a job.
- [`PUT /project/{project_id}/environment/{environment_id}/job/{job_id}`](/api/platform/jobs/update-job) — Update a job.
- [`POST /project/{project_id}/environment/{environment_id}/job/{job_id}/deploy`](/api/platform/jobs/deploy-job) — Deploy a job.
- [`GET /project/{project_id}/environment/{environment_id}/job/{job_id}/runs`](/api/platform/jobs/list-job-runs) — List job runs.
- [`GET /project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id}`](/api/platform/jobs/get-job-run) — Get a job run.
- [`POST /project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id}/logs`](/api/platform/jobs/query-job-run-logs) — Query job run logs.

## applications

- [`POST /project/{project_id}/environment/{environment_id}/application`](/api/platform/applications/create-application) — Create an application.
- [`GET /project/{project_id}/environment/{environment_id}/application/{application_id}`](/api/platform/applications/get-application) — Get an application.
- [`PUT /project/{project_id}/environment/{environment_id}/application/{application_id}`](/api/platform/applications/update-application) — Update an application.
- [`POST /project/{project_id}/environment/{environment_id}/application/{application_id}/deploy`](/api/platform/applications/deploy-application) — Deploy an application.
- [`GET /project/{project_id}/environment/{environment_id}/application/{application_id}/runs`](/api/platform/applications/list-application-runs) — List application runs.
- [`GET /project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id}`](/api/platform/applications/get-application-run) — Get an application run.
- [`POST /project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id}/logs`](/api/platform/applications/query-application-run-logs) — Query application run logs.

## databases

- [`POST /project/{project_id}/environment/{environment_id}/database/postgresql`](/api/platform/databases/create-postgresql-database) — Create a PostgreSQL database.
- [`GET /project/{project_id}/environment/{environment_id}/database/postgresql/{database_id}`](/api/platform/databases/get-postgresql-database) — Get a PostgreSQL database.
- [`PUT /project/{project_id}/environment/{environment_id}/database/postgresql/{database_id}`](/api/platform/databases/update-postgresql-database) — Update a PostgreSQL database.
- [`POST /project/{project_id}/environment/{environment_id}/database/mysql`](/api/platform/databases/create-mysql-database) — Create a MySQL database.
- [`GET /project/{project_id}/environment/{environment_id}/database/mysql/{database_id}`](/api/platform/databases/get-mysql-database) — Get a MySQL database.
- [`PUT /project/{project_id}/environment/{environment_id}/database/mysql/{database_id}`](/api/platform/databases/update-mysql-database) — Update a MySQL database.
- [`POST /project/{project_id}/environment/{environment_id}/database/mongodb`](/api/platform/databases/create-mongodb-database) — Create a MongoDB database.
- [`GET /project/{project_id}/environment/{environment_id}/database/mongodb/{database_id}`](/api/platform/databases/get-mongodb-database) — Get a MongoDB database.
- [`PUT /project/{project_id}/environment/{environment_id}/database/mongodb/{database_id}`](/api/platform/databases/update-mongodb-database) — Update a MongoDB database.
- [`POST /project/{project_id}/environment/{environment_id}/database/redis`](/api/platform/databases/create-redis-database) — Create a Redis database.
- [`GET /project/{project_id}/environment/{environment_id}/database/redis/{database_id}`](/api/platform/databases/get-redis-database) — Get a Redis database.
- [`PUT /project/{project_id}/environment/{environment_id}/database/redis/{database_id}`](/api/platform/databases/update-redis-database) — Update a Redis database.
- [`DELETE /project/{project_id}/environment/{environment_id}/database/{database_id}`](/api/platform/databases/delete-database) — Delete a database.
- [`POST /project/{project_id}/environment/{environment_id}/database/{database_id}/deploy`](/api/platform/databases/deploy-database) — Deploy a database.
- [`GET /project/{project_id}/environment/{environment_id}/database/{database_id}/runs`](/api/platform/databases/list-database-runs) — List database runs.
- [`GET /project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id}`](/api/platform/databases/get-database-run) — Get a database run.
- [`POST /project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id}/logs`](/api/platform/databases/query-database-run-logs) — Query database run logs.
