Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Image → Get
AI-generatedOverview
This node operation retrieves detailed information about a specific Docker image from a Portainer-managed environment. It is useful for users who want to inspect metadata, configuration, and other details of a Docker image by providing the environment ID and the image ID. For example, a user can get information about an image to verify its tags, layers, or creation date before deploying containers.
Use Case Examples
- Retrieve details of a Docker image by specifying the environment ID and image ID in Portainer.
- Use this operation to inspect an image's metadata for troubleshooting or auditing purposes.
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 retrieve details for. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior. |
Output
JSON
id- The unique identifier of the Docker image.repoTags- List of repository tags associated with the image.created- Timestamp when the image was created.size- Size of the image in bytes.virtualSize- Virtual size of the image including all layers.labels- Labels associated with the image for metadata.architecture- The architecture the image is built for.os- The operating system the image is built for.dockerVersion- Version of Docker used to build the image.
Dependencies
- Requires an API key credential for authenticating with the Portainer API.
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, but be aware of security risks.
- Verify that the API key credential has sufficient permissions to access image details.