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 3.2.0, at version 1.0.
Requests are made against a single base URL, /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.
LimitParams
object
3 properties
CellularAuthProtocol
string
- CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP: Password Authentication Protocol. - CELLULARAUTHPROTOCOLCHAP: Challenge-Handshake Aut…
ProbeConfig
object
Probing configuration
5 properties
SymmetricKeyEnrollmentDetail
object
3 properties
PortBasedNetworkAccessControlPolicy
object
Port based network access control policy (802.1X) to enforce on all devices of the project
5 properties
AppAccessPolicy
object
1 property
VariableGroupConditionOperator
string
EnrollmentType
string
enrollment types.
EDConfigItem
object
ED Configuration Item request payload
7 properties
DeviceSingleUseImageResp
object
Device Single-Use Image info
3 properties
EvAuthType
string
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
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…
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
DeviceImageGenerateStatus
string
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
DhcpServerConfig
object
8 properties
LispServer
object
LispServer request payload
2 properties
2 required
ZsrvResponse
object
15 properties
NetWifiConfigNetcryptoblock
object
2 properties
ObjectTag
object
Object tag deaails.
3 properties
ClusterConfig
object
1 property
protobufAny
object
2 properties
GroupCertificateEnrollment
object
1 property
NetworkProxyProto
string
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
ZsrvError
object
3 properties
AdminState
string
- ADMINSTATECREATED: Entity Created in the controller - ADMINSTATEDELETED: Entity Deleted in the controller - ADMINSTATEACTIVE: Entity Activated in the control…
IpSpec
object
11 properties
appMapParams
object
Application map parameters
1 property
1 required
ClusterType
string
EdgeviewCfg
object
7 properties
NetInstEdgeNodeCluster
object
2 properties
LispConfig
object
List Configurations.
6 properties
CustomConfigVariableGroup
object
4 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
SANValues
object
6 properties
BondAdapter
object
bondAdapter represents a single bond interface
8 properties
Interface
object
6 properties
ServicePoint
object
Service Point
3 properties
BaseOSImage
object
Base OS image request details
5 properties
4 required
SKUDetail
object
3 properties
DockerRuntimeProtocolVersion
string
ModelInfo
object
Detailed model information including id, name
4 properties
Acl
object
3 properties
DevZedServer
object
DevZedServer request payload
2 properties
2 required
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
DeviceCerts
object
Device certificates payload
2 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
vlanAdapter
object
vlanAdapter represents a single VLAN sub-interface
5 properties
VariableGroupCondition
object
3 properties
ConfigurationLockPolicy
object
Configuration lock policy to enforce on all devices of the project
2 properties
1 required
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
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
AzureResourceAndServices
object
Azure resource request payload for cloud policy
3 properties
3 required
ModelArchType
string
Details
object
Edge Application Artifact Details
8 properties
1 required
configFormat
string
MIIMonitor
object
MIIMonitor : MII link monitoring parameters. Defined for BondAdapter.
3 properties
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
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
ModuleDetail
object
Azure module specific details
4 properties
RSA
object
1 property
EnrollmentMechanism
string
attestation/mechanism supported by azure.
ObjectType
string
MetricsDetail
object
2 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
DeviceSingleUseImageDownloadLinkResp
object
2 properties
CustomConfig
object
7 properties
dhcpIpRange
object
DHCP IP range
2 properties
Author
object
5 properties
TagType
string
- TAGTYPEUNSPECIFIED: Unspecified - TAGTYPEGENERIC: Generic resource group - TAGTYPEPROJECT: Project resource group - TAGTYPEAZURE: Project resource group - TA…
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
ImageDatastore
object
2 properties
NetworkInstanceKind
string
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
AdapterUsage
string
- ADAPTERUSAGEUNSPECIFIED: Adapter unspecified - ADAPTERUSAGEMANAGEMENT: Adapter can be used by EVE as well as other Edge applications - ADAPTERUSAGEAPPDIRECT:…
NetworkDHCPType
string
PolicyType
string
type of policy.
DeviceGenerateImageType
string
NetWifiConfigSecrets
object
1 property
ProjectInfo
object
Detailed project information including id, name
3 properties
ZcOpsType
string
NetCellularAccessPoint
object
16 properties
EdgeSyncConfig
object
2 properties
AppCategory
string
- APPCATEGORYUNSPECIFIED: Invalid Edge Application Category - APPCATEGORYOPERATINGSYSTEM: Edge operating systems - APPCATEGORYINDUSTRIAL: Connectity solution f…
AppType
string
type of app bundle.
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
IotHubServiceDetail
object
1 property
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
Subject
object
8 properties
AttestPolicyType
string
- ATTESTPOLICYTYPEACCEPT: Do not enforce attestation. All devices are marked as successfully attested. - ATTESTPOLICYTYPEENFORCE: Enforce attestation. Devices…
AttestationPolicy
object
Attestation policy to enforce on all devices of the project
2 properties
1 required
StaticIPRoute
object
Static IP Routes
4 properties
VMManifest
object
26 properties
NetInstOpaqueConfig
object
Network Instance Opaque config. This is service specific configuration.
3 properties
LocalOperatorConsolePolicy
object
Local operator console policy to enforce on all devices of the project
3 properties
1 required
MapParams
object
1 property
BondMode
string
A bonding mode specifies the policy indicating how bonding slaves are used during network transmission. - BONDMODEUNSPECIFIED: BONDMODEUNSPECIFIED : if bonding…
NetworkKind
string
PCRPolicy
object
PCR policy for TPM key sealing on devices
3 properties
1 required
DeviceConfigList
object
Device configuration request payload
4 properties
3 required
ContainerDetail
object
common container detail.
1 property
NetWirelessConfig
object
3 properties
EAPMethod
string
DeviceLBConfig
object
3 properties
ECDSA
object
1 property
EnrollmentDetail
object
8 properties
IndividualCertificateEnrollment
object
Permission
object
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
VariableOptionVal
object
2 properties
DeviceConfig
object
Device Configuration request payload holds the device properties
53 properties
4 required
googlerpcStatus
object
3 properties
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
PolicyStatus
string
policy status.
DeviceGenerateImageArchVariant
string
phyAdapter
object
Physical Adapter
3 properties
DeviceLisp
object
DeviceLisp request payload
9 properties
9 required
ArpMonitor
object
ArpMonitor : ARP-based link monitoring parameters. Defined for BondAdapter.
2 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…
DevAccessPolicy
object
1 property
VMManifestImage
object
15 properties
ResourceGroupDetail
object
Resource group request payload for cloud policy
3 properties
2 required
DeploymentType
string
AclAction
object
8 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:…
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
DeviceConfigLock
string
NetCellularAccessPointSecrets
object
2 properties
Certificate
object
21 properties
AppNamingScheme
string
type of name aliasing.
CertificateEnrollmentDetail
object
3 properties
NetProjectInfo
object
2 properties
ModuleType
string
module type.
NtpServer
object
NTP Server
1 property
DPSServiceDetail
object
2 properties
NetCellularConfig
object
5 properties
NetworkWiFiKeyScheme
string
OpaqueConfigType
string
DeviceConfigSummary
object
Device Configuration request payload holds the device properties
18 properties
4 required
DebugKnobDetail
object
Device debug knob configuration request payload holds the device debug mode properties
4 properties
UserDataTemplate
object
1 property
NetProxyConfig
object
Net Proxy Configurations
6 properties
ConfigurationLock
string
DockerRuntimeVersion
string
Summary
object
Summary is used to store the Summary details
3 properties
spType
string
clone of types defined in API repo. - SPTYPEMAPSERVER: mapping service for zededa overlay service - SPTYPESUPPORTSERVER: if device has support feature enabled,…
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties
1 required
EIDRegister
object
EID Register
10 properties
10 required
TPMEnrollmentDetail
object
1 property
IndividualSymmetricKeyEnrollment
object
1 property
appACE
object
App ACE Configuration
4 properties
4 required
AzureResourceAndServiceDetail
object
6 properties
SysInterface
object
system interfaces that needs to be used by dom0
14 properties
NetProxyServer
object
Net Proxy Server
3 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties
5 required
JWTInfo
object
6 properties
Match
object
2 properties
appACEMatch
object
App ACE Match
2 properties
2 required
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
commonCipherBlock
object
4 properties
NetworkWirelessType
string
GroupSymmetricKeyEnrollment
object
1 property
Resource
object
2 properties
ExtAccessPolicy
object
1 property
ClusterPolicy
object
cluster policy to bring up cluster on devices in this project
4 properties
3 required
Param
object
2 properties
EdgeviewPolicy
object
Policy for device edgeview operation
6 properties
1 required
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
DeviceLBConfigList
object
1 property
StaticDNSList
object
Static DNS list
2 properties
appACEAction
object
App ACE actions
7 properties
7 required
evecommonCellularAuthProtocol
string
CellularAuthProtocol defines the authentication protocol used for cellular connection. - CELLULARAUTHPROTOCOLNONE: No authentication. - CELLULARAUTHPROTOCOLPAP…
evecommonRadioAccessTechnology
string
- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…
appInterface
object
App Interface detail
16 properties
1 required
NetWifiConfig
object
8 properties
NetworkInstanceDhcpType
string
EdgeNodeClusterConfig
object
13 properties
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 ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
Zededa EdgeDiagnostics API
#EdgeNodeConfiguration
Where this information came from
This is an independent, third-party profile of Zededa EdgeNodeConfiguration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.