RepositoryService

GetWrite returns a repository or its write credentials

GET

https://argocd.example.com/api/v1/write-repositories/{repo}

curl -X GET 'https://argocd.example.com/api/v1/write-repositories/string' \
  -H 'Authorization: YOUR_TOKEN'

const response = await fetch('https://argocd.example.com/api/v1/write-repositories/string', {
  method: 'GET',
  headers: {
    'Authorization': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://argocd.example.com/api/v1/write-repositories/string',
    headers={
        'Authorization': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "azureActiveDirectoryEndpoint": "string",
  "azureServicePrincipalClientId": "string",
  "azureServicePrincipalClientSecret": "string",
  "azureServicePrincipalTenantId": "string",
  "bearerToken": "string",
  "connectionState": {
    "attemptedAt": "2024-01-15T09:30:00Z",
    "message": "string",
    "status": "string"
  },
  "depth": 0,
  "enableLfs": true,
  "enableOCI": true,
  "forceHttpBasicAuth": true,
  "gcpServiceAccountKey": "string",
  "githubAppEnterpriseBaseUrl": "string",
  "githubAppID": 0,
  "githubAppInstallationID": 0,
  "githubAppPrivateKey": "string",
  "inheritedCreds": true,
  "insecure": true,
  "insecureIgnoreHostKey": true,
  "insecureOCIForceHttp": true,
  "name": "string",
  "noProxy": "string",
  "password": "string",
  "project": "string",
  "proxy": "string",
  "repo": "string",
  "sshPrivateKey": "string",
  "tlsClientCertData": "string",
  "tlsClientCertKey": "string",
  "type": "string",
  "useAzureWorkloadIdentity": true,
  "username": "string",
  "webhookManifestCacheWarmDisabled": true
}

{
  "code": 0,
  "details": [
    {
      "type_url": "string",
      "value": "dGVzdA=="
    }
  ],
  "error": "string",
  "message": "string"
}

Parameters

repostringrequiredpath

Repo URL for query

forceRefreshbooleanquery

Whether to force a cache refresh on repo's connection state.

appProjectstringquery

App project for query.

Response

200OKv1alpha1Repository

A successful response.

Response fields application/json

azureActiveDirectoryEndpointstring

azureServicePrincipalClientIdstring

azureServicePrincipalClientSecretstring

azureServicePrincipalTenantIdstring

bearerTokenstring

connectionStatev1alpha1ConnectionState

Show child attributes

attemptedAtv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring

statusstring

depthinteger<int64>

Depth specifies the depth for shallow clones. A value of 0 or omitting the field indicates a full clone.

enableLfsboolean

EnableLFS specifies whether git-lfs support should be enabled for this repo. Only valid for Git repositories.

enableOCIboolean

forceHttpBasicAuthboolean

gcpServiceAccountKeystring

githubAppEnterpriseBaseUrlstring

githubAppIDinteger<int64>

githubAppInstallationIDinteger<int64>

githubAppPrivateKeystring

inheritedCredsboolean

insecureboolean

insecureIgnoreHostKeyboolean

insecureOCIForceHttpboolean

InsecureOCIForceHttp specifies whether the connection to the repository uses TLS at all. If true, no TLS. This flag is applicable for OCI repos only.

namestring

noProxystring

passwordstring

projectstring

proxystring

repostring

sshPrivateKeystring

SSHPrivateKey contains the PEM data for authenticating at the repo server. Only used with Git repos.

tlsClientCertDatastring

tlsClientCertKeystring

typestring

Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.

useAzureWorkloadIdentityboolean

usernamestring

webhookManifestCacheWarmDisabledboolean

WebhookManifestCacheWarmDisabled disables manifest cache warming during webhook processing for this repository. When set, webhook handlers will only trigger reconciliation for affected applications and skip Redis cache operations for unaffected ones. Recommended for large monorepos with plain YAML manifests.

defaultruntimeError

An unexpected error response.

Response fields application/json

codeinteger<int32>

detailsArray<protobufAny>

Show child attributes

type_urlstring

valuestring<byte>

errorstring

messagestring

Authorization

bearerapiKey in header

A token sent as Authorization: Bearer <token>. API Docs shows how to get one.

Docs by Sourcey