Zededa BulkJobOps API
The BulkJobOps API from Zededa — 14 operation(s) for bulkjobops.
Zededa BulkJobOps API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BulkJobOps. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 17 operations across 14 paths, and defines 84 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://zedcontrol.zededa.net/api.
17 operations
14 paths
84 schemas
1 DELETE4 GET1 POST11 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zededa BulkJobOps 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 17
Across 14 paths, the API surfaces 17 operations — 1 DELETE, 4 GET, 1 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.
BulkJobOps 17
GET
/v1/jobs
Query asynchronous job requests
POST
/v1/jobs
Create asynchronous job request
PUT
/v1/jobs/apps/bundles/import
Update job request to import edge application bundles
PUT
/v1/jobs/apps/instances/create
Update job request to create edge application instances
PUT
/v1/jobs/apps/instances/refresh
Update job request to refresh edge application instances
PUT
/v1/jobs/apps/instances/refresh/purge
Update job request to refresh and purge edge application instances
PUT
/v1/jobs/devices/baseos/upgrade
Update job request to update EVE image on edge nodes
PUT
/v1/jobs/devices/baseos/upgrade/retry
Update job request to retry update EVE image on edge nodes
PUT
/v1/jobs/devices/deployment/tags
Update job request to update Deployment tag on edge nodes in bulk.
PUT
/v1/jobs/devices/project/target
Update job request to update EVE image project and target on edge nodes
PUT
/v1/jobs/devices/tags
Update job request to update EVE image tag on edge nodes
GET
/v1/jobs/id/{id}
Get asynchronous job request
PUT
/v1/jobs/id/{id}
Update asynchronous job request
GET
/v1/jobs/id/{id}/objectType/{objectType}
Get asynchronous job request
DELETE
/v1/jobs/id/{id}/objectType/{objectType}
Delete asynchronous job request
PUT
/v1/jobs/models/import
Update job request to import hardware models
GET
/v1/jobs/name/{name}/objectType/{objectType}
Get asynchronous job request
Schemas 84
The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are AppInstance (43 properties), NetInstConfig (26 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
NtpServer
object
NTP Server
1 property
Summary
object
Summary is used to store the Summary details
3 properties
NetworkInstanceDhcpType
string
ServicePoint
object
Service Point
3 properties
AppInstanceDeploy
object
1 property
StaticDNSList
object
Static DNS list
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
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
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
AppType
string
type of app bundle.
DeploymentType
string
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
TransDetails
object
3 properties
SnapshotState
string
NetworkInstanceKind
string
ModelImport
object
1 property
DeviceProjectAndTargetUpdate
object
project id will be required to move the device to a new project
4 properties
1 required
LispConfig
object
List Configurations.
6 properties
NetworkConfigOrDefault
object
2 properties
VariableGroupCondition
object
3 properties
BulkConfig
object
config required for bulk ops.
11 properties
AppInstEdgeNodeCluster
object
3 properties
OpaqueConfigType
string
BaseOSImage
object
Base OS image request details
5 properties
4 required
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
AppInstanceRefreshAndPurge
object
1 property
ActionScope
object
2 properties
JobStatus
string
job status.
DhcpServerConfig
object
8 properties
appACE
object
App ACE Configuration
4 properties
4 required
ProbeConfig
object
Probing configuration
5 properties
BulkInstanceConfig
object
4 properties
BaseosUpdate
object
1 property
ObjectType
string
VariableFileEncoding
string
- FILEENCODINGUNSPECIFIED: File content not encoded - FILEENCODINGBASE64: File content encoded in Base64
protobufAny
object
2 properties
SysModelDetail
object
3 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
JobConfig
object
config required for job ops
15 properties
2 required
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
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
CustomConfig
object
7 properties
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
JobConfigList
object
Returned list of jobs matched by filter criteria
3 properties
SelectionCriteria
object
3 properties
VmBootloaderMode
string
DeploymentTagUpdate
object
deployment tag will be required to target deployment version on the device
1 property
1 required
phyAdapter
object
Physical Adapter
3 properties
ZcOpsType
string
TagUpdate
object
device tag will be required to auto deploy objects on the device
2 properties
1 required
CustomUpdateModelFields
object
1 property
dhcpIpRange
object
DHCP IP range
2 properties
ModelAttributes
object
3 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,…
ManifestInfo
object
Details about transition parameters and indication for cause of the transition and recommendation for the transition action
6 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:…
VariableGroupConditionOperator
string
NetInstEdgeNodeCluster
object
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…
googlerpcStatus
object
3 properties
appMapParams
object
Application map parameters
1 property
1 required
BulkService
string
BundleDetail
object
2 properties
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
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…
VariableOptionVal
object
2 properties
BundleImport
object
1 property
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 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
#BulkJobOps