PortainerInstall

Overview

The node provides functionality to inspect a specific Edge Job in Portainer by its unique identifier. This operation is useful for retrieving detailed information about an existing Edge Job, which can be beneficial for monitoring, auditing, or managing edge deployments within Portainer environments.

Practical examples include:

• Fetching the configuration and status of an Edge Job before triggering updates.
• Integrating with automation workflows that require validation or reporting on Edge Jobs.
• Debugging or troubleshooting edge deployment issues by inspecting job details programmatically.

Properties

Output

The output JSON contains the detailed data of the inspected Edge Job as returned by the Portainer API. This typically includes all properties related to the Edge Job such as its configuration, status, associated endpoints, schedules, and other metadata.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Portainer API.
• The node depends on the Portainer API being accessible at the configured URL.
• Proper permissions are needed on the API key to read Edge Job information.

Troubleshooting

• Common issue: Providing an invalid or non-existent Edge Job Id will likely result in an error response from the API indicating the resource was not found.
  • Resolution: Verify the Edge Job Id exists in Portainer before running the node.
• Authentication errors: If the API key or URL is incorrect or lacks sufficient permissions, authentication failures will occur.
  • Resolution: Check credentials and ensure the API key has read access to Edge Jobs.
• Network or connectivity problems: Failure to reach the Portainer API endpoint will cause request errors.
  • Resolution: Confirm network connectivity and correct API base URL configuration.

Links and References

• Portainer API Documentation
• Edge Jobs Management in Portainer