Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

Overview

This node integrates with the Portainer API to manage edge computing stacks, specifically allowing users to retrieve the deployment status of an Edge Stack. It is useful in scenarios where you need to monitor or verify the current state of an Edge Stack deployment within a Portainer-managed environment.

For example, after deploying or updating an Edge Stack, you can use this node operation to check if the deployment was successful, if it is still in progress, or if there were any errors.

Properties

Name Meaning
Edge Stack ID The unique identifier of the edge stack whose status you want to retrieve.

Output

The node outputs JSON data representing the status of the specified Edge Stack. This typically includes information about the deployment state, such as whether it is active, pending, failed, or completed, along with any relevant metadata provided by the Portainer API.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a Portainer instance via its API.
  • Needs an API key credential configured in n8n for authentication with the Portainer API.
  • The base URL of the Portainer API must be set in the credentials configuration.

Troubleshooting

  • Common Issues:

    • Invalid or missing Edge Stack ID will cause the request to fail.
    • Incorrect or expired API key may result in authentication errors.
    • Network connectivity issues to the Portainer API endpoint can prevent successful requests.
  • Error Messages:

    • 404 Not Found: The specified Edge Stack ID does not exist. Verify the ID is correct.
    • 401 Unauthorized: Authentication failed due to invalid API key. Check and update your credentials.
    • 500 Internal Server Error: An issue on the Portainer server side; retry later or check server logs.

Links and References

Discussion