Portainer icon

Portainer

Work with Portainer API data to manage Docker

Registry → Get

AI-generated

Overview

This node interacts with the Portainer API to manage Docker image registries. Specifically, the 'Get' operation for the 'Registry' resource retrieves detailed information about a specific registry by its ID. This is useful for scenarios where you need to fetch and display registry details, such as URL, type, and credentials, within an automation workflow.

Use Case Examples

  1. Retrieve details of a Docker image registry by its ID to verify its configuration.
  2. Fetch registry information to use in subsequent steps like image pulls or updates.

Properties

Name Meaning
Registry ID The unique identifier of the registry to retrieve.
Request Options Additional options to customize the HTTP request, including batching, SSL certificate validation, proxy settings, and timeout settings.

Output

JSON

  • id - The unique identifier of the registry.
  • name - The name of the registry.
  • url - The URL of the registry.
  • type - The type of the registry (e.g., DockerHub, Quay.io).
  • username - The username used for authentication with the registry, if applicable.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the provided Registry ID is correct and exists in Portainer to avoid 'not found' errors.
  • Check API key credentials and base URL configuration to prevent authentication or connection issues.
  • If SSL errors occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security implications.
  • Use proxy settings if your network requires routing through a proxy server.

Links

  • Portainer API - Registries - Official Portainer API documentation for managing registries, including endpoints and request details.

Discussion