Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoints → Endpoint Delete

AI-generated

Overview

This node allows you to delete an environment endpoint in Portainer by specifying its identifier. It is useful for managing and cleaning up environment endpoints programmatically within your automation workflows. For example, if you have a list of environment endpoints that are no longer needed or have been decommissioned, this node can automate their removal from Portainer.

Properties

Name Meaning
Id The unique numeric identifier of the environment (endpoint) to be deleted. This is required to specify which endpoint should be removed.

Output

The output JSON will typically contain the response from the Portainer API after attempting to delete the specified environment endpoint. This may include confirmation of deletion or error details if the operation failed. The node does not output binary data.

Dependencies

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

Troubleshooting

  • Common issues:
    • Providing an invalid or non-existent endpoint ID will result in an error.
    • Network connectivity problems or incorrect API URL/credentials will cause request failures.
  • Error messages:
    • "Not Found" or similar indicates the specified endpoint ID does not exist.
    • Authentication errors suggest missing or invalid API credentials.
  • Resolution:
    • Verify the endpoint ID is correct and exists in Portainer.
    • Check API credentials and ensure the Portainer URL is reachable.
    • Confirm that the user associated with the API token has permission to delete endpoints.

Links and References

Discussion