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 Edge Stacks, which are collections of containerized applications deployed on edge computing groups. The Get operation for the Edge Stack resource retrieves detailed information about a specific Edge Stack by its unique ID.
Use cases include:
- Fetching configuration and status details of an existing Edge Stack in your edge computing environment.
- Automating monitoring or auditing of deployed Edge Stacks.
- Integrating Edge Stack data retrieval into workflows that manage or report on edge deployments.
For example, you might use this node to get the current configuration of an Edge Stack before updating it or to verify deployment details as part of a CI/CD pipeline.
Properties
| Name | Meaning |
|---|---|
| Edge Stack ID | The unique identifier of the edge stack to retrieve. This is required to specify which Edge Stack's details to fetch. |
Output
The node outputs JSON data representing the full details of the specified Edge Stack as returned by the Portainer API. This typically includes properties such as the stack's name, deployment type, associated edge groups, stack file content (e.g., docker-compose.yml), environment variables, deployment options like pre-pulling images, retry settings, and other metadata.
No binary data output is involved in this operation.
Dependencies
- Requires connection to a Portainer instance via its API.
- 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.
Troubleshooting
- Invalid or missing Edge Stack ID: Ensure the Edge Stack ID provided is correct and exists in your Portainer environment.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access Edge Stack resources.
- Network issues: Confirm that the n8n instance can reach the Portainer API endpoint.
- API version mismatch: Make sure the Portainer API version matches what the node expects (the node uses
/apibase path).
Common error messages may include HTTP 404 if the Edge Stack ID does not exist, or 401/403 for authentication/authorization failures. Resolving these involves checking the input ID and API credentials.
Links and References
- Portainer API Documentation - Edge Stacks
- Portainer Official Website
- Docker Compose File Reference (relevant for stack file content)