> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.

# Create a new GitRepo configuration

> POST /api/v1/cluster/instances/kubernetes/gitrepos. Kubernetes API reference.

Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request.

> [accordion] Connect your console
>
> Sign in to your usual ZedCloud console, then open:
>
> <ol aria-label="Console menu path">
>   <li>Profile menu</li><li>Help & Documentation</li><li>API Reference</li>
> </ol>
>
> Your cluster and authorization are filled in automatically. No token to copy.
> [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference)

&#x20;Modifying requests stay off until you enable them.

[Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/kubernetes.json)

> [!WARNING]
>
> This operation can change resources or access. After signing in, open **API request settings** and select **Enable modifying requests**, then **Apply settings**, to use its playground. Check the request body and destination before selecting **Send**. Your existing API permissions still apply.

A successful response.
Successfully created GitRepo configuration
Bad Request. Invalid GitRepo configuration or missing required fields.
Unauthorized. Authentication credentials are missing or invalid.
Forbidden. User does not have permission to create GitRepo configurations.
Conflict. GitRepo configuration with the same name already exists.
Internal Server Error. Failed to create GitRepo configuration due to server error.
An unexpected error response.


## OpenAPI

````yaml openapi/services/kubernetes.json POST /v1/cluster/instances/kubernetes/gitrepos
openapi: 3.0.0
info:
  title: ZEDEDA Kubernetes Service
  description: >-
    The ZEDEDA Kubernetes Service provides APIs for managing Kubernetes
    deployments and Helm charts in edge clusters.
  termsOfService: https://www.zededa.com/terms
  version: '1.0'
  contact:
    name: ZEDEDA API Support
    url: https://www.zededa.com/support
    email: support@zededa.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://{apiHost}/api
    variables:
      apiHost:
        default: invalid.invalid
        description: Connect from ZedUI to supply your verified API destination.
security:
  - ApiKeyAuth: []
tags:
  - name: KubernetesDeployments
    description: APIs for managing Kubernetes deployments
  - name: HelmChartManagement
    description: >-
      APIs for managing Helm charts in Kubernetes clusters. Provides operations
      for importing, creating, updating, deleting, and retrieving Helm charts
      from both global and enterprise-specific repositories.
  - name: KubernetesGitOps
    description: >-
      APIs for managing GitOps configurations and continuous deployment from Git
      repositories to Kubernetes clusters
  - name: PrivateHelmRepositories
    description: >-
      APIs for managing private Helm repositories and their authentication
      configurations
  - name: KubernetesSecrets
    description: >-
      APIs for managing Kubernetes secrets including SSH keys, basic
      authentication credentials, and other sensitive data. Supports create,
      read, and list operations.
  - name: ZKSClusterInstances
    description: >-
      APIs for managing ZKS (ZEDEDA Kubernetes Service) cluster instances
      including creation, management, node operations, and status monitoring
  - name: ClusterGroups
    description: >-
      APIs for managing cluster groups including creation, deletion, status
      monitoring, and manifest generation
  - name: KubernetesSnapshots
    description: APIs for managing etcd snapshots on Kubernetes clusters
  - name: KubernetesDashboard
    description: >-
      APIs for the embedded Kubernetes dashboard — SA-scoped proxy, kubeconfig
      download, and cluster-shell WebSocket
externalDocs:
  description: ZEDEDA Kubernetes Management Documentation
  url: https://help.zededa.com/hc/en-us/categories/39343791302299-Edge-Kubernetes
paths:
  /v1/cluster/instances/kubernetes/gitrepos:
    post:
      tags:
        - KubernetesGitOps
      summary: Create a new GitRepo configuration
      description: >-
        Create a new GitRepo configuration to enable continuous deployment from
        a Git repository. This allows automatic synchronization of Kubernetes
        manifests or Helm charts from a Git repository to target clusters.


        **Example Request:**

        ```json

        {
          "metadata": {
            "name": "app-manifests",
            "title": "Application Manifests Repository",
            "description": "Git repository containing production application manifests"
          },
          "data": {
            "project_id": "proj-12345",
            "repo_details": {
              "url": "https://github.com/myorg/k8s-manifests.git",
              "branch": "main",
              "path_list": ["applications/", "ingress/"]
            },
            "auth": {
              "git": {
                "secret": {
                  "type": "SECRET_TYPE_OPAQUE",
                  "name": "git-credentials"
                }
              }
            },
            "target": {
              "type": "GIT_REPO_TARGET_TYPE_CLUSTER",
              "value": "cluster-abc123"
            }
          }
        }

        ```


        **Example Response:**

        ```json

        {
          "operationType": "OPS_TYPE_UNSPECIFIED",
          "operationStatus": "OPS_STATUS_UNSPECIFIED",
          "objectKind": "",
          "objectId": "gitrepo-abc123",
          "objectName": "app-manifests",
          "objectRevision": "",
          "objectType": "OBJECT_TYPE_UNSPECIFIED",
          "operationTime": "",
          "startTime": "",
          "endTime": "",
          "user": "",
          "httpStatusCode": 201,
          "httpStatusMsg": "",
          "jobId": "",
          "error": [
            {
              "ec": "zMsgSucess",
              "location": "",
              "details": ""
            }
          ]
        }

        ```
      operationId: KubernetesGitOps_CreateGitRepo
      parameters:
        - name: X-Request-Id
          in: header
          required: false
          description: User-Agent specified id to track a request
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitRepoCreateRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '201':
          description: Successfully created GitRepo configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '400':
          description: >-
            Bad Request. Invalid GitRepo configuration or missing required
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '401':
          description: Unauthorized. Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '403':
          description: >-
            Forbidden. User does not have permission to create GitRepo
            configurations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '409':
          description: Conflict. GitRepo configuration with the same name already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '500':
          description: >-
            Internal Server Error. Failed to create GitRepo configuration due to
            server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
components:
  schemas:
    GitRepoCreateRequest:
      type: object
      properties:
        metadata:
          description: Metadata for the GitRepo (required)
          allOf:
            - $ref: '#/components/schemas/GitRepoMetadata'
        data:
          description: Data specification for the GitRepo (required)
          allOf:
            - $ref: '#/components/schemas/GitRepoData'
      description: Request message for creating a new GitRepo configuration
      title: GitRepo create request
      required:
        - metadata
        - data
    ZsrvResponse:
      type: object
      properties:
        operationType:
          title: |-
            Describes one of the operations type : possible values
                                    Read/Delete/Create/Update/List
          allOf:
            - $ref: '#/components/schemas/ZcOpsType'
        operationStatus:
          title: if this is log running job
          allOf:
            - $ref: '#/components/schemas/ZcOpsStatus'
        objectKind:
          type: string
          title: zedcloud object kind on which the operation was performed
        objectId:
          type: string
          title: Unique value identifies the object that was operated on
        objectName:
          type: string
          title: name of the object
        objectRevision:
          type: string
          title: |-
            object revision post the operation, note Read operation
            doesn't change the revision
        objectType:
          $ref: '#/components/schemas/ObjectType'
        operationTime:
          type: string
          title: time of operation
        startTime:
          type: string
          title: total time taken by operations
        endTime:
          type: string
        user:
          type: string
          title: the operation is performed on behalf of this user
        httpStatusCode:
          type: integer
          format: int32
          title: http response
        httpStatusMsg:
          type: string
          title: summary of the error in text format
        jobId:
          type: string
          title: for tracking asynchronous tasks
        error:
          type: array
          items:
            $ref: '#/components/schemas/ZsrvError'
          title: |-
            one or more errors will be set if the operation failed
            i.e. httpStatusCode != 2xx
    googlerpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    GitRepoMetadata:
      type: object
      properties:
        name:
          type: string
          description: Name of the GitRepo configuration (required)
        title:
          type: string
          description: Display title of the GitRepo configuration
        description:
          type: string
          description: Description of the GitRepo configuration
      description: Metadata information for a GitRepo configuration
      title: GitRepo metadata
      required:
        - name
    GitRepoData:
      type: object
      properties:
        projectId:
          type: string
          description: Project ID where the GitRepo belongs (required)
        repoDetails:
          description: Repository details and configuration (required)
          allOf:
            - $ref: '#/components/schemas/GitRepoRepositoryDetails'
        auth:
          description: Authentication configuration, required for private repositories
          allOf:
            - $ref: '#/components/schemas/GitRepoAuthConfig'
        target:
          description: Target deployment configuration (required)
          allOf:
            - $ref: '#/components/schemas/GitRepoTargetConfig'
      description: Complete data specification for a GitRepo configuration
      title: GitRepo data
      required:
        - projectId
        - repoDetails
        - target
    ZcOpsType:
      type: string
      enum:
        - OPS_TYPE_UNSPECIFIED
        - OPS_TYPE_READ
        - OPS_TYPE_DELETE
        - OPS_TYPE_CREATE
        - OPS_TYPE_UPDATE
        - OPS_TYPE_LIST
      default: OPS_TYPE_UNSPECIFIED
      title: ZedCloud internal operation type
    ZcOpsStatus:
      type: string
      enum:
        - OPS_STATUS_UNSPECIFIED
        - OPS_STATUS_PENDING
        - OPS_STATUS_ONGOING
        - OPS_STATUS_COMPLETE
      default: OPS_STATUS_UNSPECIFIED
      description: >-
        - OPS_STATUS_PENDING: In rare cases, system may not start operation when
        it was requested. Client will be notified that operation is PENDING
         - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.
         - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases.
      title: ZedCloud internal operation status
    ObjectType:
      type: string
      enum:
        - OBJECT_TYPE_UNSPECIFIED
        - OBJECT_TYPE_USER
        - OBJECT_TYPE_EDGE_NODE
        - OBJECT_TYPE_EDGE_APP
        - OBJECT_TYPE_IMAGE
        - OBJECT_TYPE_EDGE_APP_INSTANCE
        - OBJECT_TYPE_PROJECT
        - OBJECT_TYPE_NETWORK
        - OBJECT_TYPE_DATASTORE
        - OBJECT_TYPE_SERVICE
        - OBJECT_TYPE_SERVICE_INSTANCE
        - OBJECT_TYPE_ENTERPRISE
        - OBJECT_TYPE_ROLE
        - OBJECT_TYPE_CREDENTIAL
        - OBJECT_TYPE_NETWORK_INSTANCE
        - OBJECT_TYPE_VOLUME_INSTANCE
        - OBJECT_TYPE_REALM
        - OBJECT_TYPE_AUTHPROFILE
        - OBJECT_TYPE_POLICY
        - OBJECT_TYPE_APP_POLICY
        - OBJECT_TYPE_CLUSTER_INSTANCE
        - OBJECT_TYPE_PLUGIN
        - OBJECT_TYPE_DOC_POLICY
        - OBJECT_TYPE_ORCHESTRATOR_CLUSTER
        - OBJECT_TYPE_TAGS
        - OBJECT_TYPE_EDGE_NODE_INTERFACE
        - OBJECT_TYPE_DEPLOYMENT
        - OBJECT_TYPE_ENTITLEMENTS
        - OBJECT_TYPE_DATA_STREAM
        - OBJECT_TYPE_API_USAGE
        - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT
        - OBJECT_TYPE_PATCH_ENVELOPE
        - OBJECT_TYPE_RESOURCE_USAGE_TRACK
        - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE
        - OBJECT_TYPE_DEV_PASSTHROUGH
        - OBJECT_TYPE_EDGE_NODE_CLUSTER
        - OBJECT_TYPE_ASSET_GROUP
        - OBJECT_TYPE_APP_PROFILE
        - OBJECT_TYPE_PROFILE_DEPLOYMENT
        - OBJECT_TYPE_ZKS_INSTANCE
        - OBJECT_TYPE_CLUSTER_GROUP
      default: OBJECT_TYPE_UNSPECIFIED
    ZsrvError:
      type: object
      properties:
        ec:
          title: |-
            Enumrated error code, describes more granular numerical
            value than just httpStatus
          allOf:
            - $ref: '#/components/schemas/ZsrvErrorCode'
        location:
          type: string
          title: 'Ignore: Internal field only'
        details:
          type: string
          title: Field captures string description of details
    protobufAny:
      type: object
      properties:
        typeUrl:
          type: string
        value:
          type: string
          format: byte
    GitRepoRepositoryDetails:
      type: object
      properties:
        url:
          type: string
          description: Git repository URL (required)
        branch:
          type: string
          description: Git branch to track
        commit:
          type: string
          description: Specific git commit hash
        pathList:
          type: array
          items:
            type: string
          description: List of paths within the repository to monitor
      description: Repository configuration details for GitRepo
      title: GitRepo repository details
      required:
        - url
    GitRepoAuthConfig:
      type: object
      properties:
        encodedCertificates:
          type: string
          description: Base64 encoded certificates for TLS authentication
        insecureSkipTlsVerify:
          type: boolean
          description: Skip TLS certificate verification
        git:
          description: Git-specific authentication configuration
          allOf:
            - $ref: '#/components/schemas/GitAuthConfig'
        helm:
          description: Helm-specific authentication configuration
          allOf:
            - $ref: '#/components/schemas/HelmAuthConfig'
      description: >-
        Complete authentication configuration for GitRepo including certificates
        and credentials
      title: GitRepo authentication configuration
    GitRepoTargetConfig:
      type: object
      properties:
        type:
          description: Type of target for GitRepo deployment (required)
          allOf:
            - $ref: '#/components/schemas/GitRepoTargetType'
        value:
          type: string
          description: >-
            Target value (cluster ID, cluster group ID, etc.). Required when
            type is CLUSTER or CLUSTER_GROUP, not required for ALL_CLUSTER
      description: Target configuration specifying where the GitRepo should be deployed
      title: GitRepo target configuration
      required:
        - type
    ZsrvErrorCode:
      type: string
      enum:
        - zMsgErrorNone
        - zMsgSucess
        - NotFound
        - AlreadyExists
        - VersionMismatch
        - RangeError
        - LargeResult
        - IncompleteData
        - InvalidData
        - FunctionUnsupported
        - NoMemory
        - SendFailure
        - Timeout
        - BadReqBody
        - BadReqParam
        - InvalidFieldFormat
        - UrlNotFound
        - ApiVersionNotSupported
        - Unauthorized
        - Forbidden
        - Conflict
        - NotModified
        - DependencyConflict
        - JsonFmtError
        - ProtoFmtError
        - CertError
        - DataBaseConnection
        - DBError
        - zMsgAccepted
        - zMsgCreated
        - PreConditionFailed
        - InternalServerError
      default: zMsgErrorNone
      description: |-
        - zMsgErrorNone: common validation errors
         - IncompleteData: message had fields that weren't filled in
         - InvalidData: message contained the field that wasn't expected
         - FunctionUnsupported: this feature unavailable on this version of device
         - InvalidFieldFormat: message contained the field that wasn't correctly formatted
         - JsonFmtError: Marshal / Unmarshal errors
         - DataBaseConnection: generic DB error
      title: ZedCould internal error code
    GitAuthConfig:
      type: object
      properties:
        secret:
          description: Secret configuration for Git authentication
          allOf:
            - $ref: '#/components/schemas/GitRepoSecretConfig'
      description: Authentication configuration for Git repository access
      title: Git authentication configuration
    HelmAuthConfig:
      type: object
      properties:
        secret:
          description: Secret configuration for Helm authentication
          allOf:
            - $ref: '#/components/schemas/GitRepoSecretConfig'
        helmRepoUrlRegex:
          type: string
          description: Regular expression pattern to match Helm repository URLs
      description: Authentication configuration for Helm repository access
      title: Helm authentication configuration
    GitRepoTargetType:
      type: string
      enum:
        - GIT_REPO_TARGET_TYPE_UNKNOWN
        - GIT_REPO_TARGET_TYPE_ALL_CLUSTER
        - GIT_REPO_TARGET_TYPE_CLUSTER
        - GIT_REPO_TARGET_TYPE_CLUSTER_GROUP
      default: GIT_REPO_TARGET_TYPE_UNKNOWN
      title: GitRepo Target Types
    GitRepoSecretConfig:
      type: object
      properties:
        type:
          description: >-
            Type of secret for authentication(SECRET_TYPE_SSH,
            SECRET_TYPE_BASIC_AUTH, SECRET_TYPE_UNSPECIFIED, SECRET_TYPE_NONE).
            For a Public Repository, set type as SECRET_TYPE_NONE
          allOf:
            - $ref: '#/components/schemas/SecretType'
        name:
          type: string
          description: Name of the secret
      description: >-
        Secret configuration for GitRepo authentication, required for private
        repositories
      title: GitRepo secret configuration
    SecretType:
      type: string
      enum:
        - SECRET_TYPE_UNSPECIFIED
        - SECRET_TYPE_SSH
        - SECRET_TYPE_BASIC_AUTH
        - SECRET_TYPE_NONE
      default: SECRET_TYPE_UNSPECIFIED
      title: Kubernetes Secret Types
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: Bearer token for the ZedCloud gateway user session

````