Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Network → Get Many

AI-generated

Overview

This node operation retrieves a list of Docker networks from a specified environment in Portainer. It is useful for scenarios where you need to manage or monitor Docker networks programmatically, such as listing all networks available in a Docker environment for auditing, reporting, or automation purposes.

Use Case Examples

  1. Listing all Docker networks in a specific environment to monitor network configurations.
  2. Automating network management tasks by retrieving network details for further processing.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer from which to retrieve the networks.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout to customize the API request behavior.

Output

JSON

  • ``
    • Id - The unique identifier of each Docker network.
    • Name - The name of each Docker network.
    • Driver - The network driver used by each Docker network.
    • Scope - The scope of each Docker network (e.g., local, global).
    • Containers - Details about containers connected to each network.
    • Options - Network-specific options and configurations.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Environment ID is correct and the environment is accessible in Portainer.
  • Check that the API key credential is valid and has sufficient permissions to list networks.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate.
  • Verify proxy settings if a proxy is required for network access.

Links

Discussion