Portainer icon

Portainer

Interact with Portainer via API

Actions190

Custom Templates → Custom Template Delete

AI-generated

Overview

This node operation allows users to delete a custom template by specifying its unique identifier. It is useful in scenarios where templates are no longer needed or must be removed to maintain an organized set of templates. For example, if a user has created multiple deployment templates and wants to remove outdated or incorrect ones, this operation facilitates that cleanup.

Properties

Name Meaning
Id Template identifier (number)

The "Id" property is required and represents the unique numeric identifier of the custom template to be deleted.

Output

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

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node interacts with the Portainer API endpoint configured via credentials.
  • Proper network access to the Portainer server is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent template ID will result in an error.
    • Network connectivity problems can prevent successful API calls.
    • Insufficient permissions associated with the API key may block deletion.
  • Error messages:

    • "Template not found" indicates the provided ID does not exist.
    • Authentication errors suggest invalid or missing API credentials.
    • Timeout or connection errors imply network issues.
  • Resolutions:

    • Verify the template ID is correct and exists.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Check network connectivity to the Portainer server.

Links and References

Discussion