Portainer icon

Portainer

Interact with Portainer via API

Actions190

Custom Templates → Custom Template File

AI-generated

Overview

This node interacts with a service called Portainer via its API, specifically focusing on the "Custom Templates" resource and the "Custom Template File" operation. It allows users to retrieve or manipulate files related to custom templates identified by a unique template ID. This can be useful in scenarios where automated management or retrieval of template files is needed, such as deploying container configurations or managing infrastructure templates programmatically.

For example, a user might use this node to fetch the file content of a specific custom template by providing its ID, enabling integration with CI/CD pipelines or configuration management workflows.

Properties

Name Meaning
Id Template identifier (number). This is a required property used to specify which custom template file to operate on.

Output

The node outputs JSON data corresponding to the requested custom template file. The exact structure depends on the API response but typically includes details about the template file content or metadata. If the node supports binary data output (e.g., file contents), it would represent the actual file data for further processing or saving.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • Needs the base URL of the Portainer instance configured in the credentials.
  • Depends on the @devlikeapro/n8n-openapi-node package for OpenAPI-based request handling.
  • Uses an OpenAPI specification (openapi.json) bundled with the node for defining available operations and properties.

Troubleshooting

  • Authentication errors: Ensure that the API key credential and base URL are correctly set up in n8n credentials.
  • Invalid template ID: Providing a non-existent or incorrect template ID will likely result in an error from the API; verify the ID before running the node.
  • Network issues: Connectivity problems to the Portainer API endpoint will cause failures; check network access and firewall settings.
  • API changes: If the Portainer API changes, the node may require updates to the OpenAPI spec or code to remain compatible.

Links and References

Discussion