Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Jobs → Edge Job Tasks List

AI-generated

Overview

This node operation, Edge Job Tasks List, retrieves a list of tasks associated with a specific Edge Job in Portainer. It is useful for users who want to monitor or manage the individual tasks that belong to an Edge Job, such as checking their status or details.

Practical examples include:

  • Fetching all tasks for a given Edge Job to display their current state.
  • Integrating task data into dashboards or reports.
  • Automating follow-up actions based on task statuses.

Properties

Name Meaning
Id The unique identifier (number) of the Edge Job whose tasks you want to list. This property is required.

Output

The node outputs JSON data representing the list of tasks related to the specified Edge Job. Each item in the output typically contains details about an individual task, such as its ID, status, and other relevant metadata.

If the node supports binary data output, it would generally relate to any files or logs attached to the tasks, but this is not indicated in the provided code snippet.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • Needs the base URL of the Portainer instance configured in the credentials.
  • Depends on the Portainer API being accessible and the user having sufficient permissions to query Edge Job tasks.

Troubleshooting

  • Common issues:

    • Invalid or missing Edge Job Id: Ensure the "Id" property is set correctly and corresponds to an existing Edge Job.
    • Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
    • Network or connectivity problems: Confirm that the Portainer API endpoint is reachable from n8n.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API credentials.
    • "Edge Job not found": Verify the Edge Job Id is correct.
    • Timeout or connection errors: Check network settings and Portainer server status.

Links and References

Discussion