> ## 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.

# Get private Helm repository by ID

> GET /api/v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}. 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)

Successfully retrieved private repository configuration
Bad Request. Invalid repository ID format.
Unauthorized. Authentication credentials are missing or invalid.
Forbidden. User does not have permission to view this private repository.
Not Found. Private repository with the specified ID does not exist.
Internal Server Error. Failed to retrieve private repository due to server error.
An unexpected error response.


## OpenAPI

````yaml openapi/services/kubernetes.json GET /v1/cluster/instances/kubernetes/helm/repository/id/{privateRepoId}
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/helm/repository/id/{privateRepoId}:
    get:
      tags:
        - PrivateHelmRepositories
      summary: Get private Helm repository by ID
      description: >-
        Retrieve detailed information about a specific private Helm repository
        including its configuration, authentication details, and status.


        **Example Request:**

        ```

        GET
        /v1/cluster/instances/kubernetes/helm/repository/id/private-repo-abc123

        ```


        **Example Response:**

        ```json

        {
          "id": "private-repo-abc123",
          "metadata": {
            "name": "company-charts",
            "title": "Company Private Helm Repository",
            "description": "Private Helm repository containing company-specific charts",
            "tags": {
              "environment": "production",
              "team": "platform"
            }
          },
          "spec": {
            "repoDetails": {
              "type": "PRIVATE_REPO_TYPE_HELM_INDEX",
              "url": "https://charts.company.com/helm",
              "branch": "main"
            },
            "auth": {
              "secret": {
                "id": "secret-123",
                "type": "SECRET_TYPE_BASIC_AUTH",
                "name": "helm-repo-credentials",
                "data": {
                  "username": "helm-user",
                  "password": "***"
                }
              }
            }
          },
          "status": {
            "error": false,
            "message": "Repository is accessible and ready",
            "name": "company-charts",
            "transitioning": false
          },
          "repoIdentifier": "company-charts-repo"
        }

        ```
      operationId: PrivateHelmRepositories_GetPrivateRepo
      parameters:
        - name: privateRepoId
          description: >-
            Unique identifier of the Private Repository (required). Example:
            'private-repo-abc123'
          in: path
          required: true
          schema:
            type: string
        - name: X-Request-Id
          in: header
          required: false
          description: User-Agent specified id to track a request
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved private repository configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateRepoGetByIdResponse'
        '400':
          description: Bad Request. Invalid repository ID format.
          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 view this private
            repository.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '404':
          description: Not Found. Private repository with the specified ID does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '500':
          description: >-
            Internal Server Error. Failed to retrieve private repository 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:
    PrivateRepoGetByIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the private repository
        metadata:
          description: Metadata information for the private repository
          allOf:
            - $ref: '#/components/schemas/PrivateRepoMetadata'
        spec:
          description: Enhanced specification of the private repository
          allOf:
            - $ref: '#/components/schemas/PrivateRepoSpecInfo'
        status:
          description: Current operational status of the private repository
          allOf:
            - $ref: '#/components/schemas/PrivateRepoStatus'
        repoIdentifier:
          type: string
          description: Unique identifier for the private repository
      description: >-
        Detailed response message for private repository get by ID operation
        including metadata, specification, and status
      title: Private Repository detailed response
    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'
    PrivateRepoMetadata:
      type: object
      properties:
        name:
          type: string
          description: Name of the private repository configuration (required)
        title:
          type: string
          description: Display title of the private repository configuration
        description:
          type: string
          description: Description of the private repository configuration
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags associated with the private repository
      description: Metadata information for a private repository configuration
      title: Private Repository metadata
      required:
        - name
    PrivateRepoSpecInfo:
      type: object
      properties:
        repoDetails:
          description: Repository details and configuration
          allOf:
            - $ref: '#/components/schemas/PrivateRepoRepositoryDetails'
        auth:
          description: Enhanced authentication configuration
          allOf:
            - $ref: '#/components/schemas/PrivateRepoAuthInfo'
      description: >-
        Enhanced specification information for a private repository
        configuration
      title: Private Repository specification information
    PrivateRepoStatus:
      type: object
      properties:
        error:
          type: boolean
          description: Indicates if the repository is in an error state
        message:
          type: string
          description: >-
            Status message providing additional details about the repository
            state
        name:
          type: string
          description: Name of the repository in its current state
        transitioning:
          type: boolean
          description: Indicates if the repository is currently undergoing state transition
      description: Current operational status of a private repository
      title: Private Repository status
    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
    PrivateRepoRepositoryDetails:
      type: object
      properties:
        type:
          description: >-
            Type of the private repository (PRIVATE_REPO_TYPE_HELM_INDEX,
            PRIVATE_REPO_TYPE_GIT, PRIVATE_REPO_TYPE_UNSPECIFIED). This is a
            required parameter
          allOf:
            - $ref: '#/components/schemas/PrivateRepoType'
        url:
          type: string
          description: Private repository URL (required)
        branch:
          type: string
          description: Git branch to track
      description: Repository configuration details for private repository
      title: Private Repository details
      required:
        - type
        - url
    PrivateRepoAuthInfo:
      type: object
      properties:
        secret:
          description: Enhanced secret information for authentication
          allOf:
            - $ref: '#/components/schemas/PrivateRepoSecretInfo'
      description: >-
        Enhanced authentication information including secret details for private
        repository access
      title: Private Repository authentication information
    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
    PrivateRepoType:
      type: string
      enum:
        - PRIVATE_REPO_TYPE_UNSPECIFIED
        - PRIVATE_REPO_TYPE_GIT
        - PRIVATE_REPO_TYPE_HELM_INDEX
      default: PRIVATE_REPO_TYPE_UNSPECIFIED
      title: Private Repository Type
    PrivateRepoSecretInfo:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the secret
        type:
          description: Type of secret for authentication
          allOf:
            - $ref: '#/components/schemas/SecretType'
        name:
          type: string
          description: Name of the secret resource
        data:
          description: Secret credentials data
          allOf:
            - $ref: '#/components/schemas/SecretData'
      description: >-
        Enhanced secret information including credentials data for private
        repository authentication
      title: Private Repository secret information
    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
    SecretData:
      type: object
      properties:
        encodedUsername:
          type: string
          description: >-
            Base64 encoded username for basic authentication, Required if Secret
            type is SECRET_TYPE_BASIC_AUTH
        encodedPassword:
          type: string
          description: >-
            Base64 encoded password for basic authentication, Required if Secret
            type is SECRET_TYPE_BASIC_AUTH
        sshPublicKey:
          type: string
          description: >-
            Base64 encoded SSH public key for SSH authentication, Required if
            Secret type is SECRET_TYPE_SSH
        sshPrivateKey:
          type: string
          description: >-
            Base64 encoded SSH private key for SSH authentication, Required if
            Secret type is SECRET_TYPE_SSH
      description: >-
        Raw data for Kubernetes secrets including encoded credentials and SSH
        keys
      title: Kubernetes secret data
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: Bearer token for the ZedCloud gateway user session

````