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

APIs for managing Kubernetes secrets including SSH keys, basic authentication credentials, and other sensitive data. Supports create, read, and list operations.

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

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

This API exposes 3 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

3 operations 2 paths 16 schemas 2 GET1 POST

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 KubernetesSecrets 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 3

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

KubernetesSecrets 3

APIs for managing Kubernetes secrets including SSH keys, basic authentication credentials, and other sensitive data. Supports create, read, and list operations.

GET
/v1/cluster/instances/kubernetes/secrets
List all Kubernetes secrets
KubernetesSecrets_ListSecrets 1 param → 200400401403500default
POST
/v1/cluster/instances/kubernetes/secrets
Create a new Kubernetes secret
KubernetesSecrets_CreateSecret 2 params → 200201400401403409500default
GET
/v1/cluster/instances/kubernetes/secrets/id/{secretId}
Get Kubernetes secret by ID
KubernetesSecrets_GetSecret 2 params → 200400401403404500default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), SecretMetadata (5 properties), SecretInfoResponse (5 properties), SecretState (4 properties). Each schema is shown below with its type and property counts.

SecretMetadata
object
Metadata information for a Kubernetes secret including name, type, and state
5 properties 2 required
protobufAny
object
2 properties
ZcOpsType
string
SecretType
string
ZsrvResponse
object
15 properties
ObjectType
string
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
SecretListResponse
object
Response containing a list of Kubernetes secrets with pagination information
2 properties
SecretInfoResponse
object
Response containing comprehensive information about a Kubernetes secret
5 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
SSHCredentials
object
SSH key pair credentials for SSH-based authentication
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:…
SecretCreateRequest
object
Request message for creating a new Kubernetes secret
2 properties 2 required
SecretState
object
Current operational state of a Kubernetes secret
4 properties
SecretData
object
Raw data for Kubernetes secrets including encoded credentials and SSH keys
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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