Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node integrates with the Portainer API to manage Docker Swarm configs. Specifically, the Config - Get operation retrieves detailed information about a specific Docker Swarm config by its ID within a given Portainer environment (endpoint). This is useful for automation workflows that need to fetch configuration data used in Docker Swarm services, such as secrets, environment variables, or other configuration files managed as configs.
Typical use cases include:
- Retrieving config details before updating or deploying services.
- Auditing or backing up current Docker Swarm configs.
- Integrating config data into CI/CD pipelines or monitoring systems.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Portainer environment/endpoint where the Docker Swarm config resides. |
| Config ID | The unique identifier of the Docker Swarm config to retrieve. |
Output
The node outputs JSON data representing the Docker Swarm config object retrieved from Portainer. This includes all metadata and content details of the config as returned by the Portainer API, such as:
- Config ID
- Name
- Data (usually base64 encoded)
- Labels (if any)
- Creation and update timestamps
- Other Docker Swarm config properties
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to a Portainer instance with API access.
- Needs an API key credential configured in n8n to authenticate requests to the Portainer API.
- The node uses the Portainer API endpoint URL and API key from the credentials to make HTTP GET requests.
Troubleshooting
- Invalid Environment ID or Config ID: If the IDs are incorrect or do not exist, the API will return an error indicating the resource was not found. Verify the IDs in Portainer.
- Authentication errors: Ensure the API key credential is valid and has sufficient permissions to access the specified environment and configs.
- Network issues: Confirm that n8n can reach the Portainer API URL and that there are no firewall or connectivity problems.
- API rate limits or server errors: If Portainer returns 429 or 5xx errors, retry after some time or check the Portainer server health.