Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoint Groups → Endpoint Group Delete

AI-generated

Overview

This node allows you to delete an Endpoint Group in Portainer via its API. It is useful when you want to programmatically manage your Portainer environment by removing groups of endpoints that are no longer needed or relevant. For example, if you have a group of Docker hosts or Kubernetes clusters grouped as an Endpoint Group and you want to clean up unused groups automatically, this operation will help you do that.

Properties

Name Meaning
Id The unique identifier of the Endpoint Group you want to delete. This is a required numeric value specifying which Endpoint Group to remove.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be a confirmation of successful deletion or an error message if the deletion failed. There is no binary output for this operation.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • The node uses HTTP headers to accept and send JSON content.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Endpoint Group ID will cause the deletion to fail.
    • Network connectivity problems or incorrect Portainer URL configuration can prevent the API call from succeeding.
    • Insufficient permissions associated with the API key may lead to authorization errors.
  • Error messages:

    • "404 Not Found" likely means the specified Endpoint Group ID does not exist.
    • "401 Unauthorized" indicates authentication failure; check the API key and credentials.
    • "400 Bad Request" could mean the input parameters are malformed or missing.

To resolve these, verify the Endpoint Group ID, ensure the API key has proper permissions, and confirm the Portainer URL is correct.

Links and References

Discussion