Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Groups → Edge Group Delete

AI-generated

Overview

This node operation deletes an Edge Group in Portainer, a container management platform. It is useful when you want to programmatically remove an existing Edge Group by specifying its unique identifier. Typical scenarios include cleaning up unused or obsolete Edge Groups as part of automation workflows managing container environments.

Properties

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

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide error details if it failed. There is no binary output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • The Portainer API must be accessible from the n8n environment.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Edge Group ID will cause the deletion to fail.
    • Network connectivity problems or incorrect API URL configuration can prevent the node from reaching the Portainer API.
    • Insufficient permissions associated with the API key may block deletion operations.
  • Error messages and resolutions:

    • "Edge Group not found": Verify that the provided Id corresponds to an existing Edge Group.
    • "Unauthorized" or "Forbidden": Check that the API key has sufficient rights to delete Edge Groups.
    • Network errors/timeouts: Confirm network access and correct API endpoint URL.

Links and References

Discussion