Zededa HardwareModel API
The HardwareModel API from Zededa — 20 operation(s) for hardwaremodel.
Zededa HardwareModel API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include HardwareModel. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 28 operations across 20 paths, and defines 79 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
28 operations
20 paths
79 schemas
3 DELETE18 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa HardwareModel 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 28
Across 20 paths, the API surfaces 28 operations — 3 DELETE, 18 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
HardwareModel 28
GET
/v1/brands
Query hardware brands
POST
/v1/brands
Create hardware brand
GET
/v1/brands/global
Query global hardware brands
GET
/v1/brands/global/id/{id}
Get global hardware brand
GET
/v1/brands/global/name/{name}
Get global hardware brand
GET
/v1/brands/id/{id}
Get hardware brand
DELETE
/v1/brands/id/{id}
Delete hardware brand
PUT
/v1/brands/id/{id}
Update hardware brand
GET
/v1/brands/name/{name}
Get hardware brand
GET
/v1/devices/status-config
Query device status and config
GET
/v1/devices/status/locations
Query device status location
GET
/v1/devices/tags
Query device object tag key-values
PUT
/v1/pcrtemplate/id/{id}
Update pcr template
GET
/v1/pcrtemplates/id/{id}
Query pcr template
DELETE
/v1/pcrtemplates/id/{id}
Delete pcr template
GET
/v1/sysmodels
Query hardware models
POST
/v1/sysmodels
Create hardware model
GET
/v1/sysmodels/global
Query global hardware models
GET
/v1/sysmodels/global/id/{id}
Get global hardware model
GET
/v1/sysmodels/global/name/{name}
Get global hardware model
GET
/v1/sysmodels/id/{id}
Get hardware model
DELETE
/v1/sysmodels/id/{id}
Delete hardware model
PUT
/v1/sysmodels/id/{id}
Update hardware model
PUT
/v1/sysmodels/id/{id}/import
Import hardware model to local enterprise if it is not already imported and return imported model information.
GET
/v1/sysmodels/id/{id}/pcrtemplates
Query pcr templates
POST
/v1/sysmodels/id/{id}/pcrtemplates
Create pcr templates
GET
/v1/sysmodels/id/{modelId}/pcrtemplates/name/{name}
Query pcr template
GET
/v1/sysmodels/name/{name}
Get hardware model
Schemas 79
The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are deviceStatusConfig (19 properties), SysModel (18 properties), NetCellularAccessPoint (16 properties), ZsrvResponse (15 properties). Each schema is shown below with its type and property counts.
NtpServer
object
NTP Server
1 property
Summary
object
Summary is used to store the Summary details
3 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
NetworkDHCPType
string
NetworkProxyProto
string
AdapterUsage
string
- ADAPTERUSAGEUNSPECIFIED: Adapter unspecified - ADAPTERUSAGEMANAGEMENT: Adapter can be used by EVE as well as other Edge applications - ADAPTERUSAGEAPPDIRECT:…
PCRTemplatesInfo
object
List of PCR templates associated with some System Model.
2 properties
SysBrands
object
SysBrands used when listing the available brands, if consists of various brand attributes like terse, model list and next filter.
3 properties
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
NetCellularAccessPoint
object
16 properties
PCRValue
object
PCR value contains the actual value of the specified PCR type
3 properties
3 required
StaticDNSList
object
Static DNS list
2 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties
5 required
NetCellularConfig
object
5 properties
DeviceSWSubStatus
string
NetWifiConfigSecrets
object
1 property
DeviceInfo
object
6 properties
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
IpSpec
object
11 properties
NetProxyConfig
object
Net Proxy Configurations
6 properties
ObjectTag
object
Object tag deaails.
3 properties
EnrolledCertStatus
string
Certificate lifecycle and availability status as reported by the device. - ENROLLEDCERTSTATUSAVAILABLE: Certificate is present, valid, and usable for authentic…
SysModel
object
SysModel consists of various model attributes like id, name, title, brandId etc
18 properties
7 required
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
SysBrand
object
SysModel consists of various brand attributes like id, name, title, svg, state, systemMfgName
11 properties
3 required
PCRType
string
ClusterNodeStatus
object
4 properties
Entity
string
- ENTITYUNSPECIFIED: Invalid Device Entity - ENTITYBASEOS: Base OS entity - ENTITYSYSTEMADAPTER: System Adapter Entity - ENTITYVAULT: Vault Entity - ENTITYATTE…
DeviceSWStatus
string
DeviceLocation
object
2 properties
NetworkWiFiKeyScheme
string
ClusterNodeType
string
DeviceSWInfo
object
14 properties
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties
1 required
NetworkWirelessType
string
ObjectType
string
deviceStatusConfig
object
Device status and config response details
19 properties
3 required
NetCellularAccessPointSecrets
object
2 properties
commonCipherBlock
object
4 properties
DeviceError
object
DeviceError store the error occurred at the device side
5 properties
4 required
NetWifiConfigNetcryptoblock
object
2 properties
NetProjectInfo
object
2 properties
protobufAny
object
2 properties
NetProxyServer
object
Net Proxy Server
3 properties
NetWifiConfig
object
8 properties
SysModels
object
SysModels used when listing the available models, if consists of various model attributes like terse, model list and next filter.
5 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
SysInterface
object
system interfaces that needs to be used by dom0
14 properties
ZsrvError
object
3 properties
CellularAuthProtocol
string
- CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP: Password Authentication Protocol. - CELLULARAUTHPROTOCOLCHAP: Challenge-Handshake Aut…
PCRTemplate
object
PCR template data for the specified eve version and firmware version
5 properties
2 required
ModelArchType
string
evecommonCellularAuthProtocol
string
CellularAuthProtocol defines the authentication protocol used for cellular connection. - CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP…
NetConfig
object
Network provides Edge nodes a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communi…
14 properties
5 required
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
PCRTemplatesReq
object
Request that contains a model id and pcr templates, which can be associated with the model.
2 properties
ZcOpsType
string
Severity
string
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…
SysModelState
string
- SYSMODELSTATEUNSPECIFIED: default options, which says no Operation/Invalid Operation - SYSMODELSTATEARCHIVE: Archived sysModel State - SYSMODELSTATEACTIVE: A…
dhcpIpRange
object
DHCP IP range
2 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
ioMember
object
ioMember consists of list of various networking attributes like physical label, physical address etc associated with SysModel
11 properties
6 required
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:…
googlerpcStatus
object
3 properties
Vfs
object
1 property
DeviceStatusConfigList
object
Device statu sna config composite api response details
7 properties
5 required
evecommonRadioAccessTechnology
string
- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
NetworkKind
string
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…
NetWirelessConfig
object
3 properties
DeviceLocations
object
2 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
#HardwareModel