Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Jobs → Edge Job Delete

AI-generated

Overview

This node operation deletes an existing Edge Job in the Portainer system. It is useful when you want to remove an Edge Job that is no longer needed or was created by mistake. For example, if you manage multiple Edge Jobs for container deployments and one of them becomes obsolete, this operation allows you to clean up by deleting it.

Properties

Name Meaning
Id The unique identifier of the Edge Job to delete

Output

The output JSON typically contains the response from the Portainer API after attempting to delete the specified Edge Job. This may include a success confirmation or error details. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node must be configured with the base URL of the Portainer instance.
  • The Portainer API must be accessible from the environment where n8n runs.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Edge Job Id will result in an error.
    • Network connectivity problems between n8n and the Portainer API can cause request failures.
    • Insufficient permissions associated with the API key may prevent deletion.
  • Error messages:

    • "Edge Job not found" indicates the provided Id does not exist.
    • Authentication errors suggest invalid or missing API credentials.
    • Timeout or connection errors indicate network issues.

To resolve these, verify the Edge Job Id, ensure correct API credentials are used, and confirm network accessibility.

Links and References

Discussion