Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Stacks → Edge Stack Inspect

AI-generated

Overview

The node provides an operation to inspect a specific Edge Stack by its unique identifier within the Portainer environment. This is useful for users who want to retrieve detailed information about a particular Edge Stack, such as its configuration, status, or metadata. Common scenarios include monitoring deployments, debugging stack configurations, or integrating stack details into automated workflows.

For example, a user might use this node to fetch the current state of an Edge Stack before triggering updates or to audit stack settings programmatically.

Properties

Name Meaning
Id The unique numeric identifier of the Edge Stack to inspect

Output

The output will contain JSON data representing the detailed information of the specified Edge Stack. This typically includes all relevant properties of the Edge Stack such as its configuration, deployment status, associated endpoints, and metadata.

If the node supports binary data (not indicated here), it would represent any binary content related to the Edge Stack, but based on the provided code and context, the output is purely JSON.

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 Stacks.

Troubleshooting

  • Common issues:

    • Invalid or missing Edge Stack Id: Ensure the Id property is set correctly and corresponds to an existing Edge Stack.
    • Authentication errors: Verify that the API key and base URL are correctly configured and valid.
    • Network connectivity problems: Confirm that the Portainer API endpoint is reachable from the n8n environment.
  • Error messages:

    • "Edge Stack not found": The provided Id does not match any existing Edge Stack.
    • "Unauthorized" or "Authentication failed": Check API credentials.
    • "Request timeout" or "Network error": Investigate network connectivity and API availability.

Links and References

Discussion