Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Jobs → Edge Job Tasks Clear

AI-generated

Overview

This node operation, Edge Job Tasks Clear, is designed to clear or remove specific tasks associated with an Edge Job in the Portainer environment. It is useful when you want to manage and maintain edge jobs by deleting particular tasks that are no longer needed or require resetting.

Practical examples:

  • Clearing a failed or stuck task from an edge job to allow it to restart cleanly.
  • Removing completed tasks to keep the edge job's task list manageable.
  • Automating cleanup of edge job tasks as part of a maintenance workflow.

Properties

Name Meaning
Id The unique identifier of the Edge Job whose tasks you want to clear. Must be a number.
Task ID The unique identifier of the specific task within the Edge Job to clear. Must be a number.

Output

The node outputs JSON data representing the result of the task clearing operation. This typically includes confirmation of the cleared task or any relevant status messages returned by the Portainer API. There is no binary output for this operation.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the Portainer API must be provided in the credentials configuration.

Troubleshooting

  • Common issues:

    • Invalid or missing Edge Job Id or Task ID will cause the operation 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 modify edge job tasks.
  • Error messages and resolutions:

    • "Unauthorized" or "Authentication failed": Verify the API credentials and ensure they have the necessary permissions.
    • "Not Found": Check that the Edge Job Id and Task ID exist and are correct.
    • "Bad Request": Confirm that the input parameters are valid numbers and properly formatted.
    • Timeouts or network errors: Ensure the Portainer server is reachable from the n8n environment.

Links and References

Discussion