Skip to main content

​
Introduction

The ZEDEDA API is a RESTful API that provides programmatic access to all Edge Infrastructure Services capabilities. Using the ZEDEDA API, you can build custom automations, integrate with existing systems, and script any operation that is available in the console.

​
Prerequisites

  • A ZEDEDA user account.
  • An API token. See Authentication for how to generate one.

​
Available Services

The ZEDEDA API is organized into the following web services, each with its own set of API objects and endpoints: Each service has an independent set of API objects. For example, the ZEDEDA Edge Network Service contains the EdgeNetworkConfiguration API object with its own endpoints and specification. To explore the full API specification, navigate between services using the Select a definition dropdown at https://zedcontrol.zededa.net/api/v1/docs/.

​
API Versions

Each ZEDEDA API service offers a V1 API, and some offer a V2 API. V1 and V2 run in parallel, but V1 is deprecated in favor of V2. V1 remains available, but you should plan to migrate to V2 for better performance and compatibility with new features. Key differences between V1 and V2:
  • Asynchronous processing: V1 handled app instance deployment requests synchronously, requiring clients to wait for the full deployment to complete before receiving a response. V2 uses asynchronous processing — the server acknowledges the request immediately and processes the deployment in the background. Clients can poll for status using the returned request ID.
  • Security: V2 includes updated authentication mechanisms and enhanced data validation.
  • Performance: V2 includes improvements to caching, payload size, and query handling.
  • Standardization: V2 applies consistent naming conventions, error codes, and response structures across endpoints.

​
Upgrading from V1 to V2

ZEDEDA upgrades API versions on a per-object basis. When a new version is released for a specific object (for example, the EdgeNetworkConfiguration object in the Edge Network Service), only the endpoints for that object are upgraded. Other objects retain their current version. In many cases, upgrading is as simple as changing the version number in the URI path:
In other cases, the payload structure may also change:
Review the V2 specification for the object you are upgrading before making changes. If you encounter issues, contact support.

​
Accessing API Documentation

The V1 and V2 specifications are available in the Swagger documentation at:
To test against your own cluster, use:

​
Next Steps

How to Use the ZEDEDA API

Authentication, tokens, and making your first request.

ZCLI Reference

Manage the same resources from the command line with ZCLI.

Edge Infrastructure Services Overview

Introduction to Edge Infrastructure Services capabilities and service areas.

Authentication

Generate an API token.

API Reference

Explore available API documentation, including authentication, error codes, and the User Events API.