API SERVICE

Kubernetes

Manage Kubernetes deployments and Helm charts on edge clusters, with APIs for repositories, secrets, snapshots, and ZKS instances.

Browse endpoints Download OpenAPI

START EXPLORING

List all deployments

GET/v1/cluster/instances/kubernetes/deployments

Explore the parameters and response schema. Sign in from your console to try a request.

Open endpoint

58 operations 9 groups

GET27POST11PUT11PATCH1DELETE8

EXPLORE THE SERVICE

Endpoint groups

Expand a group to find an endpoint.

5 operations

Kubernetes Deployments

GETList all deployments/v1/cluster/instances/kubernetes/deploymentsGETGet deployment by ID/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}POSTCreate a new Kubernetes deployment/v1/cluster/instances/kubernetes/deploymentsPUTUpdate a deployment/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}DELETEDelete a deployment/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}

GETPOSTPUTDELETE

5 operations

Kubernetes Git Ops

GETList all GitRepo configurations/v1/cluster/instances/kubernetes/gitreposGETGet GitRepo configuration by ID/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}POSTCreate a new GitRepo configuration/v1/cluster/instances/kubernetes/gitreposPUTUpdate GitRepo configuration/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}DELETEDelete GitRepo configuration/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}

GETPOSTPUTDELETE

5 operations

Helm Chart Management

GETList Helm Charts/v1/cluster/instances/kubernetes/helm/chartsGETGet Helm Chart/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}/version/{chartVersion}POSTCreate Helm Chart/v1/cluster/instances/kubernetes/helm/chartsPUTUpdate Helm Chart/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}/version/{chartVersion}DELETEDelete Helm Chart/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}

GETPOSTPUTDELETE

6 operations

Private Helm Repositories

GETList all private Helm repositories/v1/cluster/instances/kubernetes/helm/repositoryGETGet private Helm repository by ID/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}GETGet Helm charts from private repository/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}/chartsPOSTCreate a new private Helm repository/v1/cluster/instances/kubernetes/helm/repositoryPUTUpdate private Helm repository/v1/cluster/instances/kubernetes/helm/repository/id/{id}DELETEDelete private Helm repository/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}

GETPOSTPUTDELETE

3 operations

Kubernetes Secrets

GETList all Kubernetes secrets/v1/cluster/instances/kubernetes/secretsGETGet Kubernetes secret by ID/v1/cluster/instances/kubernetes/secrets/id/{secretId}POSTCreate a new Kubernetes secret/v1/cluster/instances/kubernetes/secrets

GETPOST

5 operations

Kubernetes Snapshots

GETGet snapshot operation status/v1/cluster/instances/kubernetes/snapshots/operations/{operationId}GETList etcd snapshots/v1/cluster/instances/kubernetes/snapshots/{clusterId}POSTCreate an etcd snapshot/v1/cluster/instances/kubernetes/snapshots/{clusterId}/createPOSTRestore an etcd snapshot/v1/cluster/instances/kubernetes/snapshots/{clusterId}/{name}/restoreDELETEDelete an etcd snapshot/v1/cluster/instances/kubernetes/snapshots/{clusterId}/{name}

GETPOSTDELETE

7 operations

Kubernetes Dashboard

GETOpen cluster-shell WebSocket/v1/cluster/instances/kubernetes/{clusterId}/cluster-shellGETDownload dashboard kubeconfig/v1/cluster/instances/kubernetes/{clusterId}/kubeconfigGETProxy Kubernetes API request/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}POSTProxy Kubernetes API request/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}PUTProxy Kubernetes API request/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}PATCHProxy Kubernetes API request/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}DELETEProxy Kubernetes API request/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}

GETPOSTPUTPATCHDELETE

5 operations

Cluster Groups

GETGet cluster group manifest/v1/zks/cluster/groups/manifestGETGet cluster groups status/v1/zks/cluster/groups/statusPOSTCreate a new cluster group/v1/zks/cluster/groupsPUTUpdate cluster group/v1/zks/cluster/groups/id/{id}DELETEDelete cluster group/v1/zks/cluster/groups/id/{clusterGroupId}

GETPOSTPUTDELETE

17 operations

ZKS instances

Instance management9 operations

GETList all ZKS instances/v1/zks/instancesGETGet ZKS instance by ID/v1/zks/instances/id/{zksId}GETGet ZKS instance by name/v1/zks/instances/name/{zksName}POSTCreate a new ZKS instance/v1/zks/instancesPOSTImport an existing ZKS instance/v1/zks/instances/importPUTBulk update ZKS instances/v1/zks/instancesPUTUpdate ZKS instance/v1/zks/instances/id/{id}PUTUpdate ZKS instance nodes/v1/zks/instances/id/{zksId}/nodesDELETEDelete ZKS instance/v1/zks/instances/id/{zksId}

Registration2 operations

GETGet registration commands by ID/v1/zks/instances/id/{zksId}/registration-commandsGETGet registration commands by name/v1/zks/instances/name/{zksName}/registration-commands

Upgrades and versions3 operations

GETGet available K3s versions/v1/zks/instances/k3s-versionsPUTUpgrade ZKS instance/v1/zks/instances/id/{zksId}/upgradePUTBulk upgrade K3s version/v1/zks/instances/k3s-upgrade

Metrics and status3 operations

GETGet ZKS instance metrics by ID/v1/zks/instances/id/{zksId}/metricsGETGet ZKS instance metrics by name/v1/zks/instances/name/{zksName}/metricsGETGet ZKS instances status/v1/zks/instances/status

Instance management · Registration · Upgrades and versions · Metrics and status

GETPOSTPUTDELETE

About this service

The ZEDEDA Kubernetes Service provides APIs for managing Kubernetes deployments and Helm charts in edge clusters.

API guides

Authentication Making requests API availability

​Kubernetes

​List all deployments

​Endpoint groups

Kubernetes

List all deployments

Endpoint groups