Skip to content

Kupe API Reference

Kupe API 1.0

Section titled “ Kupe API 1.0 ”

REST API for the Kupe multi-tenant Kubernetes platform.

Information

  • OpenAPI version: 2.0

Operations

Section titled “ Operations ”
GET
/tenants/{tenant}/alertmanager/config
GET
/tenants/{tenant}/alertmanager/global
PUT
/tenants/{tenant}/alertmanager/global
GET
/tenants/{tenant}/alertmanager/receivers
GET
/tenants/{tenant}/alertmanager/receivers/{name}
PUT
/tenants/{tenant}/alertmanager/receivers/{name}
DELETE
/tenants/{tenant}/alertmanager/receivers/{name}
GET
/tenants/{tenant}/alertmanager/routes
PUT
/tenants/{tenant}/alertmanager/routes
PUT
/tenants/{tenant}/alertmanager/routes/{id}
DELETE
/tenants/{tenant}/alertmanager/routes/{id}
GET
/tenants/{tenant}/apikeys
POST
/tenants/{tenant}/apikeys
GET
/tenants/{tenant}/apikeys/{id}
DELETE
/tenants/{tenant}/apikeys/{id}
POST
/tenants/{tenant}/app-images/resolve
GET
/tenants/{tenant}/apps
POST
/tenants/{tenant}/apps
GET
/tenants/{tenant}/apps/{app}
DELETE
/tenants/{tenant}/apps/{app}
PATCH
/tenants/{tenant}/apps/{app}
GET
/tenants/{tenant}/apps/{app}/environments
POST
/tenants/{tenant}/apps/{app}/environments
GET
/tenants/{tenant}/apps/{app}/environments/{env}
DELETE
/tenants/{tenant}/apps/{app}/environments/{env}
PATCH
/tenants/{tenant}/apps/{app}/environments/{env}
GET
/tenants/{tenant}/apps/{app}/environments/{env}/releases
POST
/tenants/{tenant}/apps/{app}/environments/{env}/retry
GET
/tenants/{tenant}/clusters
POST
/tenants/{tenant}/clusters
GET
/tenants/{tenant}/clusters/{name}
DELETE
/tenants/{tenant}/clusters/{name}
PATCH
/tenants/{tenant}/clusters/{name}
GET
/tenants/{tenant}/clusters/{name}/connection-details
GET
/tenants/{tenant}/databases
POST
/tenants/{tenant}/databases
GET
/tenants/{tenant}/databases/{name}
DELETE
/tenants/{tenant}/databases/{name}
PATCH
/tenants/{tenant}/databases/{name}
GET
/tenants/{tenant}/databases/{name}/bindings
POST
/tenants/{tenant}/databases/{name}/bindings
GET
/tenants/{tenant}/databases/{name}/bindings/{binding}
DELETE
/tenants/{tenant}/databases/{name}/bindings/{binding}
PATCH
/tenants/{tenant}/databases/{name}/bindings/{binding}
POST
/tenants/{tenant}/databases/{name}/rotate-credentials
GET
/tenants/{tenant}/members
POST
/tenants/{tenant}/members
DELETE
/tenants/{tenant}/members/{email}
PATCH
/tenants/{tenant}/members/{email}
GET
/tenants/{tenant}/registries
POST
/tenants/{tenant}/registries
GET
/tenants/{tenant}/registries/{name}
DELETE
/tenants/{tenant}/registries/{name}
PATCH
/tenants/{tenant}/registries/{name}
GET
/tenants/{tenant}/registries/{name}/bindings
POST
/tenants/{tenant}/registries/{name}/bindings
GET
/tenants/{tenant}/registries/{name}/bindings/{binding}
DELETE
/tenants/{tenant}/registries/{name}/bindings/{binding}
PATCH
/tenants/{tenant}/registries/{name}/bindings/{binding}
POST
/tenants/{tenant}/registries/{name}/bindings/{binding}/rotate
GET
/tenants/{tenant}/registries/{name}/repositories
GET
/tenants/{tenant}/registries/{name}/repositories/{repository}
DELETE
/tenants/{tenant}/registries/{name}/repositories/{repository}
GET
/tenants/{tenant}/registries/{name}/repositories/{repository}/images
GET
/tenants/{tenant}/registries/{name}/repositories/{repository}/images/{reference}
DELETE
/tenants/{tenant}/registries/{name}/repositories/{repository}/images/{reference}
DELETE
/tenants/{tenant}/registries/{name}/repositories/{repository}/tags/{tag}
POST
/tenants/{tenant}/registries/{name}/sessions
GET
/tenants/{tenant}/registries/{name}/tokens
POST
/tenants/{tenant}/registries/{name}/tokens
GET
/tenants/{tenant}/registries/{name}/tokens/{id}
DELETE
/tenants/{tenant}/registries/{name}/tokens/{id}
GET
/tenants/{tenant}/secrets
POST
/tenants/{tenant}/secrets
GET
/tenants/{tenant}/secrets/{name}
DELETE
/tenants/{tenant}/secrets/{name}
PATCH
/tenants/{tenant}/secrets/{name}
POST
/tenants/{tenant}/secrets/{name}/refresh
GET
/tenants/{tenant}
DELETE
/tenants/{tenant}
PATCH
/tenants/{tenant}
GET
/tenants/{tenant}/vault/{path}
PUT
/tenants/{tenant}/vault/{path}
DELETE
/tenants/{tenant}/vault/{path}

Authentication

Section titled “ Authentication ”

BearerAuth

Section titled “ BearerAuth ”

API key bearer token (prefix: kupe_)

Security scheme type: apiKey

Header parameter name: Authorization