Portainer

Interact with Portainer via API

Actions190

Auth Actions
- Authenticate User
- Validate O Auth
Backup Actions
- Backup
- Restore
Custom Templates Actions
- Custom Template List
- Custom Template Delete
- Custom Template Inspect
- Custom Template Update
- Custom Template File
- Custom Template Git Fetch
- Custom Template Create File
- Custom Template Create Repository
- Custom Template Create String
Docker Actions
- Docker Container Gpus Inspect
- Docker Dashboard
- Docker Images List
Edge Groups Actions
- Edge Group Create
- Edge Group Delete
- Edge Group Inspect
- Ege Group Update
Edge Jobs Actions
- Edge Job Delete
- Edge Job Inspect
- Edge Job Update
- Edge Job File
- Edge Job Tasks List
- Edge Job Tasks Clear
- Edge Job Task Logs Inspect
- Edge Job Tasks Collect
- Edge Job Create File
- Edge Job Create String
Edge Stacks Actions
- Edge Stack Delete
- Edge Stack Inspect
- Edge Stack Update
- Edge Stack File
- Edge Stack Status Update
- Edge Stack Create File
- Edge Stack Create Repository
- Edge Stack Create String
Endpoint Groups Actions
- Endpoint Group Delete
- Endpoint Group Update
- Endpoint Group Delete Endpoint
- Endpoint Group Add Endpoint
Endpoints Actions
- Endpoint Delete Batch
- Endpoint List
- Endpoint Create
- Endpoint Delete
- Endpoint Inspect
- Endpoint Update
- Endpoint Association Delete
- Endpoint Dockerhub Status
- Endpoint Edge Status Inspect
- Endpoint Force Update Service
- Endpoint Registries List
- Endpoint Registry Access
- Endpoint Settings Update
- Endpoint Snapshot
- Endpoint Update Relations
Gitops Actions
- Git Operation Repo File Preview
Helm Actions
- Helm List
- Helm Install
- Helm Delete
- Helm Repo Search
- Helm Show
- Helm User Repositories List
- Helm User Repository Create
- Helm User Repository Delete
Intel Actions
- Open AMT Configure
- Open AMT Activate
- Open AMT Devices
- Device Action
- Device Features
- Open AMT Host Info
Kubernetes Actions
- Get All Kubernetes Applications
- Get All Kubernetes Applications Count
- Delete Cluster Role Bindings
- Delete Cluster Roles
- Get All Kubernetes Cluster Role Bindings
- Get All Kubernetes Cluster Roles
- Get All Kubernetes Config Maps
- Get All Kubernetes Config Maps Count
- Get Kubernetes Cron Jobs
- Delete Cron Jobs
- Get Kubernetes Dashboard
- Get All Kubernetes Ingress Controllers
- Update Kubernetes Ingress Controllers
- Get All Kubernetes Cluster Ingresses
- Get All Kubernetes Cluster Ingresses Count
- Delete Kubernetes Ingresses
- Get Kubernetes Jobs
- Delete Jobs
- Get Kubernetes Max Resource Limits
- Get Applications Resources
- Get Kubernetes Metrics For All Nodes
- Get Kubernetes Metrics For Node
- Get Kubernetes Metrics For All Pods
- Get Kubernetes Metrics For Pod
- Delete Kubernetes Namespace
- Get Kubernetes Namespaces
- Create Kubernetes Namespace
- Update Kubernetes Namespace Deprecated
- Get Kubernetes Namespace
- Update Kubernetes Namespace
- Get Kubernetes Config Map
- Get Kubernetes Ingress Controllers By Namespace
- Update Kubernetes Ingress Controllers By Namespace
- Get All Kubernetes Ingresses
- Create Kubernetes Ingress
- Update Kubernetes Ingress
- Get Kubernetes Ingress
- Get Kubernetes Secret
- Get Kubernetes Services By Namespace
- Create Kubernetes Service
- Update Kubernetes Service
- Kubernetes Namespaces Toggle System
- Get Kubernetes Volumes In Namespace
- Get Kubernetes Namespaces Count
- Get Kubernetes Nodes Limits
- Get Kubernetes RBAC Status
- Delete Role Bindings
- Get Kubernetes Role Bindings
- Get Kubernetes Roles
- Delete Roles
- Get Kubernetes Secrets
- Get Kubernetes Secrets Count
- Delete Service Accounts
- Get Kubernetes Service Accounts
- Get Kubernetes Services
- Get All Kubernetes Services Count
- Delete Kubernetes Services
- Get All Kubernetes Volumes
- Get Kubernetes Volume
- Get All Kubernetes Volumes Count
- Get Kubernetes Config
Ldap Actions
- LDAP Check
Registries Actions
- Registry Create
- Registry Delete
- Registry Inspect
- Registry Update
- Registry Configure
Resource Controls Actions
- Resource Control Create
- Resource Control Delete
- Resource Control Update
Settings Actions
- Settings Update
Ssl Actions
- SSL Update
Stacks Actions
- Stack List
- Stack Delete
- Stack Inspect
- Stack Update
- Stack Associate
- Stack File Inspect
- Stack Update Git
- Stack Git Redeploy
- Stack Migrate
- Stack Start
- Stack Stop
- Stack Create Kubernetes Git
- Stack Create Kubernetes File
- Stack Create Kubernetes Url
- Stack Create Docker Standalone File
- Stack Create Docker Standalone Repository
- Stack Create Docker Standalone String
- Stack Create Docker Swarm File
- Stack Create Docker Swarm Repository
- Stack Create Docker Swarm String
- Stack Delete Kubernetes By Name
- Webhook Invoke
Tags Actions
- Tag Create
- Tag Delete
Team Memberships Actions
- Team Membership Create
- Team Membership Delete
- Team Membership Update
- Team Memberships
Teams Actions
- Team List
- Team Create
- Team Delete
- Team Inspect
- Team Update
Templates Actions
- Template File
Upload Actions
- Upload TLS
Users Actions
- User List
- User Create
- User Delete
- User Inspect
- User Update
- User Memberships Inspect
- User Update Password
- User Get API Keys
- User Generate API Key
- User Remove API Key
- User Admin Init

Custom Templates → Custom Template Create File

AI-generated

Overview

This node operation allows users to create a custom template file in the "Custom Templates" resource. It is designed to facilitate the creation and management of template files associated with different platforms and stack types, such as Linux or Windows platforms and stack types like swarm, compose, or Kubernetes. This can be particularly useful for automating deployment configurations, infrastructure as code templates, or reusable environment setups.

Practical examples include:

Creating a Docker Compose template file for a Linux platform.
Uploading a Kubernetes deployment template with descriptive metadata.
Managing reusable stack templates with notes and logos for easy identification in a UI.

Properties

Name	Meaning
Title	Title of the template.
Description	Description of the template.
Note	A note displayed in the UI; supports HTML content.
Platform	Platform associated with the template. Options: 1 (linux), 2 (windows).
Type	Type of created stack. Options: 1 (swarm), 2 (compose), 3 (kubernetes).
File	The actual file content or reference representing the template file.
Logo	URL of the template's logo image.
Variables	JSON array defining variables used within the template.

Output

The node outputs JSON data representing the result of the template creation operation. This typically includes confirmation details about the newly created template, such as its ID, metadata, and any server response confirming success.

If the node handles binary data (e.g., the template file itself), it would be included in the output, but based on the provided properties, the file is sent as part of the request body rather than outputted as binary.

Dependencies

Requires an API key credential for authenticating with the Portainer API.
Needs the base URL of the Portainer instance configured in credentials.
Depends on the Portainer API being accessible and supporting the custom template creation endpoint.

Troubleshooting

Common issues:
- Authentication failures due to invalid or missing API keys.
- Incorrect platform or type values leading to API validation errors.
- Malformed JSON in the Variables property causing request rejection.
- Missing required fields like Title, Description, Note, Platform, Type, or File.
Error messages:
- Unauthorized or 401 errors: Check API key validity and permissions.
- Validation errors from the API: Verify that all required fields are correctly filled and that enumerated options match expected values.
- JSON parsing errors: Ensure the Variables field contains valid JSON.

Links and References

Note: The above summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

PortainerInstall