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

The ArtifactManager API from Zededa — 4 operation(s) for artifactmanager.

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

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

This API exposes 6 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

6 operations 4 paths 16 schemas 1 DELETE3 GET1 POST1 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 ArtifactManager 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 6

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

ArtifactManager 6
GET
/v1/artifacts
Query artifact files
ArtifactManager_QueryArtifacts 7 params → 200400401403500504default
POST
/v1/artifacts
Create artifact file in the file storage
ArtifactManager_CreateArtifact 2 params → 200400401403500504default
GET
/v1/artifacts/id/{id}
Download artifact file chunk by chunk
ArtifactManager_GetArtifactStream 2 params → 200206307400401403500504
DELETE
/v1/artifacts/id/{id}
Delete artifact file form the datastore
ArtifactManager_DeleteArtifact 2 params → 200401403404500504default
PUT
/v1/artifacts/id/{id}/upload/chunked
Uploads the given chunk into the specified multiplePart file
ArtifactManager_UploadArtifact 4 params → 200202400401403500504default
GET
/v1/artifacts/id/{id}/url
Generates the signedUrl for accessing the resource
ArtifactManager_GetArtifactSignedUrl 2 params → 200307400401403500504default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), Artifact (5 properties), Cursor (5 properties), ZsrvError (3 properties). Each schema is shown below with its type and property counts.

protobufAny
object
2 properties
ZcOpsType
string
StatusCode
string
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
Artifact
object
ArtifactKey idenfies the artifact by artifactId
5 properties
ZsrvResponse
object
15 properties
ObjectType
string
DecsriptionCode
string
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
Summary
object
Summary is used to store the Summary details
3 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
Description
object
Description encapsulates the top level Description of the operation
2 properties
ArtifactList
object
Response returned for List artifact Keys
3 properties
Status
object
Status encapsulates the top level status of the operation
2 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:…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-artifactmanager-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService 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