Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zededa

Zededa EdgeApplicationInstanceConfiguration API

The EdgeApplicationInstanceConfiguration API from Zededa — 20 operation(s) for edgeapplicationinstanceconfiguration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zededa EdgeApplicationInstanceConfiguration API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EdgeApplicationInstanceConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 20 paths, and defines 48 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://zedcontrol.zededa.net/api.

26 operations 20 paths 48 schemas 2 DELETE6 GET4 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://zedcontrol.zededa.net/api
Authentication
API Key
Contact
ZEDEDA API Support
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Zededa EdgeApplicationInstanceConfiguration 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 26

Across 20 paths, the API surfaces 26 operations — 2 DELETE, 6 GET, 4 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

EdgeApplicationInstanceConfiguration 26
GET
/v1/apps/instances
Query edge application instances
EdgeApplicationInstanceConfiguration_QueryEdgeApplicationInstances 16 params → 200400401403500504default
POST
/v1/apps/instances
Create edge application instance
EdgeApplicationInstanceConfiguration_CreateEdgeApplicationInstance 2 params → 200400401403409500504default
GET
/v1/apps/instances/id/{id}
Get edge application instance
EdgeApplicationInstanceConfiguration_GetEdgeApplicationInstance 2 params → 200401403404500504default
DELETE
/v1/apps/instances/id/{id}
Delete edge application instance
EdgeApplicationInstanceConfiguration_DeleteEdgeApplicationInstance 2 params → 200401403404500504default
PUT
/v1/apps/instances/id/{id}
Update edge application instance
EdgeApplicationInstanceConfiguration_UpdateEdgeApplicationInstance 3 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/activate
Activate edge application instance
EdgeApplicationInstanceConfiguration_ActivateEdgeApplicationInstance 2 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/console/remote
Connect to edge application instance console
EdgeApplicationInstanceConfiguration_ConnectToEdgeApplicationInstance 2 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/deactivate
Deactivate edge application instance
EdgeApplicationInstanceConfiguration_DeActivateEdgeApplicationInstance 2 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/refresh
Refresh edge application instance
EdgeApplicationInstanceConfiguration_RefreshEdgeApplicationInstance 2 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/refresh/purge
Refresh and purge edge application instance
EdgeApplicationInstanceConfiguration_RefreshPurgeEdgeApplicationInstance 2 params → 200401403404409500504default
PUT
/v1/apps/instances/id/{id}/restart
Restart edge application instance
EdgeApplicationInstanceConfiguration_RestartEdgeApplicationInstance 2 params → 200401403404409500504default
GET
/v1/apps/instances/name/{name}
Get edge application instance
EdgeApplicationInstanceConfiguration_GetEdgeApplicationInstanceByName 2 params → 200401403404500504default
POST
/v1/apps/instances/patch-reference-update
Patch envelope reference update
EdgeApplicationInstanceConfiguration_UpdatePatchEnvelopeReferencetoAppInstance 2 params → 200202401403500504default
GET
/v2/apps/instances
Query edge application instances
EdgeApplicationInstanceConfiguration_QueryEdgeApplicationInstancesV2 16 params → 200401403500504default
POST
/v2/apps/instances
Create edge application instance
EdgeApplicationInstanceConfiguration_CreateEdgeApplicationInstanceV2 2 params → 200401403500504default
GET
/v2/apps/instances/id/{id}
Get edge application instance
EdgeApplicationInstanceConfiguration_GetEdgeApplicationInstanceV2 2 params → 200401403500504default
DELETE
/v2/apps/instances/id/{id}
Delete edge application instance
EdgeApplicationInstanceConfiguration_DeleteEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}
Update edge application instance
EdgeApplicationInstanceConfiguration_UpdateEdgeApplicationInstanceV2 3 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/activate
Activate edge application instance
EdgeApplicationInstanceConfiguration_ActivateEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/console/remote
Connect to edge application instance console
EdgeApplicationInstanceConfiguration_ConnectToEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/deactivate
Deactivate edge application instance
EdgeApplicationInstanceConfiguration_DeActivateEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/refresh
Refresh edge application instance
EdgeApplicationInstanceConfiguration_RefreshEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/refresh/purge
Refresh and purge edge application instance
EdgeApplicationInstanceConfiguration_RefreshPurgeEdgeApplicationInstanceV2 2 params → 200401403500504default
PUT
/v2/apps/instances/id/{id}/restart
Restart edge application instance
EdgeApplicationInstanceConfiguration_RestartEdgeApplicationInstanceV2 2 params → 200401403500504default
GET
/v2/apps/instances/name/{name}
Get edge application instance
EdgeApplicationInstanceConfiguration_GetEdgeApplicationInstanceByNameV2 2 params → 200401403500504default
POST
/v2/apps/instances/patch-reference-update
Patch envelope reference update
EdgeApplicationInstanceConfiguration_UpdatePatchEnvelopeReferencetoAppInstanceV2 2 params → 200202401403500504default

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are AppInstance (43 properties), AppInstanceUpdate_HttpRequest (39 properties), appInterface (16 properties), ZsrvResponse (15 properties). Each schema is shown below with its type and property counts.

appACEMatch
object
App ACE Match
2 properties 2 required
phyAdapter
object
Physical Adapter
3 properties
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
PatchReferenceUpdateConfig
object
3 properties
VariableGroupCondition
object
3 properties
AppInstances
object
3 properties
AppInstEdgeNodeCluster
object
3 properties
protobufAny
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
EIDRegister
object
EID Register
10 properties 10 required
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 required
ManifestInfo
object
Details about transition parameters and indication for cause of the transition and recommendation for the transition action
6 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
AppInstanceLogs
object
App Instance Logs configuration
1 property 1 required
appInterface
object
App Interface detail
16 properties 1 required
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
vm
object
Virtual machine memory configuration
10 properties 4 required
VariableGroupConditionOperator
string
VariableVariableFormat
string
- VARIABLEFORMATUNSPECIFIED: Invalid format - VARIABLEFORMATTEXT: Value in string format - VARIABLEFORMATNUMBER: Value in integer format - VARIABLEFORMATFILE:…
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…
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
TransCause
string
AppType
string
type of app bundle.
DeploymentType
string
ZsrvError
object
3 properties
ActionScope
object
2 properties
googlerpcStatus
object
3 properties
appMapParams
object
Application map parameters
1 property 1 required
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
AppInstanceUpdate_HttpRequest
object
App Instance detail
39 properties 6 required
appACEAction
object
App ACE actions
7 properties 7 required
VariableGroupVariable
object
Edge Application Artifact Details
11 properties 4 required
CustomConfig
object
7 properties
CustomConfigVariableGroup
object
4 properties
TransDetails
object
3 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…
SnapshotState
string
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…
appACE
object
App ACE Configuration
4 properties 4 required
VariableOptionVal
object
2 properties
VmBootloaderMode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-edgeapplicationinstanceconfiguration-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
AE Profile APIs.io
Zededa ArtifactManager API
AE Profile APIs.io
Zededa AssetGroupService API
AE Profile APIs.io
Zededa BulkJobOps API
AE Profile APIs.io
Zededa CertificateEnrollmentProfileConfiguration API
AE Profile APIs.io
Zededa CloudDiagnostics API
AE Profile APIs.io
Zededa ClusterGroups API
AE Profile APIs.io
Zededa ClusterStatus API
AE Profile APIs.io
Zededa DatastoreConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationInstanceStatus API
AE Profile APIs.io
Zededa EdgeDiagnostics API
AE Profile APIs.io
#EdgeApplicationInstanceConfiguration
← Back to Z APIs
API Details
ID
zededa:zededa-edgeapplicationinstanceconfiguration-api
Base URL
https://zedcontrol.zededa.net/api
Docs
https://zedcontrol.zededa.net/api/v1/docs/
Provider
Zededa
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network