Platform API
Manage projects, environments, applications, jobs, databases, pipelines, clusters and their configuration. Every request carries an access token from the Auth API: see Authentication.
https://api.kapten.ioEnvironments
Environments run components on one cluster.
Components
Every component of an environment, and their logs.
Pipelines
Deploy several components in ordered stages.
- GETList pipeline stages
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages - POSTCreate a pipeline stage
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages - PUTReorder pipeline stages
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/reorder - PUTUpdate a pipeline stage
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id} - DELETEDelete a pipeline stage
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id} - GETList pipeline stage components
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components - POSTAdd a component to a pipeline stage
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components - PUTUpdate a pipeline stage component
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_component_id} - DELETERemove a component from a pipeline stage
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/stages/{pipeline_stage_id}/components/{pipeline_stage_component_id}
Project variables
Variables shared by every environment of a project.
- GETList project variables
/project/{project_id}/variable - POSTCreate a project variable
/project/{project_id}/variable - DELETEDelete a project variable
/project/{project_id}/variable/{variable_id} - PATCHUpdate a project variable
/project/{project_id}/variable/{variable_id}
Project secrets
Secrets shared by every environment of a project.
- GETList project secrets
/project/{project_id}/secret - POSTCreate a project secret
/project/{project_id}/secret - DELETEDelete a project secret
/project/{project_id}/secret/{variable_id} - PATCHUpdate a project secret
/project/{project_id}/secret/{variable_id}
Environment variables
Variables shared by every component of an environment.
- GETList environment variables
/project/{project_id}/environment/{environment_id}/variable - POSTCreate an environment variable
/project/{project_id}/environment/{environment_id}/variable - DELETEDelete an environment variable
/project/{project_id}/environment/{environment_id}/variable/{variable_id} - PATCHUpdate an environment variable
/project/{project_id}/environment/{environment_id}/variable/{variable_id}
Environment secrets
Secrets shared by every component of an environment.
- GETList environment secrets
/project/{project_id}/environment/{environment_id}/secret - POSTCreate an environment secret
/project/{project_id}/environment/{environment_id}/secret - DELETEDelete an environment secret
/project/{project_id}/environment/{environment_id}/secret/{variable_id} - PATCHUpdate an environment secret
/project/{project_id}/environment/{environment_id}/secret/{variable_id}
Component variables
Variables of one component.
- GETList component variables
/project/{project_id}/environment/{environment_id}/component/variable - POSTCreate a component variable
/project/{project_id}/environment/{environment_id}/component/variable - DELETEDelete a component variable
/project/{project_id}/environment/{environment_id}/component/variable/{variable_id} - PATCHUpdate a component variable
/project/{project_id}/environment/{environment_id}/component/variable/{variable_id}
Component secrets
Secrets of one component.
- GETList component secrets
/project/{project_id}/environment/{environment_id}/component/secret - POSTCreate a component secret
/project/{project_id}/environment/{environment_id}/component/secret - DELETEDelete a component secret
/project/{project_id}/environment/{environment_id}/component/secret/{variable_id} - PATCHUpdate a component secret
/project/{project_id}/environment/{environment_id}/component/secret/{variable_id}
Clusters
Kubernetes clusters connected to the organization.
Container registries
Registries Kapten pulls images from and pushes builds to.
- GETList container registries
/container-registry - POSTCreate a container registry
/container-registry - GETGet a container registry
/container-registry/{container_registry_id} - PUTUpdate a container registry
/container-registry/{container_registry_id} - DELETEDelete a container registry
/container-registry/{container_registry_id}
GitHub
GitHub App installations, their repositories and branches.
- POSTStart connecting GitHub
/integration/github/connection-sessions - GETList GitHub installations
/integration/github/installations - DELETEDisconnect a GitHub installation
/integration/github/installations/{installation_id} - GETList installation repositories
/integration/github/installations/{installation_id}/repositories - GETList repository branches
/integration/github/installations/{installation_id}/repositories/{repository_id}/branches
Authorization
Resource names to use in Role grants.
Audit log
Changes made to the organization’s resources.
Usage
Environment usage, metered per minute.
clusters
- GETList clusters
/cluster - POSTConnect a cluster
/cluster - GETGet a cluster
/cluster/{cluster_id} - PUTUpdate a cluster
/cluster/{cluster_id} - DELETEDelete a cluster
/cluster/{cluster_id}
projects
- GETList projects
/project - POSTCreate a project
/project - GETGet a project
/project/{project_id} - PUTUpdate a project
/project/{project_id} - DELETEDelete a project
/project/{project_id}
environments
- GETList environments
/project/{project_id}/environment - POSTCreate an environment
/project/{project_id}/environment - GETGet an environment
/project/{project_id}/environment/{environment_id} - PUTUpdate an environment
/project/{project_id}/environment/{environment_id} - DELETEDelete an environment
/project/{project_id}/environment/{environment_id}
components
pipelines
- GETList pipelines
/project/{project_id}/environment/{environment_id}/pipelines - POSTCreate a pipeline
/project/{project_id}/environment/{environment_id}/pipelines - GETGet a pipeline
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} - PUTUpdate a pipeline
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} - DELETEDelete a pipeline
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id} - POSTRun a pipeline
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/run - GETList pipeline runs
/project/{project_id}/environment/{environment_id}/pipelines/{pipeline_id}/runs - GETGet a pipeline run
/project/{project_id}/environment/{environment_id}/pipeline-runs/{pipeline_run_id}
jobs
- POSTCreate a job
/project/{project_id}/environment/{environment_id}/job - GETGet a job
/project/{project_id}/environment/{environment_id}/job/{job_id} - PUTUpdate a job
/project/{project_id}/environment/{environment_id}/job/{job_id} - POSTDeploy a job
/project/{project_id}/environment/{environment_id}/job/{job_id}/deploy - GETList job runs
/project/{project_id}/environment/{environment_id}/job/{job_id}/runs - GETGet a job run
/project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id} - POSTQuery job run logs
/project/{project_id}/environment/{environment_id}/job/{job_id}/runs/{component_run_id}/logs
applications
- POSTCreate an application
/project/{project_id}/environment/{environment_id}/application - GETGet an application
/project/{project_id}/environment/{environment_id}/application/{application_id} - PUTUpdate an application
/project/{project_id}/environment/{environment_id}/application/{application_id} - POSTDeploy an application
/project/{project_id}/environment/{environment_id}/application/{application_id}/deploy - GETList application runs
/project/{project_id}/environment/{environment_id}/application/{application_id}/runs - GETGet an application run
/project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id} - POSTQuery application run logs
/project/{project_id}/environment/{environment_id}/application/{application_id}/runs/{component_run_id}/logs
databases
- POSTCreate a PostgreSQL database
/project/{project_id}/environment/{environment_id}/database/postgresql - GETGet a PostgreSQL database
/project/{project_id}/environment/{environment_id}/database/postgresql/{database_id} - PUTUpdate a PostgreSQL database
/project/{project_id}/environment/{environment_id}/database/postgresql/{database_id} - POSTCreate a MySQL database
/project/{project_id}/environment/{environment_id}/database/mysql - GETGet a MySQL database
/project/{project_id}/environment/{environment_id}/database/mysql/{database_id} - PUTUpdate a MySQL database
/project/{project_id}/environment/{environment_id}/database/mysql/{database_id} - POSTCreate a MongoDB database
/project/{project_id}/environment/{environment_id}/database/mongodb - GETGet a MongoDB database
/project/{project_id}/environment/{environment_id}/database/mongodb/{database_id} - PUTUpdate a MongoDB database
/project/{project_id}/environment/{environment_id}/database/mongodb/{database_id} - POSTCreate a Redis database
/project/{project_id}/environment/{environment_id}/database/redis - GETGet a Redis database
/project/{project_id}/environment/{environment_id}/database/redis/{database_id} - PUTUpdate a Redis database
/project/{project_id}/environment/{environment_id}/database/redis/{database_id} - DELETEDelete a database
/project/{project_id}/environment/{environment_id}/database/{database_id} - POSTDeploy a database
/project/{project_id}/environment/{environment_id}/database/{database_id}/deploy - GETList database runs
/project/{project_id}/environment/{environment_id}/database/{database_id}/runs - GETGet a database run
/project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id} - POSTQuery database run logs
/project/{project_id}/environment/{environment_id}/database/{database_id}/runs/{component_run_id}/logs