Zededa EdgeDiagnostics API
The EdgeDiagnostics API from Zededa — 12 operation(s) for edgediagnostics.
Zededa EdgeDiagnostics API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EdgeDiagnostics. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 12 paths, and defines 133 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
13 operations
12 paths
133 schemas
12 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa EdgeDiagnostics API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (BearerToken).
By default, every request must be authenticated.
BearerToken— Bearer token for user session
Paths & Operations 13
Across 12 paths, the API surfaces 13 operations — 12 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
EdgeDiagnostics 13
GET
/v1/devices/id/{id}/config
Get current Device twin configuration
PUT
/v1/devices/id/{id}/config
Re-generate device configuration
GET
/v1/devices/id/{id}/config/bootstrap
Get bootstrap Device twin configuration
GET
/v1/devices/id/{id}/config/next
Get next Device twin configuration
GET
/v1/devices/id/{id}/config/offline
Get offline Device twin configuration
GET
/v1/devices/name/{name}/config
Get current Device twin configuration
GET
/v1/devices/name/{name}/config/bootstrap
Get bootstrap Device twin configuration
GET
/v1/devices/name/{name}/config/next
Get next Device twin configuration
GET
/v1/devices/name/{name}/config/offline
Get offline Device twin configuration
GET
/v1/events
Get events timeline
GET
/v1/events/timeSeries/{mType}
Get resource usage timeline
GET
/v1/events/topUsers
Get top users
GET
/v1/timeSeries/{mType}
Get resource usage timeline
Schemas 133
The contract defines 133 schemas that model the data the API accepts and returns. The most detailed are configEdgeDevConfig (37 properties), configVmConfig (26 properties), configAppInstanceConfig (24 properties), configNetworkInstanceConfig (16 properties). Each schema is shown below with its type and property counts.
configAppRuntimeType
string
AppRuntimeType - to indicate the types of Application Deployment For instance, the need to gather of docker container metrics and logs from the agent inside ap…
configACEAction
object
7 properties
configEncryptedInlineOpaqueBase64Data
object
1 property
LastKnownStatus
object
3 properties
configZNetworkOpaqueConfigType
string
Summary
object
Summary is used to store the Summary details
3 properties
EventQueryResponseItem
object
Event query response item payload
14 properties
configMetaDataType
string
configSignatureInfo
object
XXX this will be deprecated when all deployed instances of EVE no longer expect it. 5.6.X depend on it. 5.7.1 does not.
3 properties
configNetworkInstanceOpaqueConfig
object
Network Instance Opaque config. In future we might add more fields here but idea is here. This is service specific configuration.
3 properties
configVolumeContentOrigin
object
2 properties
commonProxyConfig
object
6 properties
eveconfigClusterType
string
MetricQueryResponseItem
object
2 properties
configVmBootMode
string
configCellularConfig
object
5 properties
commonproxyProto
string
configPortProbe
object
Configuration for port connectivity probe.
3 properties
evecommonDiskDescription
object
3 properties
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
configVolumeRef
object
3 properties
configLOCConfig
object
2 properties
configNetworkConfig
object
7 properties
commonNetworkType
string
configEveBinaryArtifact
object
7 properties
configCellularAccessPoint
object
CellularAccessPoint contains config parameters for connecting to a cellular network.
11 properties
EventSource
string
- EVENTSOURCEUNSPECIFIED: Default - EVENTSOURCESYSTEM: Event is generated as a result of status change reported by edge node / application - EVENTSOURCEUSER: E…
eveconfigEdgeNodeCluster
object
9 properties
configArpMonitor
object
ArpMonitor : ARP-based link monitoring parameters. Defined for BondAdapter.
2 properties
configConfigItem
object
Timers and other per-device policy which relates to the interaction with zedcloud. Note that the timers are randomized on the device to avoid synchronization w…
2 properties
configSnapshotConfig
object
4 properties
configCellularConnectivityProbe
object
CellularConnectivityProbe is used to periodically check the connectivity status of a cellular network by probing a remote endpoint. Whenever the probe fails, t…
3 properties
commonZnetStaticDNSEntry
object
2 properties
configLacpRate
string
Option specifying the rate in which EVE will ask LACP link partners to transmit LACPDU packets in 802.3ad mode. - LACPRATEUNSPECIFIED: Default LACP rate is Slo…
configEthVF
object
3 properties
evecommonWirelessType
string
configAddressType
string
ConfigServiceResp
object
12 properties
configEVE_PATCH_ENVELOPE_ACTION
string
configACE
object
5 properties
EventTopUsersData
object
2 properties
EventTopUsersResp
object
1 property
configBondMode
string
A bonding mode specifies the policy indicating how bonding slaves are used during network transmission. - BONDMODEUNSPECIFIED: BONDMODEUNSPECIFIED : if bonding…
configEncryptedExternalOpaqueBinaryBlob
object
1 property
configBondAdapter
object
BondAdapter aggregates multiple PhysicalIOs into one adapter for redundancy and load-spreading purposes.
7 properties
configDriveType
string
- HDDEMPTY: this type is allocate the empty disk of maxsizebytes specified
configVolumeContentOriginType
string
configACEMatch
object
2 properties
configVfList
object
2 properties
configZcServicePoint
object
3 properties
commonipRange
object
2 properties
commonDhcpOptionsIgnore
object
DhcpOptionsIgnore specifies which DHCP-provided options should be ignored by the device, allowing static configuration to override DHCP where applicable. Curre…
4 properties
configEVE_OPAQUE_OBJECT_CATEGORY
string
configZcServiceType
string
MetricQueryResponse
object
5 properties
ObjectType
string
configInstanceOpsCmd
object
2 properties
LocalOperatorConsoleBlobList
object
2 properties
MetricThreshold
object
2 properties
commonCipherBlock
object
4 properties
commonDHCPType
string
configBaseOSConfig
object
5 properties
protobufAny
object
2 properties
commonPhyIoMemberUsage
string
PhyIoMemberUsage - Indicates how each adaptor must be used by Eve. - PhyIoUsageMgmtAndApps: Used by both management and apps. - PhyIoUsageShared: Shared by mul…
configDisksConfig
object
For example to use stripe of two pairs of mirrored disks we should define DisksConfig without disks with arraytype DISKSARRAYTYPERAID0 with two children with p…
3 properties
configVmMode
string
For now we need to tell the device which virtualization mode to use. Later we might use a single one for all VMs (on any particular ISA). If we end up keeping…
eveconfigSnapshotType
string
configNetworkInstanceConfig
object
16 properties
configSnapshotDesc
object
2 properties
EventQueryResponse
object
Event query response request payload
3 properties
2 required
configSpanningTreeProtocol
object
Configuration for the Spanning Tree Protocol (STP), which is run for switch network instance when the port label matches multiple network ports.
1 property
configACEDirection
string
configPhyIOUsagePolicy
object
1 property
configBaseOS
object
4 properties
configDevDebugAccessPolicy
object
1 property
configEvePatchEnvelope
object
7 properties
configFormat
string
configMIIMonitor
object
MIIMonitor : MII link monitoring parameters. Defined for BondAdapter.
3 properties
configZNetworkInstType
string
eveconfigInlineOpaqueBase64Data
object
3 properties
ZsrvError
object
3 properties
configDiskConfigType
string
configAdapter
object
Adapter bundles corresponding to a subset of what is in ZioBundle When used by a NetworkInstanceConfig the name is the logicallabel for the network adapter.
4 properties
commonipspec
object
9 properties
configPhysicalIO
object
10 properties
configNetworkAdapter
object
13 properties
configUUIDandVersion
object
2 properties
configDrive
object
6 properties
configPatchEnvelopeRef
object
2 properties
evecommonCellularAuthProtocol
string
CellularAuthProtocol defines the authentication protocol used for cellular connection. - CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP…
configDiskConfig
object
3 properties
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
configAppInstanceConfig
object
The complete configuration for an Application Instance When changing key fields such as the drives/volumeRefs or the number of interfaces, the controller is re…
24 properties
configEdgeDevConfig
object
This is the response to a GET /api/v1/edgeDevice/config The EdgeDevConfig message carries all of the device's configuration from the controller to the device.…
37 properties
commonCipherContext
object
6 properties
ZcOpsType
string
configContentTree
object
12 properties
configWifiConfig
object
7 properties
commonCellularIPType
string
The IP addressing type to use for a given attach or default bearer. - CELLULARIPTYPEUNSPECIFIED: IP type is not specified. When unspecified, EVE will not enfor…
configEdgeViewConfig
object
6 properties
commonHashAlgorithm
string
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
configTarget
string
commonProxyServer
object
3 properties
eveconfigIPRoute
object
6 properties
eveconfigImage
object
7 properties
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
commonKeyExchangeScheme
string
configDatastoreConfig
object
9 properties
configWirelessConfig
object
3 properties
configDeviceOpsCmd
object
Device Operational Commands Semantic For rebooting device, command=Reset, counter = counter+delta, desiredState = on For poweroff device, command=Reset, counte…
3 properties
LocalOperatorConsoleBlob
object
3 properties
configSystemAdapter
object
systemAdapters are higher-level IP-ready network endpoints. systemAdapters give all the required bits to turn the physical IOs and intermediate L2 objects into…
10 properties
commonWiFiKeyScheme
string
googlerpcStatus
object
3 properties
evecommonRadioAccessTechnology
string
- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…
configNetworkInstanceLispConfig
object
7 properties
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
configAppDebugAccessPolicy
object
1 property
ZsrvResponse
object
15 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
configDsType
string
configDisksArrayType
string
commonEncryptionScheme
string
WifiConfigcryptoblock
object
2 properties
eveconfigExternalOpaqueBinaryBlob
object
4 properties
commonPhyIoType
string
configVolumeAccessProtocols
string
configVlanAccessPort
object
VLAN Access Port config applied to physical port(s) attached to a Switch Network Instance.
2 properties
configVolume
object
The Volume describes a storage volume which should exist on the device. This can currently either be blank or created from a ContentTree If maxSizeBytes is zer…
10 properties
configVlanAdapter
object
VlanAdapter represents a single VLAN sub-interface. The parent, which is referenced by lowerlayername, should be either PhysicalIO or BondAdapter.
4 properties
configVmConfig
object
26 properties
configExternalEndPointPolicy
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zededa 12
Other APIs Zededa publishes across the network.
Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
#EdgeDiagnostics