Skip to main content

API

Endpoints

HTTP MethodEndpointDescription
GET/config.jsonRetrieves HTTP configuration
GET/api/namespacesGets Kubernetes namespaces
GET/api/clustersLists K3s clusters
GET/api/clusters/versionsGets stable versions of K3s
POST/api/clusters/installInstalls K3s cluster
POST/api/clusters/:clusterId/joinJoins a node to a K3s cluster
GET/api/clusters/:clusterId/nodesLists nodes in a K3s cluster
POST/api/clusters/:clusterId/nodes/:nodeIdUninstalls K3s from a node
GET/api/cattle/helmchartsLists Cattle Helm charts (all namespaces)
GET/api/cattle/namespaces/:namespace/helmchartsLists Cattle Helm charts (specific namespace)
POST/api/cattle/namespaces/:namespace/helmchartsCreates/updates a Cattle Helm chart
GET/api/cattle/namespaces/:namespace/helmcharts/:releaseNameGets a specific Cattle Helm chart
DELETE/api/cattle/namespaces/:namespace/helmcharts/:releaseNameDeletes a specific Cattle Helm chart
GET/api/helmchartsLists Helm chart releases (all namespaces)
GET/api/namespaces/:namespace/helmchartsLists Helm chart releases (specific namespace)
GET/api/namespaces/:namespace/helmcharts/:releaseNameGets a specific Helm chart release
GET/api/namespaces/:namespace/helmcharts/:releaseName/workloadsGets Helm chart release with workloads
GET/api/catalog/helm/reposLists Helm repositories
GET/api/catalog/helm/repos/:repoName/chartsGets index of charts in a Helm repository
GET/api/catalog/helm/repos/:repoName/charts/:chartName/:versionGets a specific chart spec from a Helm repo
ANY/api/gateways/*Proxy for gateway routes