SettingsService

Get returns Argo CD settings

GET

https://argocd.example.com/api/v1/settings

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

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

const data = await response.text();

import requests

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

{
  "additionalUrls": [
    "string"
  ],
  "appLabelKey": "string",
  "appsInAnyNamespaceEnabled": true,
  "configManagementPlugins": [
    {
      "generate": {
        "args": [
          "string"
        ],
        "command": [
          "string"
        ]
      },
      "init": {
        "args": [
          "string"
        ],
        "command": [
          "string"
        ]
      },
      "lockRepo": true,
      "name": "string"
    }
  ],
  "controllerNamespace": "string",
  "dexConfig": {
    "connectors": [
      {
        "id": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "dexAuthConnectorID": "string"
  },
  "execEnabled": true,
  "googleAnalytics": {
    "anonymizeUsers": true,
    "trackingID": "string"
  },
  "help": {
    "binaryUrls": {},
    "chatText": "string",
    "chatUrl": "string"
  },
  "hydratorEnabled": true,
  "impersonationEnabled": true,
  "installationID": "string",
  "kustomizeOptions": {
    "binaryPath": "string",
    "buildOptions": "string",
    "versions": [
      {
        "buildOptions": "string",
        "name": "string",
        "path": "string"
      }
    ]
  },
  "kustomizeVersions": [
    "string"
  ],
  "oidcConfig": {
    "cliClientID": "string",
    "clientID": "string",
    "enablePKCEAuthentication": true,
    "idTokenClaims": {},
    "issuer": "string",
    "name": "string",
    "scopes": [
      "string"
    ]
  },
  "passwordPattern": "string",
  "plugins": [
    {
      "name": "string"
    }
  ],
  "resourceOverrides": {},
  "resourceViewEnabled": true,
  "statusBadgeEnabled": true,
  "statusBadgeRootUrl": "string",
  "syncWithReplaceAllowed": true,
  "trackingMethod": "string",
  "uiBannerContent": "string",
  "uiBannerPermanent": true,
  "uiBannerPosition": "string",
  "uiBannerURL": "string",
  "uiCssURL": "string",
  "uiLoginButtonText": "string",
  "url": "string",
  "userLoginsDisabled": true
}

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

Response

200OKclusterSettings

A successful response.

Response fields application/json

additionalUrlsArray<string>

appLabelKeystring

appsInAnyNamespaceEnabledboolean

configManagementPluginsArray<v1alpha1ConfigManagementPlugin>

Deprecated: use sidecar plugins instead.

Show child attributes

generatev1alpha1Command

Show child attributes

argsArray<string>

commandArray<string>

initv1alpha1Command

Show child attributes

argsArray<string>

commandArray<string>

lockRepoboolean

namestring

controllerNamespacestring

dexConfigclusterDexConfig

Show child attributes

connectorsArray<clusterConnector>

Show child attributes

idstring

namestring

typestring

dexAuthConnectorIDstring

execEnabledboolean

googleAnalyticsclusterGoogleAnalyticsConfig

Show child attributes

anonymizeUsersboolean

trackingIDstring

helpclusterHelp

Show child attributes

binaryUrlsobject

Show child attributes

[key: string]string

chatTextstring

chatUrlstring

hydratorEnabledboolean

impersonationEnabledboolean

installationIDstring

kustomizeOptionsv1alpha1KustomizeOptions

Show child attributes

binaryPathstring

Deprecated: Use settings.Settings instead. See: settings.Settings.KustomizeVersions. If this field is set, it will be used as the Kustomize binary path. Otherwise, Versions is used.

buildOptionsstring

versionsArray<v1alpha1KustomizeVersion>

Versions is a list of Kustomize versions and their corresponding binary paths and build options.

Show child attributes

buildOptionsstring

namestring

pathstring

kustomizeVersionsArray<string>

oidcConfigclusterOIDCConfig

Show child attributes

cliClientIDstring

clientIDstring

enablePKCEAuthenticationboolean

idTokenClaimsobject

Show child attributes

[key: string]oidcClaim

Show child attributes

essentialboolean

valuestring

valuesArray<string>

issuerstring

namestring

scopesArray<string>

passwordPatternstring

pluginsArray<clusterPlugin>

Show child attributes

namestring

resourceOverridesobject

Show child attributes

[key: string]v1alpha1ResourceOverride

Show child attributes

actionsstring

Actions defines the set of actions that can be performed on the resource, as a Lua script.

healthLuastring

HealthLua contains a Lua script that defines custom health checks for the resource.

ignoreDifferencesv1alpha1OverrideIgnoreDiff

Show child attributes

jSONPointersArray<string>

jqPathExpressionsArray<string>

managedFieldsManagersArray<string>

ignoreResourceUpdatesv1alpha1OverrideIgnoreDiff

Show child attributes

jSONPointersArray<string>

jqPathExpressionsArray<string>

managedFieldsManagersArray<string>

knownTypeFieldsArray<v1alpha1KnownTypeField>

KnownTypeFields lists fields for which unit conversions should be applied.

Show child attributes

KnownTypeField contains a mapping between a Custom Resource Definition (CRD) field and a well-known Kubernetes type. This mapping is primarily used for unit conversions in resources where the type is not explicitly defined (e.g., converting "0.1" to "100m" for CPU requests).

fieldstring

typestring

Type specifies the expected Kubernetes type for the field, such as "cpu" or "memory". This helps in converting values between different formats (e.g., "0.1" to "100m" for CPU).

useOpenLibsboolean

UseOpenLibs indicates whether to use open-source libraries for the resource.

resourceViewEnabledboolean

statusBadgeEnabledboolean

statusBadgeRootUrlstring

syncWithReplaceAllowedboolean

trackingMethodstring

uiBannerContentstring

uiBannerPermanentboolean

uiBannerPositionstring

uiBannerURLstring

uiCssURLstring

uiLoginButtonTextstring

urlstring

userLoginsDisabledboolean

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