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

# Edge applications

> Explore 80 edge applications API operations.

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

&#x20;API SERVICE

# Edge applications

Define application bundles, deploy instances to edge nodes, and manage their lifecycle and monitoring.

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

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

**80** operations  **4** groupsGET53POST6PUT16DELETE5

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

11 operations

> [accordion] Application bundles
>
> [GET**Query bundles (beta)**`/beta/apps`](https://zededa.mintlify.site/api-reference/edge-application/get-beta-apps)
> [GET**Query bundles (v1)**`/v1/apps`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps)
> [GET**Query global bundles**`/v1/apps/global`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-global)
> [GET**Get global bundle by ID**`/v1/apps/global/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-global-id-by-id)
> [GET**Get global bundle by name**`/v1/apps/global/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-global-name-by-name)
> [GET**Get bundle by ID**`/v1/apps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-id-by-id)
> [GET**Query the project access list of an bundle**`/v1/apps/id/{id}/projects`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-id-by-id-projects)
> [GET**Get bundle by name**`/v1/apps/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-name-by-name)
> [POST**Create bundle**`/v1/apps`](https://zededa.mintlify.site/api-reference/edge-application/post-v1-apps)
> [PUT**Update bundle**`/v1/apps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-id-by-id)
> [DELETE**Delete bundle**`/v1/apps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/delete-v1-apps-id-by-id)

GETPOSTPUTDELETE

26 operations

> [accordion] Application instances
>
> Instance management12 operations
>
> [GET**Query instances (v1)**`/v1/apps/instances`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances)
> [GET**Get instance by ID (v1)**`/v1/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id)
> [GET**Get instance by name (v1)**`/v1/apps/instances/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-name)
> [GET**Query instances (v2)**`/v2/apps/instances`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances)
> [GET**Get instance by ID (v2)**`/v2/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id)
> [GET**Get instance by name (v2)**`/v2/apps/instances/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-name)
> [POST**Create instance (v1)**`/v1/apps/instances`](https://zededa.mintlify.site/api-reference/edge-application/post-v1-apps-instances)
> [POST**Create instance (v2)**`/v2/apps/instances`](https://zededa.mintlify.site/api-reference/edge-application/post-v2-apps-instances)
> [PUT**Update instance by ID (v1)**`/v1/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id)
> [PUT**Update instance by ID (v2)**`/v2/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id)
> [DELETE**Delete instance by ID (v1)**`/v1/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/delete-v1-apps-instances-id-by-id)
> [DELETE**Delete instance by ID (v2)**`/v2/apps/instances/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/delete-v2-apps-instances-id-by-id)
>
> Lifecycle and console12 operations
>
> [PUT**Activate instance by ID (v1)**`/v1/apps/instances/id/{id}/activate`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-activate)
> [PUT**Connect to instance console by ID (v1)**`/v1/apps/instances/id/{id}/console/remote`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-console-remote)
> [PUT**Deactivate instance by ID (v1)**`/v1/apps/instances/id/{id}/deactivate`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-deactivate)
> [PUT**Refresh instance by ID (v1)**`/v1/apps/instances/id/{id}/refresh`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-refresh)
> [PUT**Refresh and purge instance by ID (v1)**`/v1/apps/instances/id/{id}/refresh/purge`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-refresh-purge)
> [PUT**Restart instance by ID (v1)**`/v1/apps/instances/id/{id}/restart`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-apps-instances-id-by-id-restart)
> [PUT**Activate instance by ID (v2)**`/v2/apps/instances/id/{id}/activate`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-activate)
> [PUT**Connect to instance console by ID (v2)**`/v2/apps/instances/id/{id}/console/remote`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-console-remote)
> [PUT**Deactivate instance by ID (v2)**`/v2/apps/instances/id/{id}/deactivate`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-deactivate)
> [PUT**Refresh instance by ID (v2)**`/v2/apps/instances/id/{id}/refresh`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-refresh)
> [PUT**Refresh and purge instance by ID (v2)**`/v2/apps/instances/id/{id}/refresh/purge`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-refresh-purge)
> [PUT**Restart instance by ID (v2)**`/v2/apps/instances/id/{id}/restart`](https://zededa.mintlify.site/api-reference/edge-application/put-v2-apps-instances-id-by-id-restart)
>
> Patch references2 operations
>
> [POST**Patch envelope reference update (v1)**`/v1/apps/instances/patch-reference-update`](https://zededa.mintlify.site/api-reference/edge-application/post-v1-apps-instances-patch-reference-update)
> [POST**Patch envelope reference update (v2)**`/v2/apps/instances/patch-reference-update`](https://zededa.mintlify.site/api-reference/edge-application/post-v2-apps-instances-patch-reference-update)

Instance management · Lifecycle and console · Patch referencesGETPOSTPUTDELETE

36 operations

> [accordion] Instance monitoring
>
> Status and tags9 operations
>
> [GET**Get instance status by ID (v1)**`/v1/apps/instances/id/{id}/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-status)
> [GET**Get instance status by name (v1)**`/v1/apps/instances/name/{name}/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-name-status)
> [GET**Query status of instances (v1)**`/v1/apps/instances/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-status)
> [GET**Query status and config of instances (v1)**`/v1/apps/instances/status-config`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-status-config)
> [GET**Query Application instance tags**`/v1/apps/instances/tags`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-tags)
> [GET**Get instance status by ID (v2)**`/v2/apps/instances/id/{id}/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id-status)
> [GET**Get instance status by name (v2)**`/v2/apps/instances/name/{name}/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-name-status)
> [GET**Query status of instances (v2)**`/v2/apps/instances/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-status)
> [GET**Query status and config of instances (v2)**`/v2/apps/instances/status-config`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-status-config)
>
> Snapshots5 operations
>
> [GET**Query Application instance snapshot by name**`/v1/apps/instances/id/{appInstanceId}/snapshot/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-appinstanceid-snapshot-name-by-name)
> [GET**Query Application instance snapshots**`/v1/apps/instances/id/{id}/snapshots`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-snapshots)
> [GET**Query Application instance snapshot by ID**`/v1/apps/instances/snapshot/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-snapshot-id-by-id)
> [GET**Query Application instance snapshot state**`/v1/apps/instances/snapshot/id/{id}/state`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-snapshot-id-by-id-state)
> [DELETE**Delete Application instance snapshot**`/v1/apps/instances/id/{appInstanceId}/snapshot/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/delete-v1-apps-instances-id-by-appinstanceid-snapshot-name-by-name)
>
> Network flows8 operations
>
> [GET**Get instance flow log by ID (v1)**`/v1/apps/instances/id/{id}/flowlog/classification`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-flowlog-classification)
> [GET**Get instance top talkers by ID (v1)**`/v1/apps/instances/id/{id}/flowlog/toptalkers`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-flowlog-toptalkers)
> [GET**Get instance flow log by name (v1)**`/v1/apps/instances/name/{name}/flowlog/classification`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-name-flowlog-classification)
> [GET**Get instance top talkers by name (v1)**`/v1/apps/instances/name/{name}/flowlog/toptalkers`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-name-flowlog-toptalkers)
> [GET**Get instance flow log by ID (v2)**`/v2/apps/instances/id/{id}/flowlog/classification`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id-flowlog-classification)
> [GET**Get instance top talkers by ID (v2)**`/v2/apps/instances/id/{id}/flowlog/toptalkers`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id-flowlog-toptalkers)
> [GET**Get instance flow log by name (v2)**`/v2/apps/instances/name/{name}/flowlog/classification`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-name-flowlog-classification)
> [GET**Get instance top talkers by name (v2)**`/v2/apps/instances/name/{name}/flowlog/toptalkers`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-name-flowlog-toptalkers)
>
> Logs and events6 operations
>
> [GET**Get instance log by ID (v1)**`/v1/apps/instances/id/{id}/logs`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-logs)
> [GET**Get instance events by id (v1)**`/v1/apps/instances/id/{objid}/events`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-objid-events)
> [GET**Get instance events by name (v1)**`/v1/apps/instances/name/{objname}/events`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-objname-events)
> [GET**Get instance log by ID (v2)**`/v2/apps/instances/id/{id}/logs`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id-logs)
> [GET**Get instance events by id (v2)**`/v2/apps/instances/id/{objid}/events`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-objid-events)
> [GET**Get instance events by name (v2)**`/v2/apps/instances/name/{objname}/events`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-objname-events)
>
> Resource usage4 operations
>
> [GET**Get instance resource usage timeline by ID (v1)**`/v1/apps/instances/id/{objid}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-objid-timeseries-by-mtype)
> [GET**Get instance resource usage timeline by name (v1)**`/v1/apps/instances/name/{objname}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-objname-timeseries-by-mtype)
> [GET**Get instance resource usage timeline by ID (v2)**`/v2/apps/instances/id/{objid}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-objid-timeseries-by-mtype)
> [GET**Get instance resource usage timeline by name (v2)**`/v2/apps/instances/name/{objname}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-objname-timeseries-by-mtype)
>
> Patch status4 operations
>
> [GET**Get patch envelope status (base64) by ID (v1)**`/v1/apps/instances/id/{id}/opaque-status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-id-by-id-opaque-status)
> [GET**Get patch envelope status (base64) by name (v1)**`/v1/apps/instances/name/{name}/opaque-status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-apps-instances-name-by-name-opaque-status)
> [GET**Get patch envelope status (base64) by ID (v2)**`/v2/apps/instances/id/{id}/opaque-status`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-id-by-id-opaque-status)
> [GET**Get patch envelope status (base64) by name (v2)**`/v2/apps/instances/name/{name}/opaque-status`](https://zededa.mintlify.site/api-reference/edge-application/get-v2-apps-instances-name-by-name-opaque-status)

Status and tags · Snapshots · Network flows · Logs and events · Resource usage · Patch statusGETDELETE

7 operations

> [accordion] Patch envelopes
>
> [GET**Get all the patch envelopes**`/v1/patch-envelope`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-patch-envelope)
> [GET**Get patch envelope by id**`/v1/patch-envelope/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-patch-envelope-id-by-id)
> [GET**Get patch envelope by name**`/v1/patch-envelope/name/{name}`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-patch-envelope-name-by-name)
> [GET**Get patch envelope status**`/v1/patch-envelope/status`](https://zededa.mintlify.site/api-reference/edge-application/get-v1-patch-envelope-status)
> [POST**Create patch envelope**`/v1/patch-envelope`](https://zededa.mintlify.site/api-reference/edge-application/post-v1-patch-envelope)
> [PUT**Update patch envelope**`/v1/patch-envelope/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/put-v1-patch-envelope-id-by-id)
> [DELETE**Delete patch envelope**`/v1/patch-envelope/id/{id}`](https://zededa.mintlify.site/api-reference/edge-application/delete-v1-patch-envelope-id-by-id)

GETPOSTPUTDELETE

> [accordion] About this service
>
> The ZEDEDA Edge Application Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their edge applications on ZEDEDA platform and to deploy/upgrade/restarti/monitor them to edge node(s) remotely. You can use the ZEDEDA Edge Application Service to provision and manage ilifecycle of thousands of edge applications to millions of edge nodes distributed in different geographical locations in a secure and scalable manner.

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)
