Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Stacks → Edge Stack Delete

AI-generated

Overview

This node allows users to delete an Edge Stack in Portainer by specifying the unique identifier of the Edge Stack. It is useful for automating the management and cleanup of Edge Stacks within a Portainer environment, especially when managing multiple edge devices or deployments. For example, if an Edge Stack is no longer needed or must be replaced, this node can programmatically remove it without manual intervention.

Properties

Name Meaning
Id The unique numeric identifier of the Edge Stack to delete

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or any error messages returned by the Portainer API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL of the Portainer API must be provided in the credentials configuration.

Troubleshooting

  • Common issues:
    • Providing an invalid or non-existent Edge Stack Id will likely result in an error response from the API.
    • Network connectivity problems or incorrect API URL/credentials will prevent successful communication with Portainer.
  • Error messages:
    • "Edge Stack not found" or similar indicates the specified Id does not exist.
    • Authentication errors suggest missing or invalid API credentials.
  • Resolutions:
    • Verify the Edge Stack Id is correct and exists in Portainer.
    • Check API credentials and ensure they have sufficient permissions.
    • Confirm network access to the Portainer API endpoint.

Links and References

Discussion