Portainer icon

Portainer

Work with Portainer API data to manage Docker

Edge Stack → Get Status

AI-generated

Overview

This node operation retrieves the deployment status of a specific edge computing stack in Portainer. It is useful for monitoring the current state of an edge stack to ensure it is deployed and functioning as expected. For example, users can check if an edge stack is active, failed, or in progress, which helps in managing edge computing resources effectively.

Use Case Examples

  1. Check the deployment status of an edge stack by providing its Edge Stack ID to monitor its health and deployment progress.
  2. Use this operation in automation workflows to trigger alerts or actions based on the edge stack's status.

Properties

Name Meaning
Edge Stack ID The unique identifier of the edge computing stack whose status is to be retrieved.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configurations to customize the API call behavior.

Output

JSON

  • status - The deployment status details of the specified edge stack as returned by the Portainer API.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the provided Edge Stack ID is correct and exists in the Portainer environment.
  • Verify that the API key credential has sufficient permissions to access edge stack status information.
  • Check network connectivity and proxy settings if the request fails to reach the Portainer API.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.

Links

Discussion