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

Zededa ImageConfiguration API

The ImageConfiguration API from Zededa — 9 operation(s) for imageconfiguration.

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

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

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

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

15 operations 9 paths 20 schemas 2 DELETE6 GET1 POST6 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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zededa ImageConfiguration 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 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 6 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

ImageConfiguration 15
GET
/v1/apps/images
Query edge application images
ImageConfiguration_QueryImages 13 params → 200400401403500504default
POST
/v1/apps/images
Create edge application image
ImageConfiguration_CreateImage 2 params → 200400401403409500504default
GET
/v1/apps/images/baseos/latest
Query latest version of EVE image for each hardware architecture
ImageConfiguration_QueryLatestImageVersions 8 params → 200400401403500504default
DELETE
/v1/apps/images/baseos/latest
Delete edge application image
ImageConfiguration_DeleteLatestImage 2 params → 200401403404409500504default
PUT
/v1/apps/images/baseos/latest
Mark Eve image as latest
ImageConfiguration_MarkEveImageLatest 2 params → 200400401403404500504default
GET
/v1/apps/images/baseos/latest/hwclass/{imageArch}
Get latest version of EVE image
ImageConfiguration_GetLatestImageVersion 2 params → 200401403404500504default
PUT
/v1/apps/images/baseos/latest/hwclass/{imageArch}
Mark Eve image as latest
ImageConfiguration_MarkEveImageLatest2 3 params → 200400401403404500504default
GET
/v1/apps/images/id/{id}
Get edge application image
ImageConfiguration_GetImage 2 params → 200401403404500504default
DELETE
/v1/apps/images/id/{id}
Delete edge application image
ImageConfiguration_DeleteImage 2 params → 200401403404409500504default
PUT
/v1/apps/images/id/{id}
Update edge application image
ImageConfiguration_UpdateImage 3 params → 200400401403404409500504
PUT
/v1/apps/images/id/{id}/uplink
Uplinks edge application image
ImageConfiguration_UplinkImage 3 params → 200202400401403404409500
GET
/v1/apps/images/name/{name}
Get edge application image
ImageConfiguration_GetImageByName 2 params → 200401403404500504default
PUT
/v1/apps/images/name/{name}/upload/chunked
Uploads edge application image binary file
ImageConfiguration_UploadImageChunked 4 params → 200202400401403404409500
PUT
/v1/apps/images/name/{name}/upload/file
Uploads edge application image binary file
ImageConfiguration_UploadImageFile 3 params → 200202400401403404409500
GET
/v1/apps/images/projects
Query common project access list among a list of images
ImageConfiguration_QueryImageProjectList 7 params → 200400401403500504default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ImageConfig (20 properties), ZsrvResponse (15 properties), Images (8 properties), ObjectRevision (6 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
Images
object
8 properties
Origin
string
- ORIGINUNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGINIMPORTED: Object imported from global enterprise. - ORIGINLOCAL: Object…
ImageStatus
string
- IMAGESTATUSCREATED: Image metadata is created - IMAGESTATUSUPLOADING: Image binary is being uploaded to Datstore - IMAGESTATUSREADY: Image is ready for downl…
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
ImageConfig
object
Image metadata for edge gateway Base OS or for eedge applications.
20 properties 6 required
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 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:…
configFormat
string
ImageProjectList
object
3 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
ModelArchType
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…
ImageType
string
- IMAGETYPEEVE: Base OS images for edge gateway - IMAGETYPEAPPLICATION: Edge application images - IMAGETYPEEVEPRIVATE: Private Base OS images for edge gateway…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-imageconfiguration-api-openapi.yml Raw ↑

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 EdgeApplicationInstanceStatus API