Argo CD RepositoryService API

openapi: 3.2.0
info:
  description: Description of all APIs
  title: Consolidate Services AccountService Repository Service API
  version: version not set
tags:
- name: RepositoryService
paths:
  /api/v1/repositories:
    get:
      tags:
      - RepositoryService
      summary: ListRepositories gets a list of all configured repositories
      operationId: RepositoryService_ListRepositories
      parameters:
      - description: Repo URL for query.
        name: repo
        in: query
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1RepositoryList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
    post:
      tags:
      - RepositoryService
      summary: CreateRepository creates a new repository configuration
      operationId: RepositoryService_CreateRepository
      parameters:
      - description: Whether to create in upsert mode.
        name: upsert
        in: query
        schema:
          type: boolean
      - description: Whether to operate on credential set instead of repository.
        name: credsOnly
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1alpha1Repository'
        description: Repository definition
        required: true
  /api/v1/repositories/{repo.repo}:
    put:
      tags:
      - RepositoryService
      summary: UpdateRepository updates a repository configuration
      operationId: RepositoryService_UpdateRepository
      parameters:
      - description: Repo contains the URL to the remote repository
        name: repo.repo
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1alpha1Repository'
        required: true
  /api/v1/repositories/{repo}:
    get:
      tags:
      - RepositoryService
      summary: Get returns a repository or its credentials
      operationId: RepositoryService_Get
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
    delete:
      tags:
      - RepositoryService
      summary: DeleteRepository deletes a repository from the configuration
      operationId: RepositoryService_DeleteRepository
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/repositories/{repo}/apps:
    get:
      tags:
      - RepositoryService
      summary: ListApps returns list of apps in the repo
      operationId: RepositoryService_ListApps
      parameters:
      - name: repo
        in: path
        required: true
        schema:
          type: string
      - name: revision
        in: query
        schema:
          type: string
      - name: appName
        in: query
        schema:
          type: string
      - name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoAppsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/repositories/{repo}/helmcharts:
    get:
      tags:
      - RepositoryService
      summary: GetHelmCharts returns list of helm charts in the specified repository
      operationId: RepositoryService_GetHelmCharts
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryHelmChartsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/repositories/{repo}/oci-tags:
    get:
      tags:
      - RepositoryService
      operationId: RepositoryService_ListOCITags
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRefs'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/repositories/{repo}/refs:
    get:
      tags:
      - RepositoryService
      operationId: RepositoryService_ListRefs
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRefs'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/repositories/{repo}/validate:
    post:
      tags:
      - RepositoryService
      summary: ValidateAccess validates access to a repository with given parameters
      operationId: RepositoryService_ValidateAccess
      parameters:
      - description: The URL to the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Username for accessing repo.
        name: username
        in: query
        schema:
          type: string
      - description: Password for accessing repo.
        name: password
        in: query
        schema:
          type: string
      - description: Private key data for accessing SSH repository.
        name: sshPrivateKey
        in: query
        schema:
          type: string
      - description: Whether to skip certificate or host key validation.
        name: insecure
        in: query
        schema:
          type: boolean
      - description: TLS client cert data for accessing HTTPS repository.
        name: tlsClientCertData
        in: query
        schema:
          type: string
      - description: TLS client cert key for accessing HTTPS repository.
        name: tlsClientCertKey
        in: query
        schema:
          type: string
      - description: The type of the repo.
        name: type
        in: query
        schema:
          type: string
      - description: The name of the repo.
        name: name
        in: query
        schema:
          type: string
      - description: Whether helm-oci support should be enabled for this repo.
        name: enableOci
        in: query
        schema:
          type: boolean
      - description: Github App Private Key PEM data.
        name: githubAppPrivateKey
        in: query
        schema:
          type: string
      - description: Github App ID of the app used to access the repo.
        name: githubAppID
        in: query
        schema:
          type: string
          format: int64
      - description: Github App Installation ID of the installed GitHub App.
        name: githubAppInstallationID
        in: query
        schema:
          type: string
          format: int64
      - description: Github App Enterprise base url if empty will default to https://api.github.com.
        name: githubAppEnterpriseBaseUrl
        in: query
        schema:
          type: string
      - description: HTTP/HTTPS proxy to access the repository.
        name: proxy
        in: query
        schema:
          type: string
      - description: Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity.
        name: project
        in: query
        schema:
          type: string
      - description: Google Cloud Platform service account key.
        name: gcpServiceAccountKey
        in: query
        schema:
          type: string
      - description: Whether to force HTTP basic auth.
        name: forceHttpBasicAuth
        in: query
        schema:
          type: boolean
      - description: Whether to use azure workload identity for authentication.
        name: useAzureWorkloadIdentity
        in: query
        schema:
          type: boolean
      - description: BearerToken contains the bearer token used for Git auth at the repo server.
        name: bearerToken
        in: query
        schema:
          type: string
      - description: Whether https should be disabled for an OCI repo.
        name: insecureOciForceHttp
        in: query
        schema:
          type: boolean
      - description: Azure Service Principal Client ID.
        name: azureServicePrincipalClientId
        in: query
        schema:
          type: string
      - description: Azure Service Principal Client Secret.
        name: azureServicePrincipalClientSecret
        in: query
        schema:
          type: string
      - description: Azure Service Principal Tenant ID.
        name: azureServicePrincipalTenantId
        in: query
        schema:
          type: string
      - description: Azure Active Directory Endpoint.
        name: azureActiveDirectoryEndpoint
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: The URL to the repo
        required: true
  /api/v1/repositories/{source.repoURL}/appdetails:
    post:
      tags:
      - RepositoryService
      summary: GetAppDetails returns application details by given path
      operationId: RepositoryService_GetAppDetails
      parameters:
      - description: RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
        name: source.repoURL
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoAppDetailsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/repositoryRepoAppDetailsQuery'
        required: true
  /api/v1/write-repositories:
    get:
      tags:
      - RepositoryService
      summary: ListWriteRepositories gets a list of all configured write repositories
      operationId: RepositoryService_ListWriteRepositories
      parameters:
      - description: Repo URL for query.
        name: repo
        in: query
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1RepositoryList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
    post:
      tags:
      - RepositoryService
      summary: CreateWriteRepository creates a new write repository configuration
      operationId: RepositoryService_CreateWriteRepository
      parameters:
      - description: Whether to create in upsert mode.
        name: upsert
        in: query
        schema:
          type: boolean
      - description: Whether to operate on credential set instead of repository.
        name: credsOnly
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1alpha1Repository'
        description: Repository definition
        required: true
  /api/v1/write-repositories/{repo.repo}:
    put:
      tags:
      - RepositoryService
      summary: UpdateWriteRepository updates a write repository configuration
      operationId: RepositoryService_UpdateWriteRepository
      parameters:
      - description: Repo contains the URL to the remote repository
        name: repo.repo
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1alpha1Repository'
        required: true
  /api/v1/write-repositories/{repo}:
    get:
      tags:
      - RepositoryService
      summary: GetWrite returns a repository or its write credentials
      operationId: RepositoryService_GetWrite
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1alpha1Repository'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
    delete:
      tags:
      - RepositoryService
      summary: DeleteWriteRepository deletes a write repository from the configuration
      operationId: RepositoryService_DeleteWriteRepository
      parameters:
      - description: Repo URL for query
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Whether to force a cache refresh on repo's connection state.
        name: forceRefresh
        in: query
        schema:
          type: boolean
      - description: App project for query.
        name: appProject
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
  /api/v1/write-repositories/{repo}/validate:
    post:
      tags:
      - RepositoryService
      summary: ValidateWriteAccess validates write access to a repository with given parameters
      operationId: RepositoryService_ValidateWriteAccess
      parameters:
      - description: The URL to the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: Username for accessing repo.
        name: username
        in: query
        schema:
          type: string
      - description: Password for accessing repo.
        name: password
        in: query
        schema:
          type: string
      - description: Private key data for accessing SSH repository.
        name: sshPrivateKey
        in: query
        schema:
          type: string
      - description: Whether to skip certificate or host key validation.
        name: insecure
        in: query
        schema:
          type: boolean
      - description: TLS client cert data for accessing HTTPS repository.
        name: tlsClientCertData
        in: query
        schema:
          type: string
      - description: TLS client cert key for accessing HTTPS repository.
        name: tlsClientCertKey
        in: query
        schema:
          type: string
      - description: The type of the repo.
        name: type
        in: query
        schema:
          type: string
      - description: The name of the repo.
        name: name
        in: query
        schema:
          type: string
      - description: Whether helm-oci support should be enabled for this repo.
        name: enableOci
        in: query
        schema:
          type: boolean
      - description: Github App Private Key PEM data.
        name: githubAppPrivateKey
        in: query
        schema:
          type: string
      - description: Github App ID of the app used to access the repo.
        name: githubAppID
        in: query
        schema:
          type: string
          format: int64
      - description: Github App Installation ID of the installed GitHub App.
        name: githubAppInstallationID
        in: query
        schema:
          type: string
          format: int64
      - description: Github App Enterprise base url if empty will default to https://api.github.com.
        name: githubAppEnterpriseBaseUrl
        in: query
        schema:
          type: string
      - description: HTTP/HTTPS proxy to access the repository.
        name: proxy
        in: query
        schema:
          type: string
      - description: Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity.
        name: project
        in: query
        schema:
          type: string
      - description: Google Cloud Platform service account key.
        name: gcpServiceAccountKey
        in: query
        schema:
          type: string
      - description: Whether to force HTTP basic auth.
        name: forceHttpBasicAuth
        in: query
        schema:
          type: boolean
      - description: Whether to use azure workload identity for authentication.
        name: useAzureWorkloadIdentity
        in: query
        schema:
          type: boolean
      - description: BearerToken contains the bearer token used for Git auth at the repo server.
        name: bearerToken
        in: query
        schema:
          type: string
      - description: Whether https should be disabled for an OCI repo.
        name: insecureOciForceHttp
        in: query
        schema:
          type: boolean
      - description: Azure Service Principal Client ID.
        name: azureServicePrincipalClientId
        in: query
        schema:
          type: string
      - description: Azure Service Principal Client Secret.
        name: azureServicePrincipalClientSecret
        in: query
        schema:
          type: string
      - description: Azure Service Principal Tenant ID.
        name: azureServicePrincipalTenantId
        in: query
        schema:
          type: string
      - description: Azure Active Directory Endpoint.
        name: azureActiveDirectoryEndpoint
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/repositoryRepoResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: The URL to the repo
        required: true
components:
  schemas:
    v1alpha1ApplicationSourceHelm:
      type: object
      title: ApplicationSourceHelm holds helm specific options
      properties:
        apiVersions:
          description: 'APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,

            Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.'
          type: array
          items:
            type: string
        fileParameters:
          type: array
          title: FileParameters are file parameters to the helm template
          items:
            $ref: '#/components/schemas/v1alpha1HelmFileParameter'
        ignoreMissingValueFiles:
          type: boolean
          title: IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
        kubeVersion:
          description: 'KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD

            uses the Kubernetes version of the target cluster.'
          type: string
        namespace:
          description: Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
          type: string
        parameters:
          type: array
          title: Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
          items:
            $ref: '#/components/schemas/v1alpha1HelmParameter'
        passCredentials:
          type: boolean
          title: PassCredentials pass credentials to all domains (Helm's --pass-credentials)
        releaseName:
          type: string
          title: ReleaseName is the Helm release name to use. If omitted it will use the application name
        skipCrds:
          type: boolean
          title: SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
        skipSchemaValidation:
          type: boolean
          title: SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
        skipTests:
          description: SkipTests skips test manifest installation step (Helm's --skip-tests).
          type: boolean
        valueFiles:
          type: array
          title: ValuesFiles is a list of Helm value files to use when generating a template
          items:
            type: string
        values:
          type: string
          title: 'Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

            +patchStrategy=replace'
        valuesObject:
          $ref: '#/components/schemas/runtimeRawExtension'
        version:
          type: string
          title: Version is the Helm version to use for templating ("3")
    v1alpha1RepositoryList:
      description: RepositoryList is a collection of Repositories.
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/v1alpha1Repository'
        metadata:
          $ref: '#/components/schemas/v1ListMeta'
    v1alpha1KustomizeReplica:
      type: object
      properties:
        count:
          $ref: '#/components/schemas/intstrIntOrString'
        name:
          type: string
          title: Name of Deployment or StatefulSet
    repositoryRepoAppsResponse:
      type: object
      title: RepoAppsResponse contains applications of specified repository
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/repositoryAppInfo'
    intstrIntOrString:
      description: '+protobuf=true

        +protobuf.options.(gogoproto.goproto_stringer)=false

        +k8s:openapi-gen=true'
      type: object
      title: 'IntOrString is a type that can hold an int32 or a string.  When used in

        JSON or YAML marshalling and unmarshalling, it produces or consumes the

        inner type.  This allows you to have, for example, a JSON field that can

        accept a name or number.

        TODO: Rename to Int32OrString'
      properties:
        intVal:
          type: integer
          format: int32
        strVal:
          type: string
        type:
          type: integer
          format: int64
    runtimeError:
      type: object
      properties:
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
        error:
          type: string
        message:
          type: string
    v1alpha1KustomizeResId:
      type: object
      properties:
        gvk:
          $ref: '#/components/schemas/v1alpha1KustomizeGvk'
        name:
          type: string
        namespace:
          type: string
    repositoryRepoAppDetailsQuery:
      type: object
      title: RepoAppDetailsQuery contains query information for app details request
      properties:
        appName:
          type: string
        appProject:
          type: string
        source:
          $ref: '#/components/schemas/v1alpha1ApplicationSource'
        sourceIndex:
          type: integer
          format: int32
          title: source index (for multi source apps)
        versionId:
          type: integer
          format: int32
          title: versionId from historical data (for multi source apps)
    v1alpha1ApplicationSourceDirectory:
      type: object
      title: ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
      properties:
        exclude:
          type: string
          title: Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
        include:
          type: string
          title: Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
        jsonnet:
          $ref: '#/components/schemas/v1alpha1ApplicationSourceJsonnet'
        recurse:
          type: boolean
          title: Recurse specifies whether to scan a directory recursively for manifests
    v1alpha1KustomizeGvk:
      type: object
      properties:
        group:
          type: string
        kind:
          type: string
        version:
          type: string
    applicationv1alpha1EnvEntry:
      type: object
      title: EnvEntry represents an entry in the application's environment
      properties:
        name:
          type: string
          title: Name is the name of the variable, usually expressed in uppercase
        value:
          type: string
          title: Value is the value of the variable
    v1alpha1ApplicationSourcePluginParameter:
      type: object
      properties:
        array:
          description: Array is the value of an array type parameter.
          type: array
          items:
            type: string
        map:
          description: Map is the value of a map type parameter.
          type: object
          additionalProperties:
            type: string
        name:
          description: Name is the name identifying a parameter.
          type: string
        string:
          

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argocd/refs/heads/main/openapi/argocd-repositoryservice-api-openapi.yml