Zededa EdgeApplicationConfiguration API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EdgeApplicationConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
11 operations
across 8 paths,
and defines 55 schemas.
It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
11 operations8 paths55 schemas1 DELETE8 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Zededa EdgeApplicationConfiguration 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 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are VMManifest (26 properties), App_HttpRequest (18 properties), App (18 properties), AppSummary (15 properties). Each schema is shown below with its type and property counts.
ZcOpsType
string
ObjectType
string
Summary
object
Summary is used to store the Summary details
3 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
AppPublicApps
object
6 properties
VariableGroupCondition
object
3 properties
Interface
object
6 properties
VMManifest
object
26 properties
AclAction
object
8 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
Apps
object
6 properties
App
object
Edge application gets installed/uninstalled to/from edge node(s) and perform specific edge computing tasks. Lifecycle of Edge application (upgrade/restart) on…
18 properties3 required
ModuleDetail
object
Azure module specific details
4 properties
protobufAny
object
2 properties
ObjectDetail
object
2 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
AppSummary
object
Edge application summary
15 properties1 required
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties5 required
VMManifestSummary
object
9 properties
App_HttpRequest
object
Edge application gets installed/uninstalled to/from edge node(s) and perform specific edge computing tasks. Lifecycle of Edge application (upgrade/restart) on…
18 properties4 required
LimitParams
object
3 properties
MapParams
object
1 property
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
VariableGroupConditionOperator
string
configFormat
string
AppType
string
type of app bundle.
ModuleType
string
module type.
DeploymentType
string
ContainerDetail
object
common container detail.
1 property
Match
object
2 properties
DockerRuntimeProtocolVersion
string
googlerpcStatus
object
3 properties
Permission
object
Acl
object
3 properties
ZsrvError
object
3 properties
AppProjectList
object
3 properties
Details
object
Edge Application Artifact Details
8 properties1 required
ModuleSummary
object
Azure module specific details
1 property
ImageDatastore
object
2 properties
VariableGroupVariable
object
Edge Application Artifact Details
11 properties4 required
CustomConfig
object
7 properties
CustomConfigVariableGroup
object
4 properties
VMManifestImage
object
15 properties
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…
Author
object
5 properties
ObjectParentDetail
object
ObjectImportDetail consists of various object attributes like idOfParentObject, versionOfParentObject, updateAvailable, referenceExists
4 properties1 required
DockerRuntimeVersion
string
VariableOptionVal
object
2 properties
Param
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
