v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB

settings

Retrieve Portainer settings

Retrieve Portainer settings. Access policy: administrator

get/settings

Response

Success

AgentSecretstring

Container environment parameter AGENT_SECRET

AllowBindMountsForRegularUsersboolean

AllowContainerCapabilitiesForRegularUsersboolean

AllowDeviceMappingForRegularUsersboolean

AllowHostNamespaceForRegularUsersboolean

AllowPrivilegedModeForRegularUsersboolean

AllowStackManagementForRegularUsersboolean

AllowVolumeBrowserForRegularUsersboolean

AuthenticationMethod0 | 1 | 2 | 3

DisplayDonationHeaderboolean

Deprecated fields

DisplayExternalContributorsboolean

EdgeAgentCheckinIntervalinteger

The default check in interval for edge agent (in seconds)

EdgePortainerUrlstring

EdgePortainerURL is the URL that is exposed to edge agents

EnableEdgeComputeFeaturesboolean

Whether edge compute features are enabled

EnableHostManagementFeaturesboolean

Deprecated fields v26

EnforceEdgeIDboolean

EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone

FeatureFlagSettingsobject

ForceSecureCookiesboolean

ForceSecureCookies forces the Secure attribute on auth cookies regardless of detected scheme. Enable when Portainer runs behind a TLS-terminating proxy.

HelmRepositoryURLstring

Helm repository URL, defaults to "https://charts.bitnami.com/bitnami"

IsDockerDesktopExtensionboolean

KubeconfigExpirystring

The expiry of a Kubeconfig

KubectlShellImagestring

KubectlImage, defaults to portainer/kubectl-shell

LogoURLstring

URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string

SnapshotIntervalstring

The interval in which environment(endpoint) snapshots are created

TemplatesURLstring

URL to the templates that will be displayed in the UI when navigating to App Templates

TrustOnFirstConnectboolean

TrustOnFirstConnect makes Portainer accepting edge agent connection by default

UserSessionTimeoutstring

The duration of a user session

Example response

{
  "BlackListedLabels": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "Edge": {
    "CommandInterval": 5,
    "PingInterval": 5,
    "SnapshotInterval": 5
  },
  "EdgeAgentCheckinInterval": 5,
  "HelmRepositoryURL": "https://charts.bitnami.com/bitnami",
  "KubeconfigExpiry": "24h",
  "KubectlShellImage": "portainer/kubectl-shell",
  "LDAPSettings": {
    "AnonymousMode": true,
    "AutoCreateUsers": true,
    "GroupSearchSettings": [
      {
        "GroupAttribute": "member",
        "GroupBaseDN": "dc=ldap,dc=domain,dc=tld",
        "GroupFilter": "(objectClass=account"
      }
    ],
    "Password": "readonly-password",
    "ReaderDN": "cn=readonly-account,dc=ldap,dc=domain,dc=tld",
    "SearchSettings": [
      {
        "BaseDN": "dc=ldap,dc=domain,dc=tld",
        "Filter": "(objectClass=account)",
        "UserNameAttribute": "uid"
      }
    ],
    "StartTLS": true,
    "TLSConfig": {
      "TLS": true,
      "TLSCACert": "/data/tls/ca.pem",
      "TLSCert": "/data/tls/cert.pem",
      "TLSKey": "/data/tls/key.pem"
    },
    "URL": "myldap.domain.tld:389"
  },
  "LogoURL": "https://mycompany.mydomain.tld/logo.png",
  "SnapshotInterval": "5m",
  "TemplatesURL": "https://raw.githubusercontent.com/portainer/templates/master/templates.json",
  "UserSessionTimeout": "5m"
}