Actions72
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
Overview
This node integrates with the Portainer API to manage Docker environments, specifically allowing interaction with Docker containers and other Docker resources through Portainer. The "Container - Get" operation retrieves detailed information about a specific Docker container identified by its Container ID within a given environment (endpoint).
Common scenarios where this node is beneficial include:
- Monitoring container status and configuration in automated workflows.
- Fetching container metadata for auditing or reporting purposes.
- Integrating container details into broader DevOps pipelines or dashboards.
Practical example:
- You have multiple Docker environments managed via Portainer. Using this node, you can fetch the current state and configuration of a particular container by specifying its environment and container IDs, then use that data downstream for alerting or logging.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Portainer environment/endpoint where the container resides. |
| Container ID | The unique identifier of the Docker container to retrieve information about. |
Output
The node outputs JSON data representing the full details of the specified Docker container as returned by the Portainer API. This includes container configuration, state, network settings, mounts, image details, and other metadata.
No binary data output is involved in this operation.
Dependencies
- Requires an active Portainer instance accessible via its API.
- Requires an API key credential for authenticating requests to the Portainer API.
- The node uses the base URL and API key from the configured credentials to make HTTP GET requests to the endpoint
/endpoints/{environmentId}/docker/containers/{containerId}/json.
Troubleshooting
- Invalid Environment ID or Container ID: If either ID is incorrect or does not exist, the API will return an error (e.g., 404 Not Found). Verify the IDs are correct and correspond to existing resources in Portainer.
- Authentication Errors: Missing or invalid API key will cause authentication failures. Ensure the API key credential is correctly set up.
- Network Issues: Unable to reach the Portainer API due to network problems or incorrect base URL configuration.
- Permission Denied: The API key used might lack sufficient permissions to access container details.
To resolve these issues:
- Double-check input IDs.
- Confirm API key validity and permissions.
- Verify network connectivity and base URL correctness.