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

> Explore 96 edge nodes API operations.

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

&#x20;API SERVICE

# Edge nodes

Onboard, configure, and monitor your edge fleet. Manage node lifecycle, hardware models, and projects from one API.

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

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

**96** operations  **6** groupsGET58POST9PUT21DELETE8

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

25 operations

> [accordion] Hardware models
>
> Brands9 operations
>
> [GET**Query brands**`/v1/brands`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands)
> [GET**Query global brands**`/v1/brands/global`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands-global)
> [GET**Get global brand by ID**`/v1/brands/global/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands-global-id-by-id)
> [GET**Get global brand by name**`/v1/brands/global/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands-global-name-by-name)
> [GET**Get brand by ID**`/v1/brands/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands-id-by-id)
> [GET**Get brand by name**`/v1/brands/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-brands-name-by-name)
> [POST**Create brand**`/v1/brands`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-brands)
> [PUT**Update brand**`/v1/brands/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-brands-id-by-id)
> [DELETE**Delete brand**`/v1/brands/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-brands-id-by-id)
>
> Models10 operations
>
> [GET**Query models**`/v1/sysmodels`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels)
> [GET**Query global models**`/v1/sysmodels/global`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-global)
> [GET**Get global model by ID**`/v1/sysmodels/global/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-global-id-by-id)
> [GET**Get global model by name**`/v1/sysmodels/global/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-global-name-by-name)
> [GET**Get model by ID**`/v1/sysmodels/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-id-by-id)
> [GET**Get model by name**`/v1/sysmodels/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-name-by-name)
> [POST**Create model**`/v1/sysmodels`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-sysmodels)
> [PUT**Update model**`/v1/sysmodels/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-sysmodels-id-by-id)
> [PUT**Import model**`/v1/sysmodels/id/{id}/import`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-sysmodels-id-by-id-import)
> [DELETE**Delete model**`/v1/sysmodels/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-sysmodels-id-by-id)
>
> PCR templates6 operations
>
> [GET**Query PCR template by ID**`/v1/pcrtemplates/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-pcrtemplates-id-by-id)
> [GET**Query PCR templates**`/v1/sysmodels/id/{id}/pcrtemplates`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-id-by-id-pcrtemplates)
> [GET**Query PCR template by name**`/v1/sysmodels/id/{modelId}/pcrtemplates/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-sysmodels-id-by-modelid-pcrtemplates-name-by-name)
> [POST**Create PCR templates**`/v1/sysmodels/id/{id}/pcrtemplates`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-sysmodels-id-by-id-pcrtemplates)
> [PUT**Update PCR template**`/v1/pcrtemplate/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-pcrtemplate-id-by-id)
> [DELETE**Delete PCR template**`/v1/pcrtemplates/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-pcrtemplates-id-by-id)

Brands · Models · PCR templatesGETPOSTPUTDELETE

6 operations

> [accordion] Certificate profiles
>
> [GET**List certificate enrollment profiles**`/v1/ceps`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-ceps)
> [GET**Get certificate enrollment profile by ID**`/v1/ceps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-ceps-id-by-id)
> [GET**Get certificate enrollment profile by name**`/v1/ceps/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-ceps-name-by-name)
> [POST**Create a certificate enrollment profile**`/v1/ceps`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-ceps)
> [PUT**Update a certificate enrollment profile**`/v1/ceps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-ceps-id-by-id)
> [DELETE**Delete a certificate enrollment profile**`/v1/ceps/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-ceps-id-by-id)

GETPOSTPUTDELETE

27 operations

> [accordion] Node configuration
>
> Node inventory8 operations
>
> [GET**Query nodes**`/v1/devices`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices)
> [GET**Get node**`/v1/devices/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id)
> [GET**Query device interface tags**`/v1/devices/interfaces/tags`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-interfaces-tags)
> [GET**Get node by name**`/v1/devices/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-name)
> [GET**Get node by serial number**`/v1/devices/serial/{serialno}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-serial-by-serialno)
> [POST**Create node**`/v1/devices`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-devices)
> [PUT**Update node**`/v1/devices/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id)
> [DELETE**Delete node**`/v1/devices/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-devices-id-by-id)
>
> Lifecycle actions5 operations
>
> [PUT**Activate node**`/v1/devices/id/{id}/activate`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-activate)
> [PUT**Deactivate node**`/v1/devices/id/{id}/deactivate`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-deactivate)
> [PUT**Offboard node**`/v1/devices/id/{id}/offboard`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-offboard)
> [PUT**Shutdown applications on node**`/v1/devices/id/{id}/preparepoweroff`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-preparepoweroff)
> [PUT**Reboot node**`/v1/devices/id/{id}/reboot`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-reboot)
>
> EVE OS updates4 operations
>
> [PUT**Apply EVE image**`/v1/devices/id/{id}/apply`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-apply)
> [PUT**Retry baseos upgrade**`/v1/devices/id/{id}/baseos/upgrade/retry`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-baseos-upgrade-retry)
> [PUT**Publish EVE image**`/v1/devices/id/{id}/publish`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-publish)
> [PUT**Unpublish EVE image**`/v1/devices/id/{id}/unpublish`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-unpublish)
>
> Onboarding images4 operations
>
> [GET**Get node onboarding certificate**`/v1/devices/id/{id}/onboarding`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-onboarding)
> [GET**Get node single-use EVE image details**`/v1/devices/id/{id}/suimage`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-suimage)
> [GET**Get node single-use EVE image download link**`/v1/devices/id/{id}/suimage/link`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-suimage-link)
> [POST**Create node single-use EVE image**`/v1/devices/id/{id}/suimage`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-devices-id-by-id-suimage)
>
> Security and remote access6 operations
>
> [GET**Get node PCR attestation**`/v1/devices/id/{id}/attestation`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-attestation)
> [GET**Get EdgeView client script**`/v1/devices/id/{id}/edgeview/clientscript`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-edgeview-clientscript)
> [PUT**Stop debug mode**`/v1/devices/id/{id}/debug/disable`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-debug-disable)
> [PUT**Start debug mode**`/v1/devices/id/{id}/debug/enable`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-debug-enable)
> [PUT**Stop EdgeView**`/v1/devices/id/{id}/edgeview/disable`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-edgeview-disable)
> [PUT**Start EdgeView**`/v1/devices/id/{id}/edgeview/enable`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-devices-id-by-id-edgeview-enable)

Node inventory · Lifecycle actions · EVE OS updates · Onboarding images · Security and remote accessGETPOSTPUTDELETE

16 operations

> [accordion] Node monitoring
>
> Status and inventory8 operations
>
> [GET**Get node status by ID**`/v1/devices/id/{id}/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-status)
> [GET**Get node info by ID**`/v1/devices/id/{id}/status/info`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-status-info)
> [GET**Get node status by name**`/v1/devices/name/{name}/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-name-status)
> [GET**Get node info by name**`/v1/devices/name/{name}/status/info`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-name-status-info)
> [GET**Query status of nodes**`/v1/devices/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-status)
> [GET**Query device status and config**`/v1/devices/status-config`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-status-config)
> [GET**Query device status location**`/v1/devices/status/locations`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-status-locations)
> [GET**Query device object tag key-values**`/v1/devices/tags`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-tags)
>
> Metrics and events6 operations
>
> [GET**Get node raw status by ID**`/v1/devices/id/{id}/status/metrics/raw`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-status-metrics-raw)
> [GET**Get node events by id**`/v1/devices/id/{objid}/events`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-objid-events)
> [GET**Get node resource usage timeline by ID**`/v1/devices/id/{objid}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-objid-timeseries-by-mtype)
> [GET**Get node raw status by name**`/v1/devices/name/{name}/status/metrics/raw`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-name-status-metrics-raw)
> [GET**Get node events by name**`/v1/devices/name/{objname}/events`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-objname-events)
> [GET**Get node resource usage timeline by name**`/v1/devices/name/{objname}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-objname-timeseries-by-mtype)
>
> EdgeView status2 operations
>
> [GET**Get node EdgeView status**`/v1/devices/id/{id}/status/edgeview`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-id-by-id-status-edgeview)
> [GET**Get node EdgeView status by node name**`/v1/devices/name/{name}/status/edgeview`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-devices-name-by-name-status-edgeview)

Status and inventory · Metrics and events · EdgeView statusGET

18 operations

> [accordion] Projects
>
> Project management8 operations
>
> [GET**Query projects**`/v1/projects`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects)
> [GET**Get project by ID**`/v1/projects/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-id-by-id)
> [GET**Get project by name**`/v1/projects/name/{name}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-name-by-name)
> [GET**Query project tag key-values**`/v1/projects/tags`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-tags)
> [POST**Create project (v1)**`/v1/projects`](https://zededa.mintlify.site/api-reference/edge-node/post-v1-projects)
> [POST**Create project (v2)**`/v2/projects`](https://zededa.mintlify.site/api-reference/edge-node/post-v2-projects)
> [PUT**Update project**`/v1/projects/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v1-projects-id-by-id)
> [DELETE**Delete project**`/v1/projects/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v1-projects-id-by-id)
>
> Deployments6 operations
>
> [GET**Get deployment list in a project by ID**`/v2/projects/id/{projectId}/deployments`](https://zededa.mintlify.site/api-reference/edge-node/get-v2-projects-id-by-projectid-deployments)
> [GET**Get deployment status**`/v2/projects/id/{projectId}/deployments/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/get-v2-projects-id-by-projectid-deployments-id-by-id)
> [POST**Create deployment for a project**`/v2/projects/id/{projectId}/deployments`](https://zededa.mintlify.site/api-reference/edge-node/post-v2-projects-id-by-projectid-deployments)
> [PUT**Update deployment in a project**`/v2/projects/id/{projectId}/deployments/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/put-v2-projects-id-by-projectid-deployments-id-by-id)
> [DELETE**Delete all deployments in a project**`/v2/projects/id/{projectId}/deployments`](https://zededa.mintlify.site/api-reference/edge-node/delete-v2-projects-id-by-projectid-deployments)
> [DELETE**Delete deployment in a project**`/v2/projects/id/{projectId}/deployments/id/{id}`](https://zededa.mintlify.site/api-reference/edge-node/delete-v2-projects-id-by-projectid-deployments-id-by-id)
>
> Events and usage4 operations
>
> [GET**Get project events by id**`/v1/projects/id/{objid}/events`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-id-by-objid-events)
> [GET**Get project resource usage timeline by ID**`/v1/projects/id/{objid}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-id-by-objid-timeseries-by-mtype)
> [GET**Get project events by name**`/v1/projects/name/{objname}/events`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-name-by-objname-events)
> [GET**Get project resource usage timeline by name**`/v1/projects/name/{objname}/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-name-by-objname-timeseries-by-mtype)

Project management · Deployments · Events and usageGETPOSTPUTDELETE

4 operations

> [accordion] Project status
>
> [GET**Get project status by ID**`/v1/projects/id/{id}/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-id-by-id-status)
> [GET**Get project status by name**`/v1/projects/name/{name}/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-name-by-name-status)
> [GET**Query projects status**`/v1/projects/status`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-status)
> [GET**Query projects status and config**`/v1/projects/status-config`](https://zededa.mintlify.site/api-reference/edge-node/get-v1-projects-status-config)

GET

> [accordion] About this service
>
> The ZEDEDA Edge Node Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to onboard their edge nodes on ZEDEDA platform and upgrade/restart/monitor them remotely. You can use the ZEDEDA Edge Node Service to provision and manage lifecycle of 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)
