Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoints → Endpoint Association Delete

AI-generated

Overview

This node operation deletes an association with a specific environment endpoint in Portainer. It is useful when you want to remove or disassociate an environment (endpoint) from your Portainer setup via API. For example, if an environment is no longer needed or should be removed from management, this operation allows you to delete its association cleanly.

Properties

Name Meaning
Id The unique identifier of the environment (endpoint) to delete. This is a required numeric value specifying which endpoint association to remove.

Output

The output JSON will typically contain the response from the Portainer API confirming the deletion of the specified environment endpoint association. This may include status information or confirmation messages. The node does not output binary data.

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 and the user authenticated must have permissions to delete environment associations.

Troubleshooting

  • Invalid Id: If the provided environment ID does not exist or is incorrect, the API will likely return an error indicating the resource was not found. Verify the ID before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly set in the node credentials.
  • Permission Denied: The authenticated user might lack permission to delete environment associations. Check user roles and permissions in Portainer.
  • Network Issues: Connectivity problems to the Portainer API endpoint can cause request failures. Confirm network access and correct URL configuration.

Links and References

Discussion