Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node integrates with the Portainer API to manage Docker containers and other Docker-related resources. Specifically, for the Container - Start operation, it allows users to start a stopped Docker container within a specified environment (endpoint) managed by Portainer.
Common scenarios where this node is beneficial include:
- Automating container lifecycle management in CI/CD pipelines.
- Starting containers on-demand based on external triggers or workflows.
- Integrating container control into broader automation tasks without manual intervention.
For example, after deploying a new container configuration, you can use this node to start the container automatically. Or, if a container was stopped due to an error or maintenance, this node can be used to restart it as part of recovery automation.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Portainer environment/endpoint where the container resides. |
| Container ID | The unique identifier of the Docker container to start. |
Output
The node outputs the JSON response returned by the Portainer API when starting the container. Typically, this will be an empty object {} on success, as the Docker API's start container endpoint does not return detailed data. If there is an error, the output will contain error details from the API.
No binary data is produced by this operation.
Dependencies
Requires a configured Portainer API credential with:
- Base URL of the Portainer instance.
- An API key token for authentication.
The node sends HTTP POST requests to the Portainer API endpoint corresponding to the container start action.
Troubleshooting
Common issues:
- Invalid or missing Environment ID or Container ID parameters.
- Insufficient permissions or invalid API key leading to authorization errors.
- Container already running or in a state that cannot be started.
- Network connectivity issues to the Portainer API endpoint.
Common error messages:
404 Not Found: The specified container or environment does not exist.403 Forbiddenor401 Unauthorized: Authentication failed; check API key credentials.409 Conflict: Container is already running or in an incompatible state.
Resolutions:
- Verify the correctness of Environment ID and Container ID.
- Ensure the API key has sufficient permissions.
- Confirm the container is stopped before attempting to start.
- Check network access to the Portainer server.