Skip to main content

​
Overview

The ZEDEDA REST API provides programmatic control over ZEDEDA Edge Kubernetes Service resources. Using the API, you can automate cluster provisioning, app deployments, GitOps repository management, and secrets management without using the Edge Infrastructure Services UI. This article lists the relevant API endpoint groups and the order in which to call them for common workflows.

​
Access the API Documentation

ZEDEDA hosts the interactive API reference on your instance at the following URL:
Replace <YOUR_INSTANCE_NAME> with your ZEDEDA instance name. The reference includes request and response schemas, parameter descriptions, and a built-in request builder for testing calls directly from the browser.

​
API Endpoint Groups

Use the following endpoint groups in the order shown for a complete cluster-to-app workflow. Start with EdgeNodeClusters to provision clusters before referencing them in subsequent calls. To create a cluster with Kubernetes access in one call, set kubernetesMode: true in the POST /v1/cluster body. To enable it on an existing cluster, call PUT /v1/cluster/id/{id}/kubernetes/enable. Enabling is one-way: there is no disable endpoint. Create KubernetesSecrets before registering GitOps repositories that require authentication.
The API reference pages are generated from the contract that the production deployment publishes. The /v1/cluster operations for Kubernetes access (kubernetes/enable, nodes, kubeconfig, registration-commands, load-balancer, and the kubernetesEnabling status field) appear in the reference when that published contract includes them. Until then, use zcli edge-node-cluster --help and the request shapes described on this page.

​
Cluster identifiers

A cluster with Kubernetes access has two identifiers. The cluster id is a UUID; the cluster lifecycle, application instance, and /v1/cluster operations take it. The orchestrator assigns a second ID of the form c-xxxxx, returned as zksClusterId; Helm deployments, the dashboard proxy, and snapshot operations take that one. GitOps targets refer to a cluster by its name. Passing the wrong ID returns a not-found error rather than a validation error, so check the field before you debug further.

​
Next Steps

ZEDEDA Edge Kubernetes Service

Overview of Edge Kubernetes Service components, EVE-k modes, and the Kubernetes section in Edge Infrastructure Services.

GitOps Repositories

Register and manage GitOps repositories for automated Helm chart delivery.