PortainerInstall

Overview

This node interacts with the Portainer API to list endpoint registries associated with a specific environment (endpoint). It is useful for users managing container environments through Portainer, allowing them to retrieve registry information filtered by environment ID and optionally by Kubernetes namespace. Practical use cases include automating the retrieval of container image registries for deployment pipelines or monitoring purposes.

Properties

Output

The node outputs JSON data representing the list of registries associated with the specified environment. Each item in the output typically contains details about a registry such as its name, URL, credentials (if any), and other metadata provided by the Portainer API. There is no indication that binary data is returned.

Dependencies

• Requires an API key credential to authenticate with the Portainer API.
• The base URL for the Portainer instance must be configured in the node credentials.
• The node depends on the Portainer API being accessible and the user having sufficient permissions to query endpoint registries.

Troubleshooting

• Common issues:

  • Invalid or missing environment (endpoint) ID will cause the request to fail.
  • If querying a Kubernetes environment without specifying a namespace when required, the response may be empty or error out.
  • Network connectivity issues or incorrect Portainer URL/credentials will prevent successful API calls.

• Error messages:

  • Authentication errors indicate invalid or missing API credentials; verify and update the API key.
  • "Not Found" or similar errors suggest the environment ID does not exist or is inaccessible.
  • Validation errors related to the namespace parameter mean it is either missing when required or incorrectly formatted.

Links and References

• Portainer API Documentation
• Portainer Official Website