Zededa EdgeApplicationInstanceStatus API
The EdgeApplicationInstanceStatus API from Zededa — 35 operation(s) for edgeapplicationinstancestatus.
Zededa EdgeApplicationInstanceStatus API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include EdgeApplicationInstanceStatus. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 36 operations across 35 paths, and defines 117 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
36 operations
35 paths
117 schemas
1 DELETE35 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa EdgeApplicationInstanceStatus 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 36
Across 35 paths, the API surfaces 36 operations — 1 DELETE, 35 GET. Each is listed below with its method, path, parameters, and response codes.
EdgeApplicationInstanceStatus 36
GET
/v1/apps/instances/id/{appInstanceId}/snapshot/name/{name}
Query Application instance snapshot
DELETE
/v1/apps/instances/id/{appInstanceId}/snapshot/name/{name}
Delete Application instance snapshot
GET
/v1/apps/instances/id/{id}/flowlog/classification
Get edge application instance network traffic flow log
GET
/v1/apps/instances/id/{id}/flowlog/toptalkers
Get edge application instance top talkers of the network traffic flows
GET
/v1/apps/instances/id/{id}/logs
Get edge application instance log
GET
/v1/apps/instances/id/{id}/opaque-status
Get patch envelope opaque status as base64 encoded string
GET
/v1/apps/instances/id/{id}/snapshots
Query Application instance snapshots
GET
/v1/apps/instances/id/{id}/status
Get edge application instance status
GET
/v1/apps/instances/id/{objid}/events
Get edge application instance events by id
GET
/v1/apps/instances/id/{objid}/timeSeries/{mType}
Get edge application instance resource usage timeline
GET
/v1/apps/instances/name/{name}/flowlog/classification
Get edge application instance network traffic flow log
GET
/v1/apps/instances/name/{name}/flowlog/toptalkers
Get edge application instance top talkers of the network traffic flows
GET
/v1/apps/instances/name/{name}/opaque-status
Get patch envelope opaque status as base64 encoded string
GET
/v1/apps/instances/name/{name}/status
Get edge application instance status
GET
/v1/apps/instances/name/{objname}/events
Get edge application instance events by name
GET
/v1/apps/instances/name/{objname}/timeSeries/{mType}
Get edge application instance resource usage timeline
GET
/v1/apps/instances/snapshot/id/{id}
Query Application instance snapshot
GET
/v1/apps/instances/snapshot/id/{id}/state
Query Application instance snapshot state
GET
/v1/apps/instances/status
Query status of edge application instances
GET
/v1/apps/instances/status-config
Query status and config of edge application instances
GET
/v1/apps/instances/tags
Query Application instance tags
GET
/v2/apps/instances/id/{id}/flowlog/classification
Get edge application instance network traffic flow log
GET
/v2/apps/instances/id/{id}/flowlog/toptalkers
Get edge application instance top talkers of the network traffic flows
GET
/v2/apps/instances/id/{id}/logs
Get edge application instance log
GET
/v2/apps/instances/id/{id}/opaque-status
Get patch envelope opaque status as base64 encoded string
GET
/v2/apps/instances/id/{id}/status
Get edge application instance status
GET
/v2/apps/instances/id/{objid}/events
Get edge application instance events by id
GET
/v2/apps/instances/id/{objid}/timeSeries/{mType}
Get edge application instance resource usage timeline
GET
/v2/apps/instances/name/{name}/flowlog/classification
Get edge application instance network traffic flow log
GET
/v2/apps/instances/name/{name}/flowlog/toptalkers
Get edge application instance top talkers of the network traffic flows
GET
/v2/apps/instances/name/{name}/opaque-status
Get patch envelope opaque status as base64 encoded string
GET
/v2/apps/instances/name/{name}/status
Get edge application instance status
GET
/v2/apps/instances/name/{objname}/events
Get edge application instance events by name
GET
/v2/apps/instances/name/{objname}/timeSeries/{mType}
Get edge application instance resource usage timeline
GET
/v2/apps/instances/status
Query status of edge application instances
GET
/v2/apps/instances/status-config
Query status and config of edge application instances
Schemas 117
The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are AppInstance (43 properties), AppInstStatusMsg (33 properties), VCEStatusDetail (26 properties), appInstConfigStatus (24 properties). Each schema is shown below with its type and property counts.
appACEMatch
object
App ACE Match
2 properties
2 required
VCEStatus
object
status of object on velocloud.
1 property
Summary
object
Summary is used to store the Summary details
3 properties
NetworkStatus
object
NetworkStatus is used to store the Network status
14 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
ZCellularOperatingState
string
NetworkProxyProto
string
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
TopTalkersResponseItem
object
8 properties
MetricQueryResponseItem
object
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
NetProxyStatus
object
NetProxyStatus is used to store the proxy configurations
6 properties
AppInstConfigStatusList
object
AppInstConfigStatusList is used for listing the app instance statuses
6 properties
RadioAccessTechnology
string
- RADIOACCESSTECHNOLOGYGSM: Global System for Mobile Communications (2G). - RADIOACCESSTECHNOLOGYUMTS: Universal Mobile Telecommunications System (3G). - RADIO…
VCEStatusDetail
object
26 properties
LTEAdapter
object
Details of LTE Adapter
7 properties
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
AppType
string
type of app bundle.
DeploymentType
string
AppInstanceSnapshotState
object
2 properties
ClassificationResponse
object
1 property
SWInfo
object
Software Information
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…
TransDetails
object
3 properties
SnapshotState
string
ObjectTag
object
Object tag deaails.
3 properties
IoMemberStatus
object
2 properties
IoBundleStatus
object
IoBundleStatus is used to store the status of the Input Output bundle
7 properties
4 required
VariableGroupCondition
object
3 properties
PatchEnvelopeUsageInfo
object
4 properties
AppInstStatusSummaryMsg
object
AppInstStatusSummaryMsg stores the summary of the app instance status
22 properties
AppInstEdgeNodeCluster
object
3 properties
AppInfo
object
2 properties
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
AzureDevStatusDetail
object
6 properties
ComposeContainerStatus
object
8 properties
SIMCard
object
SIMCard describes a SIM slot
5 properties
AppInstanceLogs
object
App Instance Logs configuration
1 property
1 required
appInterface
object
App Interface detail
16 properties
1 required
vm
object
Virtual machine memory configuration
10 properties
4 required
NetworkProvider
object
NetworkProvider describes a cellular Network Provider
5 properties
AppInstanceLogsQueryResponse
object
AppInstanceLogsQueryResponse is used as response for querying app instance logs
3 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…
ActionScope
object
2 properties
appInstConfigStatus
object
appInstConfigStatus stores the summary of the app instance config status
24 properties
CellularStatus
object
CellularStatus contains status information for a single cellular network
3 properties
AppInstSnapshotsList
object
1 property
appACE
object
App ACE Configuration
4 properties
4 required
RuntimePlatformVersions
object
5 properties
MetricQueryResponse
object
5 properties
ObjectType
string
MetricThreshold
object
2 properties
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
AppInstanceLogsQueryResponseItem
object
AppInstanceLogsQueryResponseItem is used as the response for querying the logs of app instance
3 properties
DevInfo
object
3 properties
ZCellularControlProtocol
string
DeviceError
object
DeviceError store the error occurred at the device side
5 properties
4 required
protobufAny
object
2 properties
AppInstStatusMsg
object
AppInstanceStatusMsg encapsulates the status of an app instance
33 properties
AzureStatus
object
status of device from azure.
1 property
TwinDetail
object
9 properties
EventQueryResponse
object
Event query response request payload
3 properties
2 required
NetProxyServer
object
Net Proxy Server
3 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
AppInstStatusListMsg
object
AppInstStatusListMsg is used for listing the app instance statuses
5 properties
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
TransCause
string
ZsrvError
object
3 properties
AppInstanceSnapshot
object
App instance snapshot
6 properties
1 required
AppInstance
object
App Instance detail
43 properties
6 required
LispServer
object
LispServer request payload
2 properties
2 required
drive
object
Drive configuration
13 properties
6 required
SharedStorageSummary
object
Shared Storage Summary
4 properties
CustomConfig
object
7 properties
StorageDeviceMetrics
object
5 properties
ContainerPortMap
object
5 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
VmBootloaderMode
string
phyAdapter
object
Physical Adapter
3 properties
ZcOpsType
string
Severity
string
AppInstMemorySummary
object
Memory Information for the App Instance.
3 properties
CpuSummary
object
CPU Summary
1 property
ControllerType
string
third party controller types.
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
AppInstanceLogsResponse
object
2 properties
ManifestInfo
object
Details about transition parameters and indication for cause of the transition and recommendation for the transition action
6 properties
ClassificationItem
object
4 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
VariableGroupConditionOperator
string
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
hvMode
string
For now we need to tell the device which virtualization mode to use. Later we might use a single one for all VMs (on any particular ISA). If we end up keeping…
GPSLocation
object
9 properties
googlerpcStatus
object
3 properties
IoAddresses
object
1 property
DNSInfo
object
DNSInfo is used to store Domain Name Server configuration.
3 properties
3 required
appMapParams
object
Application map parameters
1 property
1 required
TopTalkersResponse
object
2 properties
appACEAction
object
App ACE actions
7 properties
7 required
AdminState
string
- ADMINSTATECREATED: Entity Created in the controller - ADMINSTATEDELETED: Entity Deleted in the controller - ADMINSTATEACTIVE: Entity Activated in the control…
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
CustomConfigVariableGroup
object
4 properties
InstanceTransitionAction
string
- INSTANCETAUNSPECIFIED: Default. Invalid option - INSTANCETANONE: Either Edge app bundle has not changed or Edge app bundle has changed but the changes do not…
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…
OpaqueAppInstanceStatus
object
Opaque Status for the app instance.
5 properties
NetworkCounters
object
NetworkCounter is used to store the Network Stats and Counters
13 properties
VariableOptionVal
object
2 properties
SWState
string
- SWSTATERESOLVINGTAG: Prior to DOWNLOADSTARTED we go through these: Resolving an image tag - SWSTATERESOLVEDTAG: Tag has been resolved/failed - SWSTATECREATIN…
AppStatusFromTPController
object
7 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 ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeDiagnostics API
#EdgeApplicationInstanceStatus