Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoint Groups → Endpoint Group Delete Endpoint

AI-generated

Overview

This node operation allows you to delete a specific endpoint from an endpoint group within the Portainer environment. It is useful for managing and organizing endpoints by removing those that are no longer needed or relevant in a given group. For example, if you have multiple environments grouped under an endpoint group and one environment is deprecated or decommissioned, this operation helps you clean up by deleting that particular endpoint from the group.

Properties

Name Meaning
Id The identifier of the Endpoint Group from which you want to delete an endpoint.
Endpoint Id The identifier of the specific Environment (Endpoint) you want to delete from the Endpoint Group.

Output

The output will typically contain JSON data confirming the deletion status of the specified endpoint from the endpoint group. This may include success confirmation or error details if the deletion failed. There is no indication that binary data is involved in this operation.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • The node uses the Portainer API base URL configured in the credentials.
  • The node depends on the Portainer API being accessible and the user having sufficient permissions to delete endpoints from groups.

Troubleshooting

  • Common issues:

    • Invalid or missing Endpoint Group Id or Endpoint Id can cause the operation to fail.
    • Insufficient permissions or invalid API credentials will result in authentication errors.
    • Network connectivity issues to the Portainer API endpoint can prevent successful execution.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key credential is valid and has the necessary permissions.
    • "Not Found" or similar: Verify that the provided Endpoint Group Id and Endpoint Id exist.
    • "Bad Request": Ensure that the input parameters are correctly formatted and valid numbers.

Links and References

Discussion