Zededa EdgeDiagnostics API
The EdgeDiagnostics API from Zededa — 12 operation(s) for edgediagnostics.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/zededa-edgediagnostics-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ZEDEDA App Profiles Service AppProfileService Edge Diagnostics API
description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
termsOfService: https://www.zededa.com/terms
version: '1.0'
contact:
name: ZEDEDA API Support
url: https://www.zededa.com/support
email: support@zededa.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: /api
security:
- BearerToken: []
tags:
- name: EdgeDiagnostics
paths:
/v1/devices/id/{id}/config:
get:
summary: Get current Device twin configuration
description: Get currentnext Device twin configuration for the edge node. Edge node has read this configuration when it queried Cloud controller last time.
operationId: EdgeDiagnostics_GetDeviceTwinConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
description: system generated unique id for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
put:
summary: Re-generate device configuration
description: Re-generate the device configuration. Edge node will get this configuration when it queries Cloud controller next time.
operationId: EdgeDiagnostics_RegenDeviceConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
description: system generated unique id for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/id/{id}/config/bootstrap:
get:
summary: Get bootstrap Device twin configuration
description: Get bootstrap Device twin configuration for the edge node. Doesn't change the existing edge node configuration.
operationId: EdgeDiagnostics_GetDeviceTwinBootstrapConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'405':
description: Method not allowed. The API request can't be performed due to a wrong edge node's admin status.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
description: system generated unique id for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/id/{id}/config/next:
get:
summary: Get next Device twin configuration
description: Get next Device twin configuration for the edge node. Edge node will get this configuration when it queries Cloud controller next time.
operationId: EdgeDiagnostics_GetDeviceTwinNextConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
description: system generated unique id for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/id/{id}/config/offline:
get:
summary: Get offline Device twin configuration
description: Get offline Device twin configuration for the edge node. Edge node will get this configuration when it queries Cloud controller next time.
operationId: EdgeDiagnostics_GetDeviceTwinOfflineNextConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
description: system generated unique id for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/name/{name}/config:
get:
summary: Get current Device twin configuration
description: Get currentnext Device twin configuration for the edge node. Edge node has read this configuration when it queried Cloud controller last time.
operationId: EdgeDiagnostics_GetDeviceTwinConfigByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
description: user defined device name for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/name/{name}/config/bootstrap:
get:
summary: Get bootstrap Device twin configuration
description: Get bootstrap Device twin configuration for the edge node. Doesn't change the existing edge node configuration.
operationId: EdgeDiagnostics_GetDeviceTwinBootstrapConfigByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'405':
description: Method not allowed. The API request can't be performed due to a wrong edge node's admin status.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
description: user defined device name for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/name/{name}/config/next:
get:
summary: Get next Device twin configuration
description: Get next Device twin configuration for the edge node. Edge node will get this configuration when it queries Cloud controller next time.
operationId: EdgeDiagnostics_GetDeviceTwinNextConfigByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
description: user defined device name for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/devices/name/{name}/config/offline:
get:
summary: Get offline Device twin configuration
description: Get offline Device twin configuration for the edge node. Edge node will get this configuration when it queries Cloud controller next time.
operationId: EdgeDiagnostics_GetDeviceTwinOfflineConfigByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigServiceResp'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
description: user defined device name for a device
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeDiagnostics
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com/hc/en-us/articles/30323173611931-ZEDEDA-API-Overview
/v1/events:
get:
summary: Get events timeline
description: Get aggregated events timeline
operationId: EdgeDiagnostics_GetEventsTimeline
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/EventQueryResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-app level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: objname
description: Object name
in: query
required: false
schema:
type: string
- name: objid
description: Object id
in: query
required: false
schema:
type: string
- name: objtype
description: Object type
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- USER
- EDGE_NODE
- EDGE_APP
- IMAGE
# --- truncated at 32 KB (179 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgediagnostics-api-openapi.yml