Actions107
- Container Actions
- Container List
- Container Create
- Container Inspect
- Container Top
- Container Logs
- Container Changes
- Container Export
- Container Stats
- Container Resize
- Container Start
- Container Stop
- Container Restart
- Container Kill
- Container Update
- Container Rename
- Container Pause
- Container Unpause
- Container Attach
- Container Attach Websocket
- Container Wait
- Container Delete
- Container Archive Info
- Container Archive
- Put Container Archive
- Container Prune
- Image Actions
- Network Actions
- Volume Actions
- Swarm Actions
- Node Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
- Config Actions
- Plugin Actions
- Distribution Actions
- Session Actions
Config → Config Inspect
AI-generatedOverview
This node interacts with Docker through the Portainer API, specifically allowing users to inspect Docker configurations on a selected endpoint. It is useful for scenarios where you need to retrieve detailed information about a specific Docker config managed by Portainer, such as verifying configuration details or auditing Docker setups remotely.
A practical example would be automating the retrieval of Docker config metadata during deployment pipelines or monitoring tasks, enabling integration with other systems that require up-to-date Docker configuration data.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Portainer endpoint to access. You can select from a list of available endpoints or specify an ID using an expression. |
| Id | The unique identifier of the Docker config you want to inspect. This is a required string input specifying which config to retrieve details for. |
Output
The node outputs JSON data representing the detailed information of the specified Docker config retrieved from the Portainer API. This includes all metadata and properties associated with that config in Docker.
If the node supports binary data output (not explicitly shown here), it would typically represent any binary content related to the config, but based on the provided code and context, the output is purely JSON.
Dependencies
- Requires access to a Portainer instance with the Docker environment configured.
- Needs an API key credential for authenticating requests to the Portainer API.
- The node depends on the Portainer API being accessible at the URL specified in the credentials.
- Uses an internal method to load available endpoints dynamically from the Portainer API.
Troubleshooting
Common issues:
- Incorrect or missing endpoint ID may cause failures in connecting to the Docker environment.
- Invalid or expired API credentials will result in authentication errors.
- Providing an invalid config ID will lead to errors indicating the config was not found.
Error messages and resolutions:
- Authentication failed: Verify the API key credential and ensure it has sufficient permissions.
- Config not found: Double-check the config ID input; ensure it exists on the selected endpoint.
- Endpoint not reachable: Confirm the Portainer URL and network connectivity.