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

The EdgeNodeClusterConfiguration API from Zededa — 7 operation(s) for edgenodeclusterconfiguration.

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

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

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

10 operations 7 paths 20 schemas 1 DELETE6 GET1 POST2 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 EdgeNodeClusterConfiguration 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 10

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

EdgeNodeClusterConfiguration 10
GET
/v1/cluster
Query Edge-Node Clusters.
EdgeNodeClusterConfiguration_QueryClusters 10 params → 200400401403404409412500
POST
/v1/cluster
Create Edge-Node Cluster.
EdgeNodeClusterConfiguration_CreateCluster 2 params → 200400401403404409412500
GET
/v1/cluster/available/projects
Get Edge-Node Cluster Available Projects.
EdgeNodeClusterConfiguration_GetAvailableProjectsForCluster 10 params → 200401403404409412500504
GET
/v1/cluster/id/{id}
Get Edge-Node Cluster.
EdgeNodeClusterConfiguration_GetCluster 2 params → 200401403404409412500504
DELETE
/v1/cluster/id/{id}
Delete Edge-Node Cluster.
EdgeNodeClusterConfiguration_DeleteCluster 2 params → 200400401403404409412500
PUT
/v1/cluster/id/{id}
Update Edge-Node Cluster.
EdgeNodeClusterConfiguration_UpdateCluster 3 params → 200400401403404409412500
GET
/v1/cluster/id/{id}/ports
Get Edge-Node Cluster Interface Ports.
EdgeNodeClusterConfiguration_GetClusterPorts 2 params → 200401403404409412500504
PUT
/v1/cluster/id/{id}/upgrade
Upgrade Edge-Node Cluster.
EdgeNodeClusterConfiguration_UpgradeCluster 3 params → 200400401403404409412500
GET
/v1/cluster/name/{name}
Get Edge-Node Cluster.
EdgeNodeClusterConfiguration_GetClusterByName 2 params → 200401403404409412500504
GET
/v1/cluster/node/id/{id}
Get Edge-Node Cluster.
EdgeNodeClusterConfiguration_GetClusterByNodeId 2 params → 200401403404409412500504

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), EdgeNodeClusterConfigSummary (14 properties), EdgeNodeCluster (11 properties), Cursor (5 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
EdgeNodeClusters
object
3 properties
ObjectType
string
EdgeNodeClusterConfigSummary
object
Cluster config summary
14 properties
EdgeNodeClusterNode
object
Cluster node detail
5 properties 2 required
EdgeNodeClusterType
string
- EDGENODECLUSTERTYPESTANDART: A standard cluster is a cluster that has exactly 3 nodes. This is the default type, which does not support zks clusters. - EDGEN…
EdgeNodeClusterProjects
object
3 properties
EdgeNodeCluster
object
Cluster detail
11 properties 3 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
BaseOSImage
object
Base OS image request details
5 properties 4 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:…
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
EdgeNodeClusterNodeType
string
EdgeNodeClusterInterfacePorts
object
2 properties
AdminState
string
- ADMINSTATECREATED: Entity Created in the controller - ADMINSTATEDELETED: Entity Deleted in the controller - ADMINSTATEACTIVE: Entity Activated in the control…
EdgeNodeClusterProject
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-edgenodeclusterconfiguration-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