RepositoryService

ValidateWriteAccess validates write access to a repository with given parameters

POST

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

curl -X POST 'https://argocd.example.com/api/v1/write-repositories/string/validate' \
  -H 'Authorization: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '"string"'

const response = await fetch('https://argocd.example.com/api/v1/write-repositories/string/validate', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body: '"string"',
});

const data = await response.text();

import requests

response = requests.post(
    'https://argocd.example.com/api/v1/write-repositories/string/validate',
    data='"string"'.encode('utf-8'),
    headers={
        'Authorization': 'YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

"string"

{}

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

Body

application/json

The URL to the repo

string

Parameters

repostringrequiredpath

The URL to the repo

usernamestringquery

Username for accessing repo.

passwordstringquery

Password for accessing repo.

sshPrivateKeystringquery

Private key data for accessing SSH repository.

insecurebooleanquery

Whether to skip certificate or host key validation.

tlsClientCertDatastringquery

TLS client cert data for accessing HTTPS repository.

tlsClientCertKeystringquery

TLS client cert key for accessing HTTPS repository.

typestringquery

The type of the repo.

namestringquery

The name of the repo.

enableOcibooleanquery

Whether helm-oci support should be enabled for this repo.

githubAppPrivateKeystringquery

Github App Private Key PEM data.

githubAppIDstring<int64>query

Github App ID of the app used to access the repo.

githubAppInstallationIDstring<int64>query

Github App Installation ID of the installed GitHub App.

githubAppEnterpriseBaseUrlstringquery

Github App Enterprise base url if empty will default to https://api.github.com.

proxystringquery

HTTP/HTTPS proxy to access the repository.

projectstringquery

Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity.

gcpServiceAccountKeystringquery

Google Cloud Platform service account key.

forceHttpBasicAuthbooleanquery

Whether to force HTTP basic auth.

useAzureWorkloadIdentitybooleanquery

Whether to use azure workload identity for authentication.

bearerTokenstringquery

BearerToken contains the bearer token used for Git auth at the repo server.

insecureOciForceHttpbooleanquery

Whether https should be disabled for an OCI repo.

azureServicePrincipalClientIdstringquery

Azure Service Principal Client ID.

azureServicePrincipalClientSecretstringquery

Azure Service Principal Client Secret.

azureServicePrincipalTenantIdstringquery

Azure Service Principal Tenant ID.

azureActiveDirectoryEndpointstringquery

Azure Active Directory Endpoint.

Response

200OKrepositoryRepoResponse

A successful response.

Response fields application/json

repositoryRepoResponse

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