Get Network Group By ID icon

Get Network Group By ID

Get a specific network group by ID

Overview

This node retrieves detailed information about a specific network group by its unique ID from a firewall or network management API. It is useful in scenarios where you need to fetch and process network group data dynamically within an automation workflow, such as auditing network configurations, integrating with security tools, or managing access control lists.

For example, you might use this node to:

  • Automatically retrieve the members of a network group before applying firewall rules.
  • Monitor changes in network groups by fetching their current state regularly.
  • Integrate network group data into reporting dashboards or alerting systems.

Properties

Name Meaning
Group ID The unique identifier of the network group to retrieve. Example format: "group-123".

Output

The node outputs a JSON object for each input item containing the following fields:

  • success (boolean): Indicates if the retrieval was successful.
  • id (string): The ID of the retrieved network group.
  • name (string): The name of the network group.
  • items (array): An array of items (e.g., IP addresses or subgroups) that belong to the network group.
  • itemsCount (number): The count of items in the network group.
  • response (object): The full raw response from the API call.

In case of failure (and if the node is set to continue on fail), the output includes:

  • success: false
  • error: Error message string
  • statusCode: HTTP status code returned by the API
  • response: Raw response body or data from the failed request
  • id: The requested group ID

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the firewall or network management API.
  • The API base URL must be configured in the credentials.
  • The node makes HTTP GET requests to the endpoint /api/pt/ip/group/{groupId} to fetch network group details.

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can cause timeouts or unreachable host errors.
    • If the specified group ID does not exist, the API may return a 404 error.

  • Error messages:

    • Errors include detailed messages with HTTP status codes and response bodies to help diagnose issues.
    • If the node is not set to continue on fail, it throws an error stopping execution with a descriptive message including the URL, status code, and response content.
    • To handle intermittent failures gracefully, enable "Continue On Fail" in the node settings.

Links and References

Discussion