Actions88
- 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
Overview
This node allows users to interact with Docker networks through the Portainer API, specifically enabling inspection of Docker networks on a selected endpoint. It is useful for retrieving detailed information about a Docker network's configuration and status, which can help in troubleshooting, monitoring, or automating Docker infrastructure management.
A practical example would be inspecting a specific Docker network by its ID or name to verify its settings or to gather metadata before performing further operations like container deployment or network cleanup.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Docker endpoint to access via the Portainer API. Users can select from a list of available endpoints or specify an ID manually. |
| Id | The Docker network's ID or name that you want to inspect. |
| Additional Fields | Optional parameters to refine the inspection: |
| - Verbose | When enabled, returns a detailed inspection output useful for troubleshooting. |
| - Scope | Filters the network by scope; possible values are swarm, global, or local. |
Output
The node outputs JSON data representing the inspected Docker network's details as returned by the Portainer API. This includes network configuration, connected containers, driver information, IPAM settings, and other metadata.
If the "Verbose" option is enabled, the output will contain more detailed diagnostic information.
No binary data output is produced by this node.
Dependencies
- Requires a valid Portainer API endpoint URL and an API authentication token configured in the node credentials.
- The node depends on the Portainer API being accessible and the specified endpoint ID being valid.
- The node uses an internal method to load available endpoints dynamically for user convenience.
Troubleshooting
Common issues:
- Invalid or missing endpoint ID: Ensure the endpoint exists and is correctly selected or entered.
- Network ID or name not found: Verify the network identifier is correct and exists on the selected endpoint.
- API connectivity errors: Check network connectivity to the Portainer server and validity of API credentials.
Error messages:
- Authentication failures typically indicate invalid or expired API tokens.
- 404 errors may mean the specified network or endpoint does not exist.
- Timeout or connection errors suggest network issues or incorrect base URL configuration.
Resolving these usually involves verifying credentials, endpoint IDs, network names, and ensuring the Portainer API is reachable.