Portainer icon

Portainer

Interact with Portainer via API

Actions190

Stacks → Stack Update

AI-generated

Overview

The node provides an interface to update a Stack resource in Portainer via its API. It allows users to modify the configuration or details of an existing stack by specifying its identifier and environment context. This is useful for automating infrastructure management, updating deployment configurations, or integrating stack updates into CI/CD pipelines.

Practical examples include:

  • Updating a Docker stack's configuration after changing service definitions.
  • Modifying environment-specific parameters of a stack before redeployment.
  • Automating stack version upgrades as part of a larger workflow.

Properties

Name Meaning
Id The unique numeric identifier of the stack to update.
Endpoint Id The numeric identifier of the environment (endpoint) where the stack resides.
Body A JSON string containing the updated stack details and configuration to apply.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to update the stack. This typically includes confirmation of the update, the updated stack details, or error information if the update failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • Needs the base URL of the Portainer instance configured in credentials.
  • Depends on the Portainer REST API being accessible and properly configured.

Troubleshooting

  • Common issues:
    • Invalid or missing stack or endpoint IDs will cause the update to fail.
    • Malformed JSON in the Body property can lead to request errors.
    • Network connectivity or authentication failures with the Portainer API.
  • Error messages:
    • Authentication errors indicate invalid or missing API credentials.
    • HTTP 404 errors suggest the specified stack or endpoint does not exist.
    • HTTP 400 errors often mean the body payload is invalid or incomplete.
  • Resolutions:
    • Verify that the stack and endpoint IDs are correct and exist.
    • Ensure the Body JSON is well-formed and matches expected schema.
    • Confirm API credentials and Portainer URL are correctly set up in n8n.

Links and References

Discussion