Portainer icon

Portainer

Work with Portainer API data to manage Docker

Edge Stack → Delete

AI-generated

Overview

This node operation deletes an Edge Stack in Portainer, which is a stack used for edge computing deployments. It is useful for managing and cleaning up edge stacks that are no longer needed or to remove outdated deployments. For example, a user can delete an edge stack by specifying its ID, optionally forcing the deletion even if the stack is currently in use.

Use Case Examples

  1. Deleting an edge stack by its ID to free up resources.
  2. Force deleting an edge stack that is currently in use to ensure removal.

Properties

Name Meaning
Force Delete Whether to force deletion even if the resource is in use
Edge Stack ID The unique identifier of the edge computing stack to delete, required for the operation.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • body - The response body from the Portainer API after attempting to delete the edge stack, typically indicating success or failure of the deletion.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Edge Stack ID is correct and exists in Portainer.
  • If force delete is false and the stack is in use, deletion may fail; try enabling force delete.
  • Check network connectivity and proxy settings if requests fail.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

Discussion