--- title: "Update Portainer settings" method: PUT path: "/settings" tags: ["settings"] --- # Update Portainer settings `PUT /settings` Update Portainer settings. **Access policy**: administrator ## Request body - SettingsSettingsUpdatePayload - `AuthenticationMethod` integer — Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth - `BlackListedLabels` PortainerPair[] — A list of label name & value that will be used to hide containers when querying containers - `name` string, required - `value` string, required - `EdgeAgentCheckinInterval` integer - `EdgePortainerURL` string — EdgePortainerURL is the URL that is exposed to edge agents - `EnableEdgeComputeFeatures` boolean — Whether edge compute features are enabled - `EnforceEdgeID` boolean — EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone - `ForceSecureCookies` boolean — ForceSecureCookies forces the Secure attribute on auth cookies regardless of the detected scheme - `GlobalDeploymentOptions` PortainerGlobalDeploymentOptions - `hideStacksFunctionality` boolean - `HelmRepositoryURL` string — Helm repository URL - `InternalAuthSettings` PortainerInternalAuthSettings - `RequiredPasswordLength` integer - `KubeconfigExpiry` string — The expiry of a Kubeconfig - `KubectlShellImage` string — Kubectl Shell Image - `LDAPSettings` PortainerLDAPSettings - `AnonymousMode` boolean — Enable this option if the server is configured for Anonymous access. When enabled, ReaderDN and Password will not be used - `AutoCreateUsers` boolean — Automatically provision users and assign them to matching LDAP group names - `GroupSearchSettings` PortainerLDAPGroupSearchSettings[] - `GroupAttribute` string — LDAP attribute which denotes the group membership - `GroupBaseDN` string — The distinguished name of the element from which the LDAP server will search for groups - `GroupFilter` string — The LDAP search filter used to select group elements, optional - `Password` string — Password of the account that will be used to search users - `ReaderDN` string — Account that will be used to search for users - `SearchSettings` PortainerLDAPSearchSettings[] - `BaseDN` string — The distinguished name of the element from which the LDAP server will search for users - `Filter` string — Optional LDAP search filter used to select user elements - `UserNameAttribute` string — LDAP attribute which denotes the username - `StartTLS` boolean — Whether LDAP connection should use StartTLS - `TLSConfig` PortainerTLSConfiguration - `TLS` boolean, required — Use TLS - `TLSCACert` string — Path to the TLS CA certificate file - `TLSCert` string — Path to the TLS client certificate file - `TLSKey` string — Path to the TLS client key file - `TLSSkipVerify` boolean, required — Skip the verification of the server TLS certificate - `URL` string — URL or IP address of the LDAP server - `LogoURL` string — 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 - `OAuthSettings` PortainerOAuthSettings - `AccessTokenURI` string - `AuthStyle` 0 | 1 | 2 - `AuthorizationURI` string - `ClientID` string - `ClientSecret` string - `DefaultTeamID` integer - `KubeSecretKey` integer[] - `LogoutURI` string - `OAuthAutoCreateUsers` boolean - `RedirectURI` string - `ResourceURI` string - `SSO` boolean - `Scopes` string - `UserIdentifier` string - `SnapshotInterval` string — The interval in which environment(endpoint) snapshots are created - `TemplatesURL` string — URL to the templates that will be displayed in the UI when navigating to App Templates - `TrustOnFirstConnect` boolean — TrustOnFirstConnect makes Portainer accepting edge agent connection by default - `UserSessionTimeout` string — The duration of a user session ## Response `200` Success - PortainerSettings - `AgentSecret` string — Container environment parameter AGENT_SECRET - `AllowBindMountsForRegularUsers` boolean - `AllowContainerCapabilitiesForRegularUsers` boolean - `AllowDeviceMappingForRegularUsers` boolean - `AllowHostNamespaceForRegularUsers` boolean - `AllowPrivilegedModeForRegularUsers` boolean - `AllowStackManagementForRegularUsers` boolean - `AllowVolumeBrowserForRegularUsers` boolean - `AuthenticationMethod` 0 | 1 | 2 | 3 - `BlackListedLabels` PortainerPair[] — A list of label name & value that will be used to hide containers when querying containers - `name` string, required - `value` string, required - `DisplayDonationHeader` boolean — Deprecated fields - `DisplayExternalContributors` boolean - `Edge` PortainerEdge - `AsyncMode` boolean — Deprecated 2.18 - `CommandInterval` integer — The command list interval for edge agent - used in edge async mode (in seconds) - `PingInterval` integer — The ping interval for edge agent - used in edge async mode (in seconds) - `SnapshotInterval` integer — The snapshot interval for edge agent - used in edge async mode (in seconds) - `EdgeAgentCheckinInterval` integer — The default check in interval for edge agent (in seconds) - `EdgePortainerUrl` string — EdgePortainerURL is the URL that is exposed to edge agents - `EnableEdgeComputeFeatures` boolean — Whether edge compute features are enabled - `EnableHostManagementFeatures` boolean — Deprecated fields v26 - `EnforceEdgeID` boolean — EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone - `FeatureFlagSettings` object - `ForceSecureCookies` boolean — ForceSecureCookies forces the Secure attribute on auth cookies regardless of detected scheme. Enable when Portainer runs behind a TLS-terminating proxy. - `GlobalDeploymentOptions` PortainerGlobalDeploymentOptions - `hideStacksFunctionality` boolean - `HelmRepositoryURL` string — Helm repository URL, defaults to "https://charts.bitnami.com/bitnami" - `InternalAuthSettings` PortainerInternalAuthSettings - `RequiredPasswordLength` integer - `IsDockerDesktopExtension` boolean - `KubeconfigExpiry` string — The expiry of a Kubeconfig - `KubectlShellImage` string — KubectlImage, defaults to portainer/kubectl-shell - `LDAPSettings` PortainerLDAPSettings - `AnonymousMode` boolean — Enable this option if the server is configured for Anonymous access. When enabled, ReaderDN and Password will not be used - `AutoCreateUsers` boolean — Automatically provision users and assign them to matching LDAP group names - `GroupSearchSettings` PortainerLDAPGroupSearchSettings[] - `GroupAttribute` string — LDAP attribute which denotes the group membership - `GroupBaseDN` string — The distinguished name of the element from which the LDAP server will search for groups - `GroupFilter` string — The LDAP search filter used to select group elements, optional - `Password` string — Password of the account that will be used to search users - `ReaderDN` string — Account that will be used to search for users - `SearchSettings` PortainerLDAPSearchSettings[] - `BaseDN` string — The distinguished name of the element from which the LDAP server will search for users - `Filter` string — Optional LDAP search filter used to select user elements - `UserNameAttribute` string — LDAP attribute which denotes the username - `StartTLS` boolean — Whether LDAP connection should use StartTLS - `TLSConfig` PortainerTLSConfiguration - `TLS` boolean, required — Use TLS - `TLSCACert` string — Path to the TLS CA certificate file - `TLSCert` string — Path to the TLS client certificate file - `TLSKey` string — Path to the TLS client key file - `TLSSkipVerify` boolean, required — Skip the verification of the server TLS certificate - `URL` string — URL or IP address of the LDAP server - `LogoURL` string — 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 - `OAuthSettings` PortainerOAuthSettings - `AccessTokenURI` string - `AuthStyle` 0 | 1 | 2 - `AuthorizationURI` string - `ClientID` string - `ClientSecret` string - `DefaultTeamID` integer - `KubeSecretKey` integer[] - `LogoutURI` string - `OAuthAutoCreateUsers` boolean - `RedirectURI` string - `ResourceURI` string - `SSO` boolean - `Scopes` string - `UserIdentifier` string - `SnapshotInterval` string — The interval in which environment(endpoint) snapshots are created - `TemplatesURL` string — URL to the templates that will be displayed in the UI when navigating to App Templates - `TrustOnFirstConnect` boolean — TrustOnFirstConnect makes Portainer accepting edge agent connection by default - `UserSessionTimeout` string — The duration of a user session ## Other responses - `400` — Invalid request - `500` — Server error --- [API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/c0b0975cd11b/schema)