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

# Orchestrator

> Explore 37 orchestrator API operations.

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

&#x20;API SERVICE

# Orchestrator

Manage third-party integrations, cluster instances, and data streams through the orchestrator APIs.

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

START EXPLORING
Query Cluster Instance
[GET`/v1/cluster/instances`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances)
Explore the parameters and response schema. Sign in from your console to try a request.
[Open endpoint ](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances.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.

**37** operations  **6** groupsGET22POST3PUT8DELETE4

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

1 operation

> [accordion] API Usage Tracking
>
> [GET**Get API usage statistics**`/v1/apiusage`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-apiusage)

GET

3 operations

> [accordion] Azure Deployments
>
> [GET**Get a azure module policy by id**`/v1/azure/edgedevice/modulepolicyid/{modulePolicyId}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-azure-edgedevice-modulepolicyid-by-modulepolicyid)
> [GET**Query cluster instance tags**`/v1/cluster/instances/tags`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-tags)
> [DELETE**Delete a deployment policy**`/v1/azure/deployment/policyid/{policyId}`](https://zededa.mintlify.site/api-reference/orchestrator/delete-v1-azure-deployment-policyid-by-policyid)

GETDELETE

11 operations

> [accordion] Cluster Instance Configuration
>
> [GET**Query Cluster Instance**`/v1/cluster/instances`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances)
> [GET**Get Cluster Instance by ID**`/v1/cluster/instances/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-id-by-id)
> [GET**Get Cluster Instance by name**`/v1/cluster/instances/name/{name}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-name-by-name)
> [POST**Create Cluster Instance**`/v1/cluster/instances`](https://zededa.mintlify.site/api-reference/orchestrator/post-v1-cluster-instances)
> [PUT**Update Cluster Instance**`/v1/cluster/instances/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id)
> [PUT**Activate Cluster Instance**`/v1/cluster/instances/id/{id}/activate`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id-activate)
> [PUT**Deactivate Cluster Instance**`/v1/cluster/instances/id/{id}/deactivate`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id-deactivate)
> [PUT**Refresh cluster instance**`/v1/cluster/instances/id/{id}/refresh`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id-refresh)
> [PUT**Refresh and purge cluster instance**`/v1/cluster/instances/id/{id}/refresh/purge`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id-refresh-purge)
> [PUT**Restart cluster instance**`/v1/cluster/instances/id/{id}/restart`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-cluster-instances-id-by-id-restart)
> [DELETE**Delete Cluster Instance**`/v1/cluster/instances/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/delete-v1-cluster-instances-id-by-id)

GETPOSTPUTDELETE

10 operations

> [accordion] Cluster Instance Status
>
> [GET**Get Cluster Instance status by ID**`/v1/cluster/instances/id/{id}/status`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-id-by-id-status)
> [GET**Get Cluster Instances kubeconfig by id**`/v1/cluster/instances/id/{id}/status/kubeconfig`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-id-by-id-status-kubeconfig)
> [GET**Download Cluster Instances kubeconfig by id**`/v1/cluster/instances/id/{id}/status/kubeconfig/download`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-id-by-id-status-kubeconfig-download)
> [GET**Get Cluster Instances events by id**`/v1/cluster/instances/id/{objid}/events`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-id-by-objid-events)
> [GET**Get Cluster Instance status by name**`/v1/cluster/instances/name/{name}/status`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-name-by-name-status)
> [GET**Get Cluster Instances kubeconfig by name**`/v1/cluster/instances/name/{name}/status/kubeconfig`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-name-by-name-status-kubeconfig)
> [GET**Download Cluster Instances kubeconfig by name**`/v1/cluster/instances/name/{name}/status/kubeconfig/download`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-name-by-name-status-kubeconfig-download)
> [GET**Get Cluster Instances events by name**`/v1/cluster/instances/name/{objname}/events`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-name-by-objname-events)
> [GET**Query status of Cluster Instances**`/v1/cluster/instances/status`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-status)
> [GET**Query status and config of Cluster Instances**`/v1/cluster/instances/status-config`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-cluster-instances-status-config)

GET

6 operations

> [accordion] Data Stream Configs
>
> [GET**Get data stream config list**`/v1/datastreams`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-datastreams)
> [GET**Get a data stream config by Id**`/v1/datastreams/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-datastreams-id-by-id)
> [GET**Get a data stream config by name**`/v1/datastreams/name/{name}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-datastreams-name-by-name)
> [POST**Create data stream config**`/v1/datastreams`](https://zededa.mintlify.site/api-reference/orchestrator/post-v1-datastreams)
> [PUT**Update a data stream config**`/v1/datastreams/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-datastreams-id-by-id)
> [DELETE**Delete a data stream config**`/v1/datastreams/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/delete-v1-datastreams-id-by-id)

GETPOSTPUTDELETE

6 operations

> [accordion] Third Party Plugin Management
>
> [GET**Get third party plugins list**`/v1/plugins`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-plugins)
> [GET**Get a third party plugin by Id**`/v1/plugins/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-plugins-id-by-id)
> [GET**Get a third party plugin by name**`/v1/plugins/name/{name}`](https://zededa.mintlify.site/api-reference/orchestrator/get-v1-plugins-name-by-name)
> [POST**Create third party plugin**`/v1/plugins`](https://zededa.mintlify.site/api-reference/orchestrator/post-v1-plugins)
> [PUT**Update a third party plugin**`/v1/plugins/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/put-v1-plugins-id-by-id)
> [DELETE**Delete a third party plugin**`/v1/plugins/id/{id}`](https://zededa.mintlify.site/api-reference/orchestrator/delete-v1-plugins-id-by-id)

GETPOSTPUTDELETE

> [accordion] About this service
>
> The ZEDEDA Orchestrator Service is part of ZEDEDA Edge Orchestration Platform. Orchestrator service defines the user facing APIs to interact with a third-party client (e.x. Azure, Rancher).

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)
