Actions72
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
Overview
This node integrates with the Portainer API to manage edge computing stacks ("Edge Stacks"). Specifically, the Get operation for the Edge Stack resource retrieves detailed information about a specific edge stack by its ID. This is useful in scenarios where you want to programmatically fetch the configuration and status of an edge stack deployed across edge groups.
Practical examples include:
- Automating monitoring or auditing of edge stacks.
- Integrating edge stack details into dashboards or reports.
- Triggering workflows based on the state or configuration of a particular edge stack.
Properties
| Name | Meaning |
|---|---|
| Edge Stack ID | The unique identifier of the edge stack to retrieve. It specifies which edge stack's details will be fetched from Portainer. |
Output
The node outputs the JSON response from the Portainer API representing the requested edge stack. This JSON typically includes all properties of the edge stack such as its name, deployment type, associated edge groups, stack file content (docker-compose or stack file), environment variables, and deployment options like pre-pull image or retry deploy flags.
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 Portainer.
- The base URL of the Portainer API must be set in the credentials.
- The node uses HTTP GET requests to the endpoint
/api/edge_stacks/{edgeStackId}.
Troubleshooting
- Invalid or missing Edge Stack ID: If the provided Edge Stack ID does not exist or is empty, the API will return an error. Ensure the ID is correct and corresponds to an existing edge stack.
- Authentication errors: If the API key or base URL is incorrect or missing, authentication will fail. Verify the API key credential and Portainer URL configuration.
- Network issues: Connectivity problems to the Portainer server will cause request failures. Check network access and firewall settings.
- API version mismatch: Using an incompatible Portainer API version may cause unexpected errors. Confirm compatibility between the node and your Portainer instance.
Links and References
- Portainer API Documentation - Edge Stacks
- Portainer Official Website
- Docker Compose File Reference (relevant for understanding stack file content)