> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.

# Kubernetes

> Explore 58 kubernetes API operations.

[ All API services](https://zededa.mintlify.site/api-reference/overview.md)

&#x20;API SERVICE

# Kubernetes

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

[Browse endpoints ](#endpoint-groups)
[ Download OpenAPI](https://zededa.mintlify.site/openapi/services/kubernetes.json)

START EXPLORING
List all deployments
[GET`/v1/cluster/instances/kubernetes/deployments`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-deployments)
Explore the parameters and response schema. Sign in from your console to try a request.
[Open endpoint ](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-deployments.md)

Ready to try the API?Browse every service and endpoint without signing in. Connect your ZedCloud session when you’re ready to send a request.

> [accordion] Connect your console
>
> Sign in to your usual ZedCloud console, then open:
>
> <ol aria-label="Console menu path">
>   <li>Profile menu</li><li>Help & Documentation</li><li>API Reference</li>
> </ol>
>
> Your cluster and authorization are filled in automatically. No token to copy.
> [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference)

&#x20;Modifying requests stay off until you enable them.

**58** operations  **9** groupsGET27POST11PUT11PATCH1DELETE8

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

5 operations

> [accordion] Kubernetes Deployments
>
> [GET**List all deployments**`/v1/cluster/instances/kubernetes/deployments`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-deployments)
> [GET**Get deployment by ID**`/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-deployments-id-by-deploymentid)
> [POST**Create a new Kubernetes deployment**`/v1/cluster/instances/kubernetes/deployments`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-deployments)
> [PUT**Update a deployment**`/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-cluster-instances-kubernetes-deployments-id-by-deploymentid)
> [DELETE**Delete a deployment**`/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-deployments-id-by-deploymentid)

GETPOSTPUTDELETE

5 operations

> [accordion] Kubernetes Git Ops
>
> [GET**List all GitRepo configurations**`/v1/cluster/instances/kubernetes/gitrepos`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-gitrepos)
> [GET**Get GitRepo configuration by ID**`/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-gitrepos-id-by-gitrepoid)
> [POST**Create a new GitRepo configuration**`/v1/cluster/instances/kubernetes/gitrepos`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-gitrepos)
> [PUT**Update GitRepo configuration**`/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-cluster-instances-kubernetes-gitrepos-id-by-gitrepoid)
> [DELETE**Delete GitRepo configuration**`/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-gitrepos-id-by-gitrepoid)

GETPOSTPUTDELETE

5 operations

> [accordion] Helm Chart Management
>
> [GET**List Helm Charts**`/v1/cluster/instances/kubernetes/helm/charts`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-helm-charts)
> [GET**Get Helm Chart**`/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}/version/{chartVersion}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-helm-charts-name-by-chartname-version-by-chartversion)
> [POST**Create Helm Chart**`/v1/cluster/instances/kubernetes/helm/charts`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-helm-charts)
> [PUT**Update Helm Chart**`/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}/version/{chartVersion}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-cluster-instances-kubernetes-helm-charts-name-by-chartname-version-by-chartversion)
> [DELETE**Delete Helm Chart**`/v1/cluster/instances/kubernetes/helm/charts/name/{chartName}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-helm-charts-name-by-chartname)

GETPOSTPUTDELETE

6 operations

> [accordion] Private Helm Repositories
>
> [GET**List all private Helm repositories**`/v1/cluster/instances/kubernetes/helm/repository`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-helm-repository)
> [GET**Get private Helm repository by ID**`/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-helm-repository-id-by-privaterepoid)
> [GET**Get Helm charts from private repository**`/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}/charts`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-helm-repository-id-by-privaterepoid-charts)
> [POST**Create a new private Helm repository**`/v1/cluster/instances/kubernetes/helm/repository`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-helm-repository)
> [PUT**Update private Helm repository**`/v1/cluster/instances/kubernetes/helm/repository/id/{id}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-cluster-instances-kubernetes-helm-repository-id-by-id)
> [DELETE**Delete private Helm repository**`/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-helm-repository-id-by-privaterepoid)

GETPOSTPUTDELETE

3 operations

> [accordion] Kubernetes Secrets
>
> [GET**List all Kubernetes secrets**`/v1/cluster/instances/kubernetes/secrets`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-secrets)
> [GET**Get Kubernetes secret by ID**`/v1/cluster/instances/kubernetes/secrets/id/{secretId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-secrets-id-by-secretid)
> [POST**Create a new Kubernetes secret**`/v1/cluster/instances/kubernetes/secrets`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-secrets)

GETPOST

5 operations

> [accordion] Kubernetes Snapshots
>
> [GET**Get snapshot operation status**`/v1/cluster/instances/kubernetes/snapshots/operations/{operationId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-snapshots-operations-by-operationid)
> [GET**List etcd snapshots**`/v1/cluster/instances/kubernetes/snapshots/{clusterId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-snapshots-by-clusterid)
> [POST**Create an etcd snapshot**`/v1/cluster/instances/kubernetes/snapshots/{clusterId}/create`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-snapshots-by-clusterid-create)
> [POST**Restore an etcd snapshot**`/v1/cluster/instances/kubernetes/snapshots/{clusterId}/{name}/restore`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-snapshots-by-clusterid-by-name-restore)
> [DELETE**Delete an etcd snapshot**`/v1/cluster/instances/kubernetes/snapshots/{clusterId}/{name}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-snapshots-by-clusterid-by-name)

GETPOSTDELETE

7 operations

> [accordion] Kubernetes Dashboard
>
> [GET**Open cluster-shell WebSocket**`/v1/cluster/instances/kubernetes/{clusterId}/cluster-shell`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-by-clusterid-cluster-shell)
> [GET**Download dashboard kubeconfig**`/v1/cluster/instances/kubernetes/{clusterId}/kubeconfig`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-by-clusterid-kubeconfig)
> [GET**Proxy Kubernetes API request**`/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-cluster-instances-kubernetes-by-clusterid-proxy-by-path)
> [POST**Proxy Kubernetes API request**`/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-cluster-instances-kubernetes-by-clusterid-proxy-by-path)
> [PUT**Proxy Kubernetes API request**`/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-cluster-instances-kubernetes-by-clusterid-proxy-by-path)
> [PATCH**Proxy Kubernetes API request**`/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}`](https://zededa.mintlify.site/api-reference/kubernetes/patch-v1-cluster-instances-kubernetes-by-clusterid-proxy-by-path)
> [DELETE**Proxy Kubernetes API request**`/v1/cluster/instances/kubernetes/{clusterId}/proxy/{path}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-cluster-instances-kubernetes-by-clusterid-proxy-by-path)

GETPOSTPUTPATCHDELETE

5 operations

> [accordion] Cluster Groups
>
> [GET**Get cluster group manifest**`/v1/zks/cluster/groups/manifest`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-cluster-groups-manifest)
> [GET**Get cluster groups status**`/v1/zks/cluster/groups/status`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-cluster-groups-status)
> [POST**Create a new cluster group**`/v1/zks/cluster/groups`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-zks-cluster-groups)
> [PUT**Update cluster group**`/v1/zks/cluster/groups/id/{id}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-cluster-groups-id-by-id)
> [DELETE**Delete cluster group**`/v1/zks/cluster/groups/id/{clusterGroupId}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-zks-cluster-groups-id-by-clustergroupid)

GETPOSTPUTDELETE

17 operations

> [accordion] ZKS instances
>
> Instance management9 operations
>
> [GET**List all ZKS instances**`/v1/zks/instances`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances)
> [GET**Get ZKS instance by ID**`/v1/zks/instances/id/{zksId}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-id-by-zksid)
> [GET**Get ZKS instance by name**`/v1/zks/instances/name/{zksName}`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-name-by-zksname)
> [POST**Create a new ZKS instance**`/v1/zks/instances`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-zks-instances)
> [POST**Import an existing ZKS instance**`/v1/zks/instances/import`](https://zededa.mintlify.site/api-reference/kubernetes/post-v1-zks-instances-import)
> [PUT**Bulk update ZKS instances**`/v1/zks/instances`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-instances)
> [PUT**Update ZKS instance**`/v1/zks/instances/id/{id}`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-instances-id-by-id)
> [PUT**Update ZKS instance nodes**`/v1/zks/instances/id/{zksId}/nodes`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-instances-id-by-zksid-nodes)
> [DELETE**Delete ZKS instance**`/v1/zks/instances/id/{zksId}`](https://zededa.mintlify.site/api-reference/kubernetes/delete-v1-zks-instances-id-by-zksid)
>
> Registration2 operations
>
> [GET**Get registration commands by ID**`/v1/zks/instances/id/{zksId}/registration-commands`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-id-by-zksid-registration-commands)
> [GET**Get registration commands by name**`/v1/zks/instances/name/{zksName}/registration-commands`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-name-by-zksname-registration-commands)
>
> Upgrades and versions3 operations
>
> [GET**Get available K3s versions**`/v1/zks/instances/k3s-versions`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-k3s-versions)
> [PUT**Upgrade ZKS instance**`/v1/zks/instances/id/{zksId}/upgrade`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-instances-id-by-zksid-upgrade)
> [PUT**Bulk upgrade K3s version**`/v1/zks/instances/k3s-upgrade`](https://zededa.mintlify.site/api-reference/kubernetes/put-v1-zks-instances-k3s-upgrade)
>
> Metrics and status3 operations
>
> [GET**Get ZKS instance metrics by ID**`/v1/zks/instances/id/{zksId}/metrics`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-id-by-zksid-metrics)
> [GET**Get ZKS instance metrics by name**`/v1/zks/instances/name/{zksName}/metrics`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-name-by-zksname-metrics)
> [GET**Get ZKS instances status**`/v1/zks/instances/status`](https://zededa.mintlify.site/api-reference/kubernetes/get-v1-zks-instances-status)

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

> [accordion] About this service
>
> The ZEDEDA Kubernetes Service provides APIs for managing Kubernetes deployments and Helm charts in edge clusters.

API guides[ Authentication](https://zededa.mintlify.site/api-reference/authentication.md)[ Making requests](https://zededa.mintlify.site/api-reference/how-to-use-zededa-api.md)[ API availability](https://zededa.mintlify.site/api-reference/clusters.md)
