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

APIs for managing Kubernetes deployments

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

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

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

5 operations 2 paths 19 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 KubernetesDeployments 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 2 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.

KubernetesDeployments 5

APIs for managing Kubernetes deployments

GET
/v1/cluster/instances/kubernetes/deployments
List all deployments
KubernetesDeployments_ListDeployments 1 param → 200400401403500default
POST
/v1/cluster/instances/kubernetes/deployments
Create a new Kubernetes deployment
KubernetesDeployments_CreateDeployment 2 params → 200201400401403409500default
GET
/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}
Get deployment by ID
KubernetesDeployments_GetDeployment 2 params → 200400401403404500default
DELETE
/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}
Delete a deployment
KubernetesDeployments_DeleteDeployment 2 params → 200400401403404409500default
PUT
/v1/cluster/instances/kubernetes/deployments/id/{deploymentId}
Update a deployment
KubernetesDeployments_UpdateDeployment 3 params → 200400401403404409500default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), DeploymentGetResponse (13 properties), ClusterMetadata (4 properties), Metadata (4 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
DeploymentGetResponse
object
Deployment get response
13 properties
protobufAny
object
2 properties
HelmChartData
object
Data for the Helm chart deployment
2 properties 2 required
DeploymentListResponse
object
Response containing a list of deployments
3 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
K8sDeploymentType
string
Metadata
object
Metadata for the deployment
4 properties 2 required
TargetClusters
object
Clusters where the deployment will be applied
3 properties 2 required
ZsrvResponse
object
15 properties
DeploymentRequest
object
Deployment create request
3 properties 3 required
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
ClusterMetadata
object
Metadata for the target cluster
4 properties 2 required
Chart
object
Details of the Helm chart
4 properties 2 required
DeploymentData
object
Data for the deployment
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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