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

Edge Jobs → Edge Job Tasks Collect

AI-generated

Overview

The node interacts with the Portainer API to collect specific tasks related to Edge Jobs. In particular, the "Edge Job Tasks Collect" operation retrieves details about a particular task within an Edge Job by specifying both the Edge Job ID and the Task ID. This is useful for users who manage containerized environments via Portainer and need to programmatically access or monitor individual tasks of Edge Jobs.

Practical examples include:

Fetching the status or logs of a specific task in an Edge Job.
Automating monitoring workflows that track task completion or failure.
Integrating task-level data into broader automation pipelines for container management.

Properties

Name	Meaning
Id	The unique identifier of the Edge Job from which to collect the task. Must be a number.
Task ID	The unique identifier of the specific task within the Edge Job to retrieve. Must be a number.

Output

The output JSON contains the detailed information about the specified Edge Job task. This typically includes task metadata such as status, execution details, timestamps, and any other relevant task-specific data returned by the Portainer API.

If the node supports binary data (not evident from the provided code), it would represent associated files or logs related to the task, but this is not explicitly shown here.

Dependencies

Requires an active connection to a Portainer instance via its API.
Needs an API authentication token or key configured in the node credentials to authorize requests.
The base URL for the Portainer API must be set in the node's credential configuration.

Troubleshooting

Common issues:
- Invalid or missing Edge Job ID or Task ID will cause the API request to fail.
- Authentication errors if the API key or token is incorrect or expired.
- Network connectivity problems between n8n and the Portainer server.
- Insufficient permissions on the API token to access Edge Job tasks.
Error messages:
- "404 Not Found": The specified Edge Job or Task ID does not exist. Verify IDs are correct.
- "401 Unauthorized" or "403 Forbidden": Authentication failed or insufficient permissions. Check API credentials.
- Timeout or network errors: Ensure the Portainer server is reachable and the URL is correct.

Links and References

Portainer API Documentation
Portainer Edge Jobs Overview
n8n Documentation on HTTP Request Nodes (for understanding API interactions)

PortainerInstall