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
System → Get Status
AI-generatedOverview
This node interacts with the Portainer API to retrieve system status information. It is useful for monitoring the health and status of the Portainer-managed Docker environment. For example, users can use this node to get real-time status updates of their Docker system managed by Portainer.
Use Case Examples
- Retrieve the current status of the Portainer system to monitor its health and operational state.
- Use the node to automate system status checks and trigger alerts or actions based on the status.
Properties
| Name | Meaning |
|---|---|
| Request Options | Options to customize the API request behavior, including batching, SSL certificate validation, proxy settings, and request timeout. |
Output
JSON
status- The system status information retrieved from the Portainer API.
Dependencies
- Portainer API with API key authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has sufficient permissions to access system status.
- If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request may be blocked; enable this option if necessary.
- Check proxy settings if the request fails to connect to the Portainer API endpoint.
- Timeout errors may occur if the server is slow to respond; increase the timeout setting if needed.
Links
- Portainer System API Documentation - Official documentation for the Portainer system API endpoints, including status retrieval.