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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zededa

Zededa ZKSClusterInstances API

APIs for managing ZKS (ZEDEDA Kubernetes Service) cluster instances including creation, management, node operations, and status monitoring

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 17 operations across 14 paths, and defines 33 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

17 operations 14 paths 33 schemas 1 DELETE9 GET2 POST5 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
Contact
ZEDEDA API Support
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Zededa ZKSClusterInstances 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 17

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

ZKSClusterInstances 17

APIs for managing ZKS (ZEDEDA Kubernetes Service) cluster instances including creation, management, node operations, and status monitoring

GET
/v1/zks/instances
List all ZKS instances
ZKSClusterInstances_ListZKSInstances 1 param → 200400401403500default
POST
/v1/zks/instances
Create a new ZKS instance
ZKSClusterInstances_CreateZKSInstance 2 params → 200201400401403409500default
PUT
/v1/zks/instances
Bulk update ZKS instances
ZKSClusterInstances_BulkUpdateZKSInstances 2 params → 200400401403404500default
PUT
/v1/zks/instances/id/{id}
Update ZKS instance
ZKSClusterInstances_UpdateZKSInstance 3 params → 200400401403404409500default
GET
/v1/zks/instances/id/{zksId}
Get ZKS instance by ID
ZKSClusterInstances_GetZKSInstance 2 params → 200400401403404500default
DELETE
/v1/zks/instances/id/{zksId}
Delete ZKS instance
ZKSClusterInstances_DeleteZKSInstance 2 params → 200400401403404409500default
GET
/v1/zks/instances/id/{zksId}/metrics
Get ZKS instance metrics by ID
ZKSClusterInstances_GetZKSInstanceMetrics 2 params → 200400401403404500default
PUT
/v1/zks/instances/id/{zksId}/nodes
Update ZKS instance nodes
ZKSClusterInstances_UpdateZKSInstanceNodes 3 params → 200400401403404409500default
GET
/v1/zks/instances/id/{zksId}/registration-commands
Get registration commands by ID
ZKSClusterInstances_GetZKSInstanceRegistrationCommands 2 params → 200400401403404500default
PUT
/v1/zks/instances/id/{zksId}/upgrade
Upgrade ZKS instance
ZKSClusterInstances_UpgradeZKSInstance 3 params → 200400401403404409500default
POST
/v1/zks/instances/import
Import an existing ZKS instance
ZKSClusterInstances_ImportZKSInstance 2 params → 200201400401403409500default
PUT
/v1/zks/instances/k3s-upgrade
Bulk upgrade K3s version
ZKSClusterInstances_BulkUpgradeK3s 2 params → 200400401403404409500default
GET
/v1/zks/instances/k3s-versions
Get available K3s versions
ZKSClusterInstances_GetK3sVersions 1 param → 200400401403500default
GET
/v1/zks/instances/name/{zksName}
Get ZKS instance by name
ZKSClusterInstances_GetZKSInstanceByName 2 params → 200400401403404500default
GET
/v1/zks/instances/name/{zksName}/metrics
Get ZKS instance metrics by name
ZKSClusterInstances_GetZKSInstanceMetricsByName 2 params → 200400401403404500default
GET
/v1/zks/instances/name/{zksName}/registration-commands
Get registration commands by name
ZKSClusterInstances_GetZKSInstanceRegistrationCommandsByName 2 params → 200400401403404500default
GET
/v1/zks/instances/status
Get ZKS instances status
ZKSClusterInstances_GetZKSInstancesStatus 1 param → 200400401403500default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ZksInstanceStatus (22 properties), ZsrvResponse (15 properties), ZksInstanceMetrics (10 properties), ZksInstance (9 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
ObjectType
string
NodeAction
string
ZksInstanceRegistrationInfo
object
3 properties
PodsCapacity
object
2 properties
ZksInstanceBulkUpdateData
object
1 property
ZksInstancesList
object
2 properties
ZksK3sVersion
object
3 properties
ZksInstanceNode
object
ZKS Instance node detail
2 properties 2 required
protobufAny
object
2 properties
ResourceUsage
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
ClusterCapacity
object
3 properties
ZksInstanceK3sBulkUpgrade
object
2 properties
BaseOSImage
object
Base OS image request details
5 properties 4 required
ZksInstanceStatus
object
22 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:…
ResourceCapacityUsage
object
2 properties
ZksInstanceStatusListResp
object
5 properties
ZsrvError
object
3 properties
ZksInstanceK3sBulkUpgradeData
object
1 property
googlerpcStatus
object
3 properties
ZksInstanceBulkUpdate
object
2 properties
ZksInstanceStatusSummary
object
8 properties
ZksK3sVersionList
object
1 property
ZksInstance
object
ZKS Instance details
9 properties 3 required
ZksInstanceRegistrationCommands
object
4 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…
ZksInstanceSummary
object
7 properties
ZksInstanceStatusSummaries
object
1 property
ZksInstanceMetrics
object
10 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-zksclusterinstances-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
AE Profile APIs.io
Zededa ArtifactManager API
AE Profile APIs.io
Zededa AssetGroupService API
AE Profile APIs.io
Zededa BulkJobOps API
AE Profile APIs.io
Zededa CertificateEnrollmentProfileConfiguration API
AE Profile APIs.io
Zededa CloudDiagnostics API
AE Profile APIs.io
Zededa ClusterGroups API
AE Profile APIs.io
Zededa ClusterStatus API
AE Profile APIs.io
Zededa DatastoreConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationInstanceConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationInstanceStatus API
AE Profile APIs.io
#ZKSClusterInstances
← Back to Z APIs
API Details
ID
zededa:zededa-zksclusterinstances-api
Base URL
https://zedcontrol.zededa.net/api
Docs
https://zedcontrol.zededa.net/api/v1/docs/
Provider
Zededa
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network