Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Stacks → Edge Stack File

AI-generated

Overview

This node interacts with the Portainer API to retrieve information related to "Edge Stacks," specifically focusing on fetching the file content of a given Edge Stack. It is useful in scenarios where users need to programmatically access or manage the configuration files of Edge Stacks within Portainer, such as automating deployments, backups, or audits of edge device configurations.

For example, a user might use this node to:

  • Retrieve the YAML or JSON definition file of an Edge Stack by its ID.
  • Integrate with CI/CD pipelines to validate or update Edge Stack configurations.
  • Automate monitoring or compliance checks by extracting stack definitions regularly.

Properties

Name Meaning
Id The unique identifier (number) of the Edge Stack whose file content you want to retrieve. This property is required.

Output

The node outputs JSON data representing the content of the Edge Stack file associated with the provided ID. The exact structure depends on the Portainer API response but typically includes the stack's configuration details such as service definitions, environment variables, and deployment settings.

If the Edge Stack file contains binary data (e.g., encoded files), the node would handle it accordingly, but based on the static code, the output is primarily JSON-formatted stack configuration data.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the Portainer API must be set in the node credentials.

Troubleshooting

  • Invalid or missing Edge Stack ID: Ensure the "Id" property is correctly set to a valid number corresponding to an existing Edge Stack.
  • Authentication errors: Verify that the API credentials are correct and have sufficient permissions to access Edge Stack resources.
  • Network issues: Confirm that the Portainer API endpoint is reachable from the n8n environment.
  • Unexpected API responses: Check if the Portainer API version matches the node's expected schema; mismatches can cause parsing errors.

Links and References

Discussion