Portainer icon

Portainer

Work with Portainer API data to manage Docker

Template → Get

AI-generated

Overview

This node interacts with the Portainer API to retrieve a specific application template by its ID. It is useful in scenarios where users need to fetch detailed information about a particular template stored in Portainer, such as for deployment or inspection purposes.

Use Case Examples

  1. Fetching a template by its ID to review its configuration before deployment.
  2. Retrieving template details to automate deployment workflows based on predefined templates.

Properties

Name Meaning
Template ID The ID of the template to retrieve, required for the get operation on templates resource.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to customize the API request behavior.

Output

JSON

  • body - The JSON response body containing the template details retrieved from the Portainer API.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Template ID is valid and exists in the Portainer instance to avoid 404 errors.
  • Check network connectivity and proxy settings if the request fails to reach the Portainer API.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
  • Timeout errors can be resolved by increasing the timeout setting in the request options.

Links

Discussion