Portainer icon

Portainer

Interact with Portainer via API

Actions190

Stacks → Stack Start

AI-generated

Overview

This node operation, Stack Start, is designed to start a specific stack within an environment in Portainer. Portainer is a management tool for containerized environments, and stacks represent groups of services or containers defined by a compose file or similar configuration.

Typical use cases include:

  • Automating the deployment lifecycle by programmatically starting stacks after updates or maintenance.
  • Integrating stack control into broader workflows that manage container environments.
  • Triggering stack startups based on external events or schedules.

For example, you might use this node to start a development stack automatically when a new feature branch is deployed or to restart a production stack after applying configuration changes.

Properties

Name Meaning
Id The unique identifier of the stack to be started.
Endpoint Id The identifier of the environment (endpoint) where the stack resides.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to start the specified stack. This typically includes status information about the stack start operation, such as success confirmation or error details.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the Portainer API must be set in the node credentials.
  • The node uses HTTP headers specifying JSON content type and expects JSON responses.

Troubleshooting

  • Common issues:

    • Invalid or missing stack ID or endpoint ID will cause the operation to fail.
    • Authentication errors if the API key or token is incorrect or expired.
    • Network connectivity problems between n8n and the Portainer server.
    • Insufficient permissions for the API user to start stacks.

  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API credentials and permissions.
    • "Stack not found": Verify the stack ID is correct and exists in the specified environment.
    • "Endpoint not found": Confirm the endpoint ID corresponds to a valid environment.
    • Timeout or network errors: Ensure the Portainer server is reachable from n8n.

Resolving these usually involves verifying input parameters, checking credential validity, and ensuring network access.

Links and References

Discussion