Portainer icon

Portainer

Interact with Portainer via API

Actions190

Stacks → Stack Create Docker Swarm Repository

AI-generated

Overview

This node operation allows you to create a Docker Swarm stack in Portainer by sending a stack configuration to a specified environment endpoint. It is useful for automating the deployment of containerized applications managed via Docker Swarm through Portainer's API. Typical use cases include continuous deployment pipelines, infrastructure automation, and managing multiple Docker environments programmatically.

For example, you can use this node to deploy a new version of a microservices stack by providing the stack configuration as a string and specifying the target environment where the stack should be created.

Properties

Name Meaning
Endpoint Id Identifier of the environment (Docker endpoint) where the stack will be deployed.
Body The stack configuration content as a string, typically a Docker Compose YAML or similar format.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to create the Docker Swarm stack. This usually includes details about the created stack such as its ID, name, status, and any messages returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a Portainer instance with API access.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The target Docker environment must be registered in Portainer and accessible via the provided Endpoint Id.

Troubleshooting

  • Invalid Endpoint Id: If the specified environment does not exist or is unreachable, the API call will fail. Verify that the Endpoint Id corresponds to a valid and accessible Docker environment in Portainer.
  • Malformed Stack Configuration: Providing an invalid or incorrectly formatted stack config string may cause the API to reject the request. Ensure the body contains valid Docker Swarm stack definitions.
  • Authentication Errors: Missing or incorrect API credentials will result in authorization failures. Confirm that the API key/token is correctly set up in the node credentials.
  • API Connectivity Issues: Network problems or incorrect Portainer URL settings can prevent communication. Check the base URL and network connectivity.

Links and References

Discussion