Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Container → Pause
AI-generatedOverview
This node operation allows pausing a running Docker container managed through Portainer. Pausing a container temporarily suspends its processes without stopping or terminating it, which can be useful for maintenance or resource management without losing the container's state.
Use Case Examples
- Pausing a container to temporarily free up system resources without stopping it.
- Pausing a container before performing system updates or backups to ensure consistency.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the environment/endpoint in Portainer where the container is running. |
| Container ID | The unique identifier of the container to be paused. |
| Request Options | Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior. |
Output
JSON
body- The JSON response body from the Portainer API after pausing the container, typically empty or confirmation of the pause action.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the Environment ID and Container ID are correct and correspond to existing resources in Portainer.
- Verify that the container is currently running; pausing a stopped container will likely result in an error.
- Check network connectivity and API access permissions to the Portainer endpoint.
- If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate and secure to do so.
Links
- Portainer API - Pause Container - Official Portainer API documentation for pausing Docker containers.