Zededa AppProfileService API
The AppProfileService API from Zededa — 5 operation(s) for appprofileservice.
Zededa AppProfileService API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AppProfileService. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 8 operations across 5 paths, and defines 88 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
8 operations
5 paths
88 schemas
1 DELETE5 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa AppProfileService 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 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
AppProfileService 8
GET
/v1/appprofiles
Query app profiles
POST
/v1/appprofiles
Create app profile
GET
/v1/appprofiles/id/{id}
Get app profile
DELETE
/v1/appprofiles/id/{id}
Delete app profile
PUT
/v1/appprofiles/id/{id}
Update app profile
GET
/v1/appprofiles/id/{id}/version
Query app profile versions by app profile id
GET
/v1/appprofiles/name/{name}
Get app profile by name
GET
/v1/appprofiles/name/{name}/version
Query app profile versions by app profile name
Schemas 88
The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are VMManifest (26 properties), ProfileAppConfig (18 properties), appInterface (16 properties), VMManifestImage (15 properties). Each schema is shown below with its type and property counts.
appACEMatch
object
App ACE Match
2 properties
2 required
NtpServer
object
NTP Server
1 property
Summary
object
Summary is used to store the Summary details
3 properties
AppProfileVersion
object
7 properties
Interface
object
6 properties
NetworkInstanceDhcpType
string
ServicePoint
object
Service Point
3 properties
StaticDNSList
object
Static DNS list
2 properties
AppProfileRead
object
8 properties
VolumeInstanceAccessMode
string
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
AppType
string
type of app bundle.
DeploymentType
string
ProfileAppConfig
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 properties
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
AppProfileConfigSummary
object
7 properties
NetworkInstanceKind
string
Author
object
5 properties
DockerRuntimeVersion
string
AppProfileVersionListResp
object
2 properties
AppProfiles
object
3 properties
LispConfig
object
List Configurations.
6 properties
VariableGroupCondition
object
3 properties
VolumeInstanceType
string
OpaqueConfigType
string
AppInstanceLogs
object
App Instance Logs configuration
1 property
1 required
MapParams
object
1 property
appInterface
object
App Interface detail
16 properties
1 required
vm
object
Virtual machine memory configuration
10 properties
4 required
AppCategory
string
- APPCATEGORYUNSPECIFIED: Invalid Edge Application Category - APPCATEGORYOPERATINGSYSTEM: Edge operating systems - APPCATEGORYINDUSTRIAL: Connectity solution f…
ModuleType
string
module type.
DockerRuntimeProtocolVersion
string
Details
object
Edge Application Artifact Details
8 properties
1 required
DhcpServerConfig
object
8 properties
appACE
object
App ACE Configuration
4 properties
4 required
Param
object
2 properties
ProfileVolumePolicy
object
2 properties
ProbeConfig
object
Probing configuration
5 properties
ObjectType
string
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
VMManifest
object
26 properties
ProfileAppPolicy
object
2 properties
protobufAny
object
2 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
StaticIPRoute
object
Static IP Routes
4 properties
ZsrvError
object
3 properties
Match
object
2 properties
Permission
object
Acl
object
3 properties
LispServer
object
LispServer request payload
2 properties
2 required
ImageDatastore
object
2 properties
CustomConfig
object
7 properties
ProfilePolicyCommon
object
4 properties
VMManifestImage
object
15 properties
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
AppProfile
object
6 properties
VmBootloaderMode
string
phyAdapter
object
Physical Adapter
3 properties
ZcOpsType
string
ProfileNetworkConfig
object
11 properties
AclAction
object
8 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,…
ProfileVolumeConfig
object
11 properties
AppProfileStatusType
string
LimitParams
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
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…
ContainerDetail
object
common container detail.
1 property
googlerpcStatus
object
3 properties
appMapParams
object
Application map parameters
1 property
1 required
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
appACEAction
object
App ACE actions
7 properties
7 required
VariableGroupVariable
object
Edge Application Artifact Details
11 properties
4 required
CustomConfigVariableGroup
object
4 properties
ZsrvResponse
object
15 properties
Resource
object
2 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…
VariableOptionVal
object
2 properties
ProfileNetworkPolicy
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zededa 12
Other APIs Zededa publishes across the network.
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
Zededa EdgeDiagnostics API
#AppProfileService