Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoints → Endpoint Dockerhub Status

AI-generated

Overview

This node interacts with the Portainer API to retrieve the Dockerhub status of a specific endpoint. It is useful for users who manage multiple Docker endpoints via Portainer and want to programmatically check the status of Dockerhub integration on those endpoints. For example, it can be used in automation workflows to monitor Dockerhub connectivity or trigger alerts if the Dockerhub status changes.

Properties

Name Meaning
Id The unique identifier of the endpoint whose Dockerhub status you want to check. Must be a number.
Registry Id The unique identifier of the registry associated with the endpoint. Must be a number.

Output

The node outputs JSON data containing the Dockerhub status information for the specified endpoint and registry. This typically includes details such as connection status, authentication state, or other relevant metadata returned by the Portainer API about the Dockerhub integration.

No binary data output is expected from this node.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • The node depends on the Portainer API being accessible at the URL provided in the credentials.
  • Uses an OpenAPI specification internally to define available operations and properties.

Troubleshooting

  • Common issues:

    • Invalid or missing endpoint or registry IDs will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity issues to the Portainer server will prevent successful requests.

  • Error messages:

    • Authentication failures usually indicate invalid API keys or insufficient permissions.
    • "Not Found" errors may mean the specified endpoint or registry ID does not exist.
    • Timeout or network errors suggest connectivity problems; verify the Portainer server URL and network access.

Links and References

Discussion