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

The VolumeInstanceConfiguration API from Zededa — 3 operation(s) for volumeinstanceconfiguration.

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

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

This API exposes 6 operations across 3 paths, and defines 19 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 3 paths 19 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 VolumeInstanceConfiguration 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 3 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.

VolumeInstanceConfiguration 6
GET
/v1/volumes/instances
Query edge volume instances
VolumeInstanceConfiguration_QueryVolumeInstances 15 params → 200400401403500504default
POST
/v1/volumes/instances
Create edge volume instance
VolumeInstanceConfiguration_CreateVolumeInstance 2 params → 200400401403409500504default
GET
/v1/volumes/instances/id/{id}
Get edge volume instance
VolumeInstanceConfiguration_GetVolumeInstance 2 params → 200401403404500504default
DELETE
/v1/volumes/instances/id/{id}
Delete volume instance
VolumeInstanceConfiguration_DeleteVolumeInstance 2 params → 200401403404500504default
PUT
/v1/volumes/instances/id/{id}
Update edge volume instance
VolumeInstanceConfiguration_UpdateVolumeInstance 3 params → 200401403404409500504default
GET
/v1/volumes/instances/name/{name}
Get edge volume instance
VolumeInstanceConfiguration_GetVolumeInstanceByName 2 params → 200401403404500504default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are VolInstConfig (20 properties), VolInstConfigUpdate_HttpRequest (20 properties), ZsrvResponse (15 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
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
VolumeInstanceType
string
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 required
VolumeInstanceAccessMode
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:…
ZedCloudOpsCmd
object
Zed cloud Operation command
2 properties
VolInstConfig
object
20 properties
VolInstShortConfig
object
5 properties
VolInstConfigUpdate_HttpRequest
object
20 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
VolInstList
object
4 properties
VolInstEdgeNodeCluster
object
2 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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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