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 resources programmatically. Specifically, for the Config resource with the Get Many operation, it retrieves a list of Docker Swarm configs available in a specified Docker environment managed by Portainer.
Typical use cases include:
- Automating retrieval of all Docker Swarm configs for auditing or synchronization.
- Integrating Docker config data into workflows for deployment or monitoring.
- Fetching configs to dynamically adjust container or service configurations based on external inputs.
For example, you might use this node to get all configs from a particular Docker environment and then process or display them in a dashboard or trigger further automation steps.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Docker environment/endpoint in Portainer from which to retrieve configs. |
The Environment ID is required and specifies the target Docker environment managed by Portainer where the configs reside.
Output
The node outputs JSON data representing the list of Docker Swarm configs retrieved from the specified environment. Each item in the output array corresponds to a config object as returned by the Portainer API, typically including details such as:
- Config ID
- Name
- Labels (if any)
- Creation date
- Other metadata related to the Docker Swarm config
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 base URL of the Portainer API must be set in the credentials.
- The node uses the Portainer REST API endpoint
/endpoints/{environmentId}/docker/configswith HTTP GET method to fetch configs.
Troubleshooting
- Invalid Environment ID: If the environment ID does not exist or is incorrect, the API will return an error. Verify the environment ID in Portainer.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access the configs.
- Network Issues: Confirm that n8n can reach the Portainer API endpoint URL.
- Empty Results: If no configs are returned, verify that there are actually configs created in the specified environment.
- API Rate Limits or Timeouts: Large numbers of configs may cause delays; consider filtering or paginating if supported.