Sign in

v13

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

Retrieve Portainer public settings

Retrieve public settings. Returns a small set of settings that are not reserved to administrators only. Access policy: public

get/settings/public

Response

Success

AuthenticationMethod0 | 1 | 2 | 3
EnableEdgeComputeFeaturesboolean

Whether edge compute features are enabled

Featuresobject

Supported feature flags

IsDockerDesktopExtensionboolean
KubeconfigExpirystring

The expiry of a Kubeconfig

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

OAuthLoginURIstring

The URL used for oauth login

OAuthLogoutURIstring

The URL used for oauth logout

RequiredPasswordLengthinteger

The minimum required length for a password of any user when using internal auth mode

RequiresSetupTokenboolean

Whether the setup wizard must send the X-Setup-Token header for admin init / restore

TeamSyncboolean

Whether team sync is enabled

Example response

{
  "Edge": {
    "CheckinInterval": 60,
    "CommandInterval": 60,
    "PingInterval": 60,
    "SnapshotInterval": 60
  },
  "EnableEdgeComputeFeatures": true,
  "KubeconfigExpiry": "24h",
  "LogoURL": "https://mycompany.mydomain.tld/logo.png",
  "OAuthLoginURI": "https://gitlab.com/oauth",
  "OAuthLogoutURI": "https://gitlab.com/oauth/logout",
  "RequiredPasswordLength": 1,
  "TeamSync": true
}