> ## 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.

# ZEDEDA API Overview

> An introduction to the ZEDEDA RESTful API — including available services, API versioning, the transition from V1 to V2, and how to access API documentation.

## 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](https://zededa.mintlify.site/api-reference/authentication.md#generate-an-api-token) 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:

| Service | Description |
| - | - |
| ZEDEDA Node Service | Manage nodes and their configurations. |
| ZEDEDA Edge Application Service | Manage edge application manifests and deployments. |
| ZEDEDA Edge Network Service | Manage networks and virtual networks for nodes and applications. |
| ZEDEDA Storage Service | Manage datastores and volume instances. |
| ZEDEDA Edge-Node Cluster Service | Manage clusters for high availability. |
| ZEDEDA Kubernetes Service | Manage Edge Kubernetes Service clusters and applications. |
| ZEDEDA App Profiles Service | Manage application profiles for automated deployments. |
| ZEDEDA IAM Service | Manage users, roles, and authentication. |
| ZEDEDA Job Service | Track progress of bulk operations across your fleet. |
| ZEDEDA Diagnostic Service | Collect diagnostic data from nodes. |
| ZEDEDA Orchestrator Service | Orchestrate complex multi-node operations. |

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/](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:

```text theme={"dark"}
POST /api/v1/edgeDevice/register
POST /api/v2/edgeDevice/register
```

In other cases, the payload structure may also change:

```text theme={"dark"}
GET /api/v1/edgedevice/ext/check
GET /api/v2/edgedevice/id/{uuid}/ext/check
```

Review the V2 specification for the object you are upgrading before making changes. If you encounter issues, [contact support](https://help.zededa.com/hc/en-us/articles/16402378948123-Submit-a-support-request).

## Accessing API Documentation

The V1 and V2 specifications are available in the Swagger documentation at:

```text theme={"dark"}
https://zedcontrol.zededa.net/api/v1/docs/
```

To test against your own cluster, use:

```text theme={"dark"}
https://zedcontrol.{YOUR_CLUSTER_NAME}.zededa.net/api/v1/docs/
```

## Next Steps

> [card] [How to Use the ZEDEDA API](https://zededa.mintlify.site/api-reference/how-to-use-zededa-api.md)
>
> Authentication, tokens, and making your first request.

> [card] [ZCLI Reference](https://zededa.mintlify.site/zcli-reference/overview.md)
>
> Manage the same resources from the command line with ZCLI.

> [card] [Edge Infrastructure Services Overview](https://zededa.mintlify.site/new-ui/infrastructure-services/overview.md)
>
> Introduction to Edge Infrastructure Services capabilities and service areas.

> [card] [Authentication](https://zededa.mintlify.site/api-reference/authentication.md#generate-an-api-token)
>
> Generate an API token.

> [card] [API Reference](https://zededa.mintlify.site/api-reference/overview.md)
>
> Explore available API documentation, including authentication, error codes, and the User Events API.