Skip to content
/
kuben
Docs
Product
Features
Environments, rollouts, HTTPS, teams
Templates
One-click databases and tools
Security
The model, and its honest limits
Roadmap
Git builds, previews, scale to zero
Resources
Blog
Engineering, product and updates
Changelog
Latest releases and improvements
API reference
Every endpoint, from the OpenAPI spec
GitHub
Source, issues and releases
Enterprise
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Docs
Enterprise
Product
Features
Templates
Security
Roadmap
Resources
Blog
Changelog
API reference
GitHub
Select theme
Dark
Light
Auto
Menu
Start here
What is Kuben?
Quickstart
Deploy your first app
Concepts
Install the binary
Guides
Deploy from CI with an API token
Teams and roles
Releases and rollbacks
Persistent volumes
Scheduled jobs
One-click templates
Custom domains and HTTPS
Promote between environments
The audit log
Sign-in and login throttling
Operations
Production install
Exposing apps and HTTPS
High availability
Backup and restore
Upgrading
Security model and its limits
Troubleshooting and observability
Reference
CLI
Configuration
Helm chart values
Custom resources
Template catalogue
REST API
Overview
auth
Overview
Log in with email + password. Sets an `HttpOnly` session cookie. Repeated failures are throttled (`429` with `Retry-After`).
Log out: revoke the current session and clear the cookie.
The authenticated user.
Replace the caller's password. Every other session is signed out.
projects
Overview
List projects visible to the caller.
Create a project (writes a `Project` CR).
One project.
Delete an empty project. Projects with environments are refused (`409`): deleting environments is an explicit, per-environment decision.
environments
Overview
List a project's environments.
Create an environment (the controller provisions its namespace).
One environment.
Delete an environment. Production environments need the `env-delete-protected` permission and are purged after a grace period.
apps
Overview
List the apps of an environment.
Deploy a new app from a container image.
App detail with pods. Plain env values are included only for callers holding `secret-read`.
Delete an app and everything it owns. Volumes are kept unless `delete_volumes=true`.
Update an app (image changes require `app-deploy`). Every change is a new release revision.
Check that every hostname of the app points at the gateway.
Recent log lines of the app's pods (at most 10 pods).
Promote the app to another environment of the same project.
Release history, newest first (50 revisions).
Rolling restart of every process (no spec change).
Roll back to an earlier revision (recorded as a new revision).
Run a scheduled process now (a Job from its CronJob template).
secrets
Overview
List the secrets of an environment (names and keys).
Create or replace a secret.
Delete a secret created through Kuben.
templates
Overview
Deploy a template into an environment.
The template catalogue.
tokens
Overview
The caller's API tokens.
Create a personal API token.
Revoke one of the caller's tokens (immediately effective).
members
Overview
Members of the caller's organization.
Invite a member. New accounts get a one-time temporary password.
Remove a member: bindings, sessions and tokens are revoked immediately.
Change a member's role.
audit
Overview
Audit log of the caller's organization(s).
system
Overview
Per-subsystem health (authenticated).
Contributing
Development setup
CI/CD and releases
Architecture decisions
Roadmap
GitHub
Teamtem
RSS
Select theme
Dark
Light
Auto
Overview
system
Section titled “system”
Health and diagnostics
Operations
Section titled “Operations”
GET
/api/v1/healthz/details
