Portainer icon

Portainer

Interact with Portainer via API

Actions190

Registries → Registry Inspect

AI-generated

Overview

This node interacts with a container management platform's API to inspect details of a specific registry by its identifier. It is useful for users who want to retrieve detailed information about container registries configured in their environment, such as credentials, endpoints, or metadata associated with a particular registry.

A practical example would be automating the retrieval of registry details before performing deployment tasks or audits, ensuring that the correct registry configurations are used.

Properties

Name Meaning
Id Registry identifier (number). This is the unique ID of the registry you want to inspect. It is required to specify which registry's details to fetch.

Output

The node outputs JSON data containing detailed information about the specified registry. The structure typically includes fields such as registry ID, name, URL, authentication details, and other metadata related to the registry configuration.

If the node supports binary data output, it would generally represent any files or certificates associated with the registry, but based on the provided code snippet, the primary output is JSON.

Dependencies

  • Requires an API key credential to authenticate requests to the container management platform's API.
  • The base URL for the API must be configured in the node's credentials.
  • The node depends on an OpenAPI specification and a properties builder utility to define its operations and parameters.

Troubleshooting

  • Common issues:

    • Invalid or missing registry ID: Ensure the "Id" property is set correctly and corresponds to an existing registry.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or connectivity problems: Confirm that the base URL is reachable from the n8n instance.

  • Error messages:

    • "Registry not found": Indicates the specified registry ID does not exist; double-check the ID.
    • "Unauthorized" or "Authentication failed": Check API credentials.
    • "Request timeout" or "Network error": Investigate network connectivity and API availability.

Links and References

Discussion