Zededa EdgeNodeStatus API
The EdgeNodeStatus API from Zededa — 13 operation(s) for edgenodestatus.
Zededa EdgeNodeStatus API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EdgeNodeStatus. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 13 paths, and defines 100 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
13 paths
100 schemas
13 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa EdgeNodeStatus 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 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.
EdgeNodeStatus 13
GET
/v1/devices/id/{id}/status
Get edge node status
GET
/v1/devices/id/{id}/status/edgeview
Get edge node edgeview status
GET
/v1/devices/id/{id}/status/info
Get edge node info
GET
/v1/devices/id/{id}/status/metrics/raw
Get edge node raw status
GET
/v1/devices/id/{objid}/events
Get edge node events by id
GET
/v1/devices/id/{objid}/timeSeries/{mType}
Get edge node resource usage timeline
GET
/v1/devices/name/{name}/status
Get edge node status
GET
/v1/devices/name/{name}/status/edgeview
Get edge node edgeview status by edge node name
GET
/v1/devices/name/{name}/status/info
Get edge node info
GET
/v1/devices/name/{name}/status/metrics/raw
Get edge node raw status
GET
/v1/devices/name/{objname}/events
Get edge node events by id
GET
/v1/devices/name/{objname}/timeSeries/{mType}
Get edge node resource usage timeline
GET
/v1/devices/status
Query status of edge nodes
Schemas 100
The contract defines 100 schemas that model the data the API accepts and returns. The most detailed are DeviceInfoMsg (48 properties), DeviceStatusMsg (37 properties), DeviceStatusSummaryMsg (26 properties), NtpSource (23 properties). Each schema is shown below with its type and property counts.
DevDataSecAtRest
object
3 properties
Summary
object
Summary is used to store the Summary details
3 properties
NetworkStatus
object
NetworkStatus is used to store the Network status
15 properties
GeoLocation
object
Geographic location of an edge node determined by a variety of data collection mechanisms (e.g. network routing addresses or internal GPS devices).
10 properties
EventQueryResponseItem
object
Event query response item payload
14 properties
ECCMemoryControllerInfo
object
4 properties
ZCellularOperatingState
string
NetworkProxyProto
string
ECCMemoryReportStatus
string
DeviceDataSecurityAtRestStatus
string
MetricQueryResponseItem
object
2 properties
NtpSource
object
23 properties
NetProxyStatus
object
NetProxyStatus is used to store the proxy configurations
6 properties
RadioAccessTechnology
string
- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…
Capabilities
object
2 properties
LTEAdapter
object
Details of LTE Adapter
7 properties
NtpSourceState
string
Enum for describing the NTP source state, see chrony client sources https://gitlab.com/chrony/chrony/-/blob/master/client.c and its output of the command 'sour…
DeviceSWSubStatus
string
DeviceInfo
object
6 properties
StorageDiskInfo
object
6 properties
MemorySummary
object
Memory Summary
3 properties
EventSource
string
- EVENTSOURCEUNSPECIFIED: Default - EVENTSOURCESYSTEM: Event is generated as a result of status change reported by edge node / application - EVENTSOURCEUSER: E…
DeviceInfoMsg
object
48 properties
PNACSupplicantState
string
PNACSupplicantState describes the 802.1X supplicant state for PNAC. - PNACSUPPLICANTSTATEDISCONNECTED: Supplicant is idle or link is down; no authentication in…
OptionalCapabilities
object
2 properties
StorageStatus
object
3 properties
EnrolledCertStatus
string
Certificate lifecycle and availability status as reported by the device. - ENROLLEDCERTSTATUSAVAILABLE: Certificate is present, valid, and usable for authentic…
NtpSources
object
1 property
IoMemberStatus
object
2 properties
ClusterNodeStatus
object
4 properties
EnrolledCertInfo
object
EnrolledCertInfo describes a certificate enrolled on the device via a network enrollment protocol such as SCEP.
13 properties
ZManufacturerInfo
object
12 properties
IoBundleStatus
object
IoBundleStatus is used to store the status of the Input Output bundle
7 properties
4 required
Entity
string
- ENTITYUNSPECIFIED: Invalid Device Entity - ENTITYBASEOS: Base OS entity - ENTITYSYSTEMADAPTER: System Adapter Entity - ENTITYVAULT: Vault Entity - ENTITYATTE…
ModemDetail
object
ModemDetail describes a cellular Modem
6 properties
CertDistinguishedName
object
CertDistinguishedName represents an X.509 distinguished name.
7 properties
DeviceSWStatus
string
SIMCard
object
SIMCard describes a SIM slot
5 properties
ECCMemoryReport
object
1 property
NetworkProvider
object
NetworkProvider describes a cellular Network Provider
5 properties
StorageSummary
object
Storage Summary
6 properties
commonNetworkConfigOrigin
string
NetworkConfigOrigin enumerates all possible origins of a network port configuration. - NETWORKCONFIGORIGINUNSPECIFIED: Unknown or unset origin. - NETWORKCONFIG…
ClusterNodeType
string
PhysicalStorageStatus
string
DeviceSWInfo
object
14 properties
CellularStatus
object
CellularStatus contains status information for a single cellular network
3 properties
PhysicalStorageTypeInfo
string
infoAPICapability
string
Capabilities indicates features in the EdgeDevConfig where there is no easy way to otherwise determine whether or not they are parsed and supported by EVE-OS A…
MetricQueryResponse
object
5 properties
ObjectType
string
DeviceHWSecurityModuleStatus
string
MetricThreshold
object
2 properties
ZCellularControlProtocol
string
DeviceError
object
DeviceError store the error occurred at the device side
5 properties
4 required
protobufAny
object
2 properties
DeviceMemorySummary
object
DeviceMemorySummary encapsulates the memory status of the device.
5 properties
DiskDescription
object
3 properties
EventQueryResponse
object
Event query response request payload
3 properties
2 required
NetProxyServer
object
Net Proxy Server
3 properties
CellularMetrics
object
CellularMetrics stores the Cellular Network Stats and Counters
11 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
PNACPortStatus
object
PNACPortStatus reports the 802.1X authentication status of a network port.
4 properties
ZsrvError
object
3 properties
HardwareInfo
object
1 property
DeviceBootReason
string
SmartAttr
object
8 properties
PhysicalStorageRaidType
string
SharedStorageSummary
object
Shared Storage Summary
4 properties
AttestState
string
StorageDeviceMetrics
object
5 properties
PhysicalStorage
object
10 properties
PNACMetricInfo
object
PNACMetricInfo reports 802.1X EAPOL frame counters for a network port.
10 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
ZcOpsType
string
Severity
string
BlobStatus
object
4 properties
ZedcloudCounters
object
ZedcloudCounters is used to store the Zedcloud Stats and Counters
5 properties
CpuSummary
object
CPU Summary
1 property
PhysicalStorageDiskState
object
3 properties
DimmRankInfo
object
3 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
DeviceStatusMsg
object
37 properties
DeviceEntity
object
3 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:…
SimcardState
string
DeviceRawMetrics
object
3 properties
commonPortConfigSource
object
PortConfigSource describes the origin of the configuration used for a network port. It helps distinguish between controller-provided, locally-modified, or init…
2 properties
NtpSourceMode
string
Enum for describing the NTP source mode, see chrony client https://gitlab.com/chrony/chrony/-/blob/master/client.c and its output of the command 'sources'.
IoAddresses
object
1 property
GPSLocation
object
9 properties
googlerpcStatus
object
3 properties
DNSInfo
object
DNSInfo is used to store Domain Name Server configuration.
3 properties
3 required
AdminState
string
- ADMINSTATECREATED: Entity Created in the controller - ADMINSTATEDELETED: Entity Deleted in the controller - ADMINSTATEACTIVE: Entity Activated in the control…
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…
DeviceStatusListMsg
object
7 properties
NetworkCounters
object
NetworkCounter is used to store the Network Stats and Counters
13 properties
DeviceStatusSummaryMsg
object
26 properties
SWState
string
- SWSTATERESOLVINGTAG: Prior to DOWNLOADSTARTED we go through these: Resolving an image tag - SWSTATERESOLVEDTAG: Tag has been resolved/failed - SWSTATECREATIN…
TagType
string
- TAGTYPEUNSPECIFIED: Unspecified - TAGTYPEGENERIC: Generic resource group - TAGTYPEPROJECT: Project resource group - TAGTYPEAZURE: Project resource group - TA…
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
#EdgeNodeStatus