Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

Overview

This node integrates with the Portainer API to manage Docker registries. Specifically, the "Registry" resource with the "Get" operation allows users to retrieve detailed information about a specific Docker image registry by its ID. This is useful for scenarios where you need to fetch configuration or status details of a particular registry managed in Portainer.

Practical examples include:

  • Retrieving credentials and URL details of a registry before performing image pulls or pushes.
  • Auditing or monitoring registries configured in your Docker environment via Portainer.
  • Integrating registry data into automation workflows that depend on registry metadata.

Properties

Name Meaning
Registry ID The unique identifier of the registry to retrieve. This is required to specify which registry's details to fetch.

Output

The node outputs JSON data representing the details of the specified registry as returned by the Portainer API. This typically includes fields such as the registry's name, URL, type, and possibly authentication details (excluding sensitive credentials). The output structure directly reflects the API response for a single registry object.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • Network connectivity to the Portainer API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Registry ID: The node requires a valid registry ID; ensure it is correctly provided.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network issues: Confirm that the Portainer API URL is reachable from the n8n environment.
  • Error Messages:

    • 404 Not Found: The specified registry ID does not exist. Check the ID value.
    • 401 Unauthorized: Authentication failed. Recheck the API key credential.
    • 500 Internal Server Error: An issue occurred on the Portainer server side; retry later or check server logs.

Links and References

Discussion