Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Setting → Update

AI-generated

Overview

This node operation updates settings in Portainer, a management tool for Docker environments. It allows users to modify various configuration options such as logo URL, blacklisted labels, authentication method, password requirements, user permissions, snapshot intervals, edge compute features, and session timeouts. This operation is useful for administrators who want to customize and control the behavior and security settings of their Portainer instance.

Use Case Examples

  1. An administrator updates the Portainer settings to change the logo URL and enable edge compute features.
  2. A user modifies the authentication method and adjusts password length requirements for enhanced security.

Properties

Name Meaning
Logo URL URL of the logo to display in Portainer.
Blacklisted Labels Comma-separated list of labels to blacklist in Portainer.
Authentication Method Method used for authentication in Portainer.
Required Password Length Minimum password length required for internal authentication.
Allow Container Capabilities for Regular Users Whether regular users are allowed to use container capabilities.
Allow Device Mapping for Regular Users Whether regular users are allowed to map devices.
Allow Stack Management for Regular Users Whether regular users are allowed to manage stacks.
Allow Bind Mounts for Regular Users Whether regular users are allowed to use bind mounts.
Allow Privileged Mode for Regular Users Whether regular users are allowed to use privileged mode.
Allow Host Namespace for Regular Users Whether regular users are allowed to use host namespace.
Snapshot Interval Interval for taking snapshots, e.g., '5m' for 5 minutes.
Enable Edge Compute Features Whether to enable edge compute features.
User Session Timeout Timeout duration for user sessions, e.g., '8h' for 8 hours.

Output

JSON

  • LogoURL - URL of the logo after update.
  • BlackListedLabels - Array of blacklisted labels after update.
  • AuthenticationMethod - Authentication method used after update.
  • InternalAuthSettings
    • RequiredPasswordLength - Required password length after update.
  • AllowContainerCapabilitiesForRegularUsers - Permission for container capabilities for regular users.
  • AllowDeviceMappingForRegularUsers - Permission for device mapping for regular users.
  • AllowStackManagementForRegularUsers - Permission for stack management for regular users.
  • AllowBindMountsForRegularUsers - Permission for bind mounts for regular users.
  • AllowPrivilegedModeForRegularUsers - Permission for privileged mode for regular users.
  • AllowHostNamespaceForRegularUsers - Permission for host namespace for regular users.
  • SnapshotInterval - Snapshot interval setting.
  • EnableEdgeComputeFeatures - Edge compute features enabled status.
  • UserSessionTimeout - User session timeout setting.

Dependencies

  • Portainer API with API key authentication

Troubleshooting

  • Ensure the API key credential is valid and has sufficient permissions to update settings.
  • Verify that the base URL for the Portainer API is correctly configured and accessible.
  • Check that all required parameters are provided and correctly formatted, especially for fields like blacklisted labels and authentication method.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.

Links

Discussion