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

# Diagnostics

> Explore 23 diagnostics API operations.

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

&#x20;API SERVICE

# Diagnostics

Inspect cloud health and edge diagnostics, including device configuration, events, and resource usage.

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

START EXPLORING
Get Cloud services health report
[GET`/v1/cloud/healthreport`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-healthreport)
Explore the parameters and response schema. Sign in from your console to try a request.
[Open endpoint ](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-healthreport.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.

**23** operations  **2** groupsGET18POST2PUT2DELETE1

EXPLORE THE SERVICE

## Endpoint groups

Expand a group to find an endpoint.

10 operations

> [accordion] Cloud Diagnostics
>
> [GET**Get Cloud services health report**`/v1/cloud/healthreport`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-healthreport)
> [GET**Check Cloud reachability**`/v1/cloud/ping`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-ping)
> [GET**Check Cloud reachability by ID**`/v1/cloud/ping/id/{pingId}`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-ping-id-by-pingid)
> [GET**Query Cloud policies**`/v1/cloud/policies`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-policies)
> [GET**Get Cloud policy document**`/v1/cloud/policies/id/{id}`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-policies-id-by-id)
> [GET**Get Cloud controller software version**`/v1/cloud/version`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-cloud-version)
> [POST**Create Cloud policy document**`/v1/cloud/policies`](https://zededa.mintlify.site/api-reference/diagnostics/post-v1-cloud-policies)
> [POST**Check Cloud services health**`/v1/hello`](https://zededa.mintlify.site/api-reference/diagnostics/post-v1-hello)
> [PUT**Update Cloud policy specific version**`/v1/cloud/policies/latest`](https://zededa.mintlify.site/api-reference/diagnostics/put-v1-cloud-policies-latest)
> [DELETE**Delete Cloud policy specific version**`/v1/cloud/policies/id/{id}`](https://zededa.mintlify.site/api-reference/diagnostics/delete-v1-cloud-policies-id-by-id)

GETPOSTPUTDELETE

13 operations

> [accordion] Edge Diagnostics
>
> Device configuration9 operations
>
> [GET**Get current Device twin configuration by ID**`/v1/devices/id/{id}/config`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-id-by-id-config)
> [GET**Get bootstrap Device twin configuration by ID**`/v1/devices/id/{id}/config/bootstrap`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-id-by-id-config-bootstrap)
> [GET**Get next Device twin configuration by ID**`/v1/devices/id/{id}/config/next`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-id-by-id-config-next)
> [GET**Get offline Device twin configuration by ID**`/v1/devices/id/{id}/config/offline`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-id-by-id-config-offline)
> [GET**Get current Device twin configuration by name**`/v1/devices/name/{name}/config`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-name-by-name-config)
> [GET**Get bootstrap Device twin configuration by name**`/v1/devices/name/{name}/config/bootstrap`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-name-by-name-config-bootstrap)
> [GET**Get next Device twin configuration by name**`/v1/devices/name/{name}/config/next`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-name-by-name-config-next)
> [GET**Get offline Device twin configuration by name**`/v1/devices/name/{name}/config/offline`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-devices-name-by-name-config-offline)
> [PUT**Re-generate device configuration**`/v1/devices/id/{id}/config`](https://zededa.mintlify.site/api-reference/diagnostics/put-v1-devices-id-by-id-config)
>
> Events and usage4 operations
>
> [GET**Get events timeline**`/v1/events`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-events)
> [GET**Get usage timeline (events route)**`/v1/events/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-events-timeseries-by-mtype)
> [GET**Get top users**`/v1/events/topUsers`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-events-topusers)
> [GET**Get resource usage timeline**`/v1/timeSeries/{mType}`](https://zededa.mintlify.site/api-reference/diagnostics/get-v1-timeseries-by-mtype)

Device configuration · Events and usageGETPUT

> [accordion] About this service
>
> ZEDEDA Diagnostics Service is a helper service that provides insight into two things - cloud diagnostics data and edge diagnostics data. As part of Cloud Diagnostics, it allows insight into zedcontrol cluster. As part of Edge Diagnisticss, it collects monitoring data from the edge nodes and presents an aggregated timeline view of resource usage and health of edge nodes

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)
