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

The CloudDiagnostics API from Zededa — 8 operation(s) for clouddiagnostics.

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

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

This API exposes 10 operations across 8 paths, and defines 23 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 8 paths 23 schemas 1 DELETE6 GET2 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 CloudDiagnostics 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 8 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CloudDiagnostics 10
GET
/v1/cloud/healthreport
Get Cloud services health report
CloudDiagnostics_GetClusterHealthReport 1 param → 200500504default
GET
/v1/cloud/ping
Check Cloud reachability
CloudDiagnostics_checkClusterHealth 2 params → 200500504default
GET
/v1/cloud/ping/id/{pingId}
Check Cloud reachability
CloudDiagnostics_checkClusterHealth2 2 params → 200500504default
GET
/v1/cloud/policies
Query Cloud policies
CloudDiagnostics_QueryCloudPolicies 2 params → 200500504default
POST
/v1/cloud/policies
Create Cloud policy document
CloudDiagnostics_CreateCloudPolicyDocument 2 params → 200400500504default
GET
/v1/cloud/policies/id/{id}
Get Cloud policy document
CloudDiagnostics_GetCloudPolicyDocument 2 params → 200404500504default
DELETE
/v1/cloud/policies/id/{id}
Delete Cloud policy specific version
CloudDiagnostics_DeleteCloudPolicyDocument 2 params → 200404500504default
PUT
/v1/cloud/policies/latest
Update Cloud policy specific version
CloudDiagnostics_MarkCloudPolicyLatest 2 params → 200400401403404500504default
GET
/v1/cloud/version
Get Cloud controller software version
CloudDiagnostics_GetClusterVersion 1 param → 200500504default
POST
/v1/hello
Check Cloud services health
CloudDiagnostics_checkMicroserviceHealth 2 params → 200400500504default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), ObjectRevision (6 properties), Cursor (5 properties), HealthDesc (5 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
ObjectType
string
HealthDesc
object
5 properties
Summary
object
Summary is used to store the Summary details
3 properties
HelloResp
object
1 property
protobufAny
object
2 properties
HealthServiceResp
object
3 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
CloudVersion
object
2 properties
HealthServiceSubType
string
PolicyDocVersionResp
object
3 properties
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 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:…
PingMsgSendResp
object
1 property
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
PolicyDocVersionList
object
3 properties
PolicyDocVersion
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…
BriefHealth
object
1 property
HelloName
object
4 properties
CloudVersionResp
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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