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

The PatchEnvelopeConfiguration API from Zededa — 4 operation(s) for patchenvelopeconfiguration.

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

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

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

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

7 operations 4 paths 21 schemas 1 DELETE4 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 PatchEnvelopeConfiguration 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 7

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

PatchEnvelopeConfiguration 7
GET
/v1/patch-envelope
Get all the patch envelopes
PatchEnvelopeConfiguration_GetPatchEnvelope 9 params → 200401403500504default
POST
/v1/patch-envelope
Create patch envelope
PatchEnvelopeConfiguration_CreatePatchEnvelope 2 params → 200401403500504default
GET
/v1/patch-envelope/id/{id}
Get patch envelope by id
PatchEnvelopeConfiguration_GetPatchEnvelopeById 2 params → 200401403404500504default
DELETE
/v1/patch-envelope/id/{id}
Delete patch envelope
PatchEnvelopeConfiguration_DeleteAppInstanceSnapshot 2 params → 200401403404500504default
PUT
/v1/patch-envelope/id/{id}
Update patch envelope
PatchEnvelopeConfiguration_UpdatePatchEnvelope 3 params → 200401403404500504default
GET
/v1/patch-envelope/name/{name}
Get patch envelope by name
PatchEnvelopeConfiguration_GetPatchEnvelopeByName 2 params → 200401403404500504default
GET
/v1/patch-envelope/status
Get patch envelope status
PatchEnvelopeConfiguration_GetPatchEnvelopeStatus 9 params → 200401403500504default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), PatchEnvelope (11 properties), PatchEnvelopeStatus (9 properties), ObjectRevision (6 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
PatchStatusListMsg
object
3 properties
ObjectType
string
PatchEnvelopeStatus
object
PatchEnvelopeStatus encapsulates the status of an patch envelope
9 properties
Summary
object
Summary is used to store the Summary details
3 properties
PatchEnvelopeState
string
PatchEnvelope
object
PatchEnvelope is a proto that should be used by user-agents to create/update opaque data for application instances.
11 properties 4 required
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
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 required
ExternalOpaqueBinaryBlob
object
4 properties
PatchEnvelopeAction
string
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
PatchEnvelopeList
object
4 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
BinaryArtifact
object
5 properties
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…
InlineOpaqueBase64Data
object
3 properties
OpaqueObjectCategory
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-patchenvelopeconfiguration-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