Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Image → Pull

AI-generated

Overview

This node operation allows users to pull a Docker image from a registry into a specified environment managed by Portainer. It is useful for automating the retrieval of container images, ensuring the latest or specific tagged versions are available for deployment or further use within Docker environments.

Use Case Examples

  1. Pull the latest nginx image from Docker Hub into environment ID 1.
  2. Pull a specific version of a custom image from a private registry into a designated environment.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer where the image will be pulled.
Image Name The name of the Docker image to pull from the registry.
Image Tag The tag of the Docker image to pull, defaults to 'latest' if not specified.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • body - The response body from the Portainer API after pulling the image, typically containing status or result information.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API and access to the specified environment endpoint.

Troubleshooting

  • Ensure the Environment ID is correct and accessible in Portainer to avoid authorization or connection errors.
  • Verify the image name and tag are valid and exist in the target registry to prevent pull failures.
  • Check network connectivity and proxy settings if the request times out or fails to reach the registry.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security implications.

Links

Discussion