Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Image → Inspect

AI-generated

Overview

This node operation inspects a Docker image within a specified environment in Portainer. It retrieves detailed information about the image, such as metadata, configuration, and layers, by making a GET request to the Portainer API endpoint for the image's JSON data. This operation is useful for users who need to analyze or verify the properties and details of a Docker image managed by Portainer.

Use Case Examples

  1. Inspecting a Docker image to verify its configuration before deployment.
  2. Retrieving metadata of an image to audit or document the image details in a CI/CD pipeline.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer where the image is located.
Image ID The unique identifier of the Docker image to inspect.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior.

Output

JSON

  • body - The detailed JSON object representing the inspected Docker image, including metadata, configuration, and layers.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Environment ID and Image ID are correct and correspond to existing resources in Portainer.
  • Check network connectivity and proxy settings if the request fails to reach the Portainer API.
  • If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option if appropriate.
  • Verify that the API key credential has sufficient permissions to access image details in Portainer.

Links

Discussion