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

APIs for managing GitOps configurations and continuous deployment from Git repositories to Kubernetes clusters

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

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

This API exposes 5 operations across 2 paths, and defines 29 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 29 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 KubernetesGitOps 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.

KubernetesGitOps 5

APIs for managing GitOps configurations and continuous deployment from Git repositories to Kubernetes clusters

GET
/v1/cluster/instances/kubernetes/gitrepos
List all GitRepo configurations
KubernetesGitOps_ListGitRepos 1 param → 200400401403500default
POST
/v1/cluster/instances/kubernetes/gitrepos
Create a new GitRepo configuration
KubernetesGitOps_CreateGitRepo 2 params → 200201400401403409500default
GET
/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}
Get GitRepo configuration by ID
KubernetesGitOps_GetGitRepo 2 params → 200400401403404500default
DELETE
/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}
Delete GitRepo configuration
KubernetesGitOps_DeleteGitRepo 2 params → 200400401403404409500default
PUT
/v1/cluster/instances/kubernetes/gitrepos/id/{gitrepoId}
Update GitRepo configuration
KubernetesGitOps_UpdateGitRepo 3 params → 200400401403404409500default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), GitRepoGetResponse (12 properties), GitRepoResourceCounts (8 properties), GitRepoGetStatus (6 properties). Each schema is shown below with its type and property counts.

GitAuthConfig
object
Authentication configuration for Git repository access
1 property
ZcOpsType
string
ObjectType
string
GitRepoGetResponse
object
Complete response for GitRepo GET operations including metadata, specification, and status
12 properties
GitRepoResourceStatusMap
object
Status information for individual resources with detailed mapping
5 properties
protobufAny
object
2 properties
GitRepoTargetConfig
object
Target configuration specifying where the GitRepo should be deployed
2 properties 1 required
GitRepoAuthConfig
object
Complete authentication configuration for GitRepo including certificates and credentials
4 properties
GitRepoData
object
Complete data specification for a GitRepo configuration
4 properties 3 required
GitRepoGetStatus
object
Status information for GitRepo including sync status and resource conditions
6 properties
GitRepoState
object
Current operational state of a GitRepo
4 properties
GitRepoEvents
object
Events related to GitRepo operations
4 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:…
HelmAuthConfig
object
Authentication configuration for Helm repository access
2 properties
GitRepoMetadata
object
Metadata information for a GitRepo configuration
3 properties 1 required
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
GitRepoResourceCounts
object
Count of resources in different states
8 properties
GitRepoTargetType
string
GitRepoRepositoryDetails
object
Repository configuration details for GitRepo
4 properties 1 required
GitRepoStatusDisplay
object
Display-friendly status information
2 properties
SecretType
string
ZsrvResponse
object
15 properties
GitRepoCreateRequest
object
Request message for creating a new GitRepo configuration
2 properties 2 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…
GitRepoCondition
object
Status condition information for a GitRepo
6 properties
GitRepoListResponse
object
Response for GitRepo LIST operations containing multiple GitRepo entries with summary information
3 properties
GitRepoListStatusSummary
object
Summary of GitRepo statuses in the list response
3 properties
GitRepoSecretConfig
object
Secret configuration for GitRepo authentication
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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