Zededa EdgeNodeConfiguration API
The EdgeNodeConfiguration API from Zededa — 23 operation(s) for edgenodeconfiguration.
Zededa EdgeNodeConfiguration API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EdgeNodeConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 27 operations across 23 paths, and defines 180 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
27 operations
23 paths
180 schemas
1 DELETE10 GET2 POST14 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa EdgeNodeConfiguration 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 27
Across 23 paths, the API surfaces 27 operations — 1 DELETE, 10 GET, 2 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.
EdgeNodeConfiguration 27
GET
/v1/devices
Query edge nodes
POST
/v1/devices
Create edge node
GET
/v1/devices/id/{id}
Get edge node
DELETE
/v1/devices/id/{id}
Delete edge node
PUT
/v1/devices/id/{id}
Update edge node
PUT
/v1/devices/id/{id}/activate
Activate edge node.
PUT
/v1/devices/id/{id}/apply
update EVE image on edge node
GET
/v1/devices/id/{id}/attestation
Get edge node PCR attestation
PUT
/v1/devices/id/{id}/baseos/upgrade/retry
Retry baseos upgrade on the edge node.
PUT
/v1/devices/id/{id}/deactivate
Deactivate edge node.
PUT
/v1/devices/id/{id}/debug/disable
Stop debug mode on the edge node.
PUT
/v1/devices/id/{id}/debug/enable
Start debug mode on the edge node.
GET
/v1/devices/id/{id}/edgeview/clientscript
Get edgeview client script of the edge node.
PUT
/v1/devices/id/{id}/edgeview/disable
Stop edgeview on the edge node.
PUT
/v1/devices/id/{id}/edgeview/enable
Start edgeview on the edge node.
PUT
/v1/devices/id/{id}/offboard
Offoard the edge-ndoe
GET
/v1/devices/id/{id}/onboarding
Get edge node onboarding certificate
PUT
/v1/devices/id/{id}/preparepoweroff
Shutdown applications on edge node.
PUT
/v1/devices/id/{id}/publish
update EVE image on edge node
PUT
/v1/devices/id/{id}/reboot
Reboot edge node.
GET
/v1/devices/id/{id}/suimage
Get edge node single-use EVE image details
POST
/v1/devices/id/{id}/suimage
Create edge node single-use EVE image
GET
/v1/devices/id/{id}/suimage/link
Get edge node single-use EVE image download link
PUT
/v1/devices/id/{id}/unpublish
update EVE image on edge node
GET
/v1/devices/interfaces/tags
Query device interface tags
GET
/v1/devices/name/{name}
Get edge node by name
GET
/v1/devices/serial/{serialno}
Get edge node by serial number
Schemas 180
The contract defines 180 schemas that model the data the API accepts and returns. The most detailed are DeviceConfig (53 properties), NetInstConfig (26 properties), VMManifest (26 properties), Certificate (21 properties). Each schema is shown below with its type and property counts.
appACEMatch
object
App ACE Match
2 properties
2 required
DevAccessPolicy
object
1 property
NtpServer
object
NTP Server
1 property
EAPMethod
string
DebugKnobDetail
object
Device debug knob configuration request payload holds the device debug mode properties
4 properties
Summary
object
Summary is used to store the Summary details
3 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
vlanAdapter
object
vlanAdapter represents a single VLAN sub-interface
5 properties
DeviceGenerateImageType
string
Subject
object
8 properties
Interface
object
6 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:…
NetworkInstanceDhcpType
string
ModulePolicy
object
list of modules that will be provisioned on all the devices of the project to which this policy is attached
11 properties
2 required
EdgeviewPolicy
object
Policy for device edgeview operation
6 properties
1 required
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
NetCellularAccessPoint
object
16 properties
ServicePoint
object
Service Point
3 properties
StaticDNSList
object
Static DNS list
2 properties
NetInstConfig
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
26 properties
5 required
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
SANValues
object
6 properties
NetWifiConfigSecrets
object
1 property
AppType
string
type of app bundle.
EnrollmentType
string
enrollment types.
DeploymentType
string
DeviceConfigList
object
Device configuration request payload
4 properties
3 required
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
MIIMonitor
object
MIIMonitor : MII link monitoring parameters. Defined for BondAdapter.
3 properties
NetworkPolicy
object
list of networks that will be created on all the devices of the project to which this policy is attached
1 property
1 required
AttestPolicyType
string
- ATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - ATTESTPOLICYTYPEENFORCE: Enforce attestation. Devices…
ConfigurationLockPolicy
object
Configuration lock policy to enforce on all devices of the project
2 properties
1 required
ProjectInfo
object
Detailed project information including id, name
3 properties
GroupCertificateEnrollment
object
1 property
NetworkInstanceKind
string
NetProxyConfig
object
Net Proxy Configurations
6 properties
ObjectTag
object
Object tag deaails.
3 properties
Author
object
5 properties
DockerRuntimeVersion
string
DeviceConfigSummary
object
Device Configuration request payload holds the device properties
18 properties
4 required
ResourceGroupDetail
object
Resource group request payload for cloud policy
3 properties
2 required
MetricsDetail
object
2 properties
EdgeSyncConfig
object
2 properties
ExtAccessPolicy
object
1 property
AllocationPolicy
string
Iot hub allocation policy.
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
EnrollmentDetail
object
8 properties
EdgeNodeClusterConfig
object
13 properties
PolicyStatus
string
policy status.
DeviceImageGenerateStatus
string
LispConfig
object
List Configurations.
6 properties
VariableGroupCondition
object
3 properties
DeviceSingleUseImageDownloadLinkResp
object
2 properties
Certificate
object
21 properties
AttestationPolicy
object
Attestation policy to enforce on all devices of the project
2 properties
1 required
OpaqueConfigType
string
AzureResourceAndServices
object
Azure resource request payload for cloud policy
3 properties
3 required
BaseOSImage
object
Base OS image request details
5 properties
4 required
PCRPolicy
object
PCR policy for TPM key sealing on devices
3 properties
1 required
appInterface
object
App Interface detail
16 properties
1 required
MapParams
object
1 property
AppCategory
string
- APPCATEGORYUNSPECIFIED: Invalid Edge Application Category - APPCATEGORYOPERATINGSYSTEM: Edge operating systems - APPCATEGORYINDUSTRIAL: Connectity solution f…
ModuleType
string
module type.
DockerRuntimeProtocolVersion
string
NetworkWiFiKeyScheme
string
Details
object
Edge Application Artifact Details
8 properties
1 required
PortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on all devices of the project
5 properties
DhcpServerConfig
object
8 properties
DeviceConfig
object
Device Configuration request payload holds the device properties
53 properties
4 required
DeviceSingleUseImageResp
object
Device Single-Use Image info
3 properties
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties
1 required
RSA
object
1 property
appACE
object
App ACE Configuration
4 properties
4 required
Param
object
2 properties
DeviceGenerateImageArchVariant
string
ProbeConfig
object
Probing configuration
5 properties
NetworkWirelessType
string
ObjectType
string
IndividualCertificateEnrollment
object
AppPolicy
object
list of apps that will be provisioned on all the devices of the project to which this policy is attached
1 property
1 required
DPSServiceDetail
object
2 properties
NetCellularAccessPointSecrets
object
2 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
commonCipherBlock
object
4 properties
VMManifest
object
26 properties
NetWifiConfigNetcryptoblock
object
2 properties
NetProjectInfo
object
2 properties
DeviceLBConfigList
object
1 property
GroupSymmetricKeyEnrollment
object
1 property
protobufAny
object
2 properties
ModelInfo
object
Detailed model information including id, name
4 properties
BondMode
string
A bonding mode specifies the policy indicating how bonding slaves are used during network transmission. - BONDMODEUNSPECIFIED: BONDMODEUNSPECIFIED : if bonding…
BondAdapter
object
bondAdapter represents a single bond interface
8 properties
ClusterPolicy
object
cluster policy to bring up cluster on devices in this project
4 properties
3 required
NetProxyServer
object
Net Proxy Server
3 properties
NetWifiConfig
object
8 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
configFormat
string
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
NetInstOpaqueConfig
object
Network Instance Opaque config. This is service specific configuration.
3 properties
SysInterface
object
system interfaces that needs to be used by dom0
14 properties
StaticIPRoute
object
Static IP Routes
4 properties
ZsrvError
object
3 properties
Match
object
2 properties
Permission
object
Acl
object
3 properties
CellularAuthProtocol
string
- CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP: Password Authentication Protocol. - CELLULARAUTHPROTOCOLCHAP: Challenge-Handshake Aut…
LispServer
object
LispServer request payload
2 properties
2 required
SKUDetail
object
3 properties
ConfigurationLock
string
ImageDatastore
object
2 properties
DevZedServer
object
DevZedServer request payload
2 properties
2 required
CustomConfig
object
7 properties
VMManifestImage
object
15 properties
ModelArchType
string
ArpMonitor
object
ArpMonitor : ARP-based link monitoring parameters. Defined for BondAdapter.
2 properties
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
EDConfigItem
object
ED Configuration Item request payload
7 properties
ClusterConfig
object
1 property
LacpRate
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…
AzureResourceAndServiceDetail
object
6 properties
EvAuthType
string
phyAdapter
object
Physical Adapter
3 properties
DeviceConfigLock
string
ZcOpsType
string
EnrollmentMechanism
string
attestation/mechanism supported by azure.
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…
AclAction
object
8 properties
JWTInfo
object
6 properties
dhcpIpRange
object
DHCP IP range
2 properties
ModuleDetail
object
Azure module specific details
4 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
EIDRegister
object
EID Register
10 properties
10 required
spType
string
clone of types defined in API repo. - SPTYPEMAPSERVER: mapping service for zededa overlay service - SPTYPESUPPORTSERVER: if device has support feature enabled,…
IotHubServiceDetail
object
1 property
AppNamingScheme
string
type of name aliasing.
DeviceCerts
object
Device certificates payload
2 properties
PolicyType
string
type of policy.
ClusterType
string
LimitParams
object
3 properties
SymmetricKeyEnrollmentDetail
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:…
UserDataTemplate
object
1 property
VariableGroupConditionOperator
string
AzurePolicy
object
All azure policy related details that are required to provision an iot edge device and deploy a module on that.
8 properties
3 required
ECDSA
object
1 property
NetInstEdgeNodeCluster
object
2 properties
ContainerDetail
object
common container detail.
1 property
LocalOperatorConsolePolicy
object
Local operator console policy to enforce on all devices of the project
3 properties
1 required
TPMEnrollmentDetail
object
1 property
googlerpcStatus
object
3 properties
AppConfig
object
Edge application configuration for an App policy defines configuration details of the Edge application to be installed to all Edge node(s) under the App policy.
20 properties
8 required
appMapParams
object
Application map parameters
1 property
1 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
EdgeviewCfg
object
7 properties
appACEAction
object
App ACE actions
7 properties
7 required
CertificateEnrollmentDetail
object
3 properties
NetworkKind
string
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
DeviceLBConfig
object
3 properties
AdminState
string
- ADMINSTATECREATED: Entity Created in the controller - ADMINSTATEDELETED: Entity Deleted in the controller - ADMINSTATEACTIVE: Entity Activated in the control…
CustomConfigVariableGroup
object
4 properties
IndividualSymmetricKeyEnrollment
object
1 property
Resource
object
2 properties
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…
PolicyConfig
object
Policy configuration defines set of policies to be applied on a resource grup (project). Policy can be one of the types specified in PolicyType. Multiple polic…
20 properties
3 required
NetWirelessConfig
object
3 properties
DeviceLisp
object
DeviceLisp request payload
9 properties
9 required
AppAccessPolicy
object
1 property
VariableOptionVal
object
2 properties
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
#EdgeNodeConfiguration