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

APIs for managing cluster groups including creation, deletion, status monitoring, and manifest generation

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

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

This API exposes 5 operations across 5 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.

5 operations 5 paths 20 schemas 1 DELETE2 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 ClusterGroups 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 5

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

ClusterGroups 5

APIs for managing cluster groups including creation, deletion, status monitoring, and manifest generation

POST
/v1/zks/cluster/groups
Create a new cluster group
ClusterGroups_CreateClusterGroup 2 params → 200201400401403409500default
DELETE
/v1/zks/cluster/groups/id/{clusterGroupId}
Delete cluster group
ClusterGroups_DeleteClusterGroup 2 params → 200400401403404409500default
PUT
/v1/zks/cluster/groups/id/{id}
Update cluster group
ClusterGroups_UpdateClusterGroup 3 params → 200400401403404409500default
GET
/v1/zks/cluster/groups/manifest
Get cluster group manifest
ClusterGroups_GetClusterGroupManifest 1 param → 200400401403404500default
GET
/v1/zks/cluster/groups/status
Get cluster groups status
ClusterGroups_GetClusterGroupsStatus 1 param → 200400401403500default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), ClusterGroupStatus (14 properties), ClusterGroup (7 properties), ClusterGroupResourceSummary (7 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
ObjectType
string
ClusterGroupManifestOutput
object
1 property
ClusterGroupManifest
object
Cluster Group Manifest details
1 property 1 required
ClusterGroup
object
Cluster Group details
7 properties 2 required
ClusterReadiness
object
2 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
ClusterGroupManifestJaml
object
1 property
ClusterGroupResources
object
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:…
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
ClusterGroupStatus
object
14 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…
ClusterGroupStatusListResp
object
4 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
ClusterGroupCluster
object
7 properties
ClusterGroupResourceSummary
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-clustergroups-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 ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
Zededa EdgeDiagnostics API