Get IP Object

Overview

This node retrieves detailed information about a specified IP address by querying an external firewall API. It is useful in scenarios where you need to enrich your workflow with data related to IP addresses, such as security monitoring, network management, or access control automation. For example, you can input an IP address or subnet and get back metadata like the associated object ID and other details from the firewall system.

Properties

Output

The node outputs JSON data containing the following fields:

• success: Boolean indicating if the request was successful.
• id: The unique identifier of the IP object retrieved from the firewall API.
• ip: The IP address returned by the API.
• searchedIp: The original IP address or subnet that was searched.
• response: The full response object returned by the API, containing detailed information about the IP object.

In case of failure, the output JSON includes:

• success: false
• error: Error message describing what went wrong.
• statusCode: HTTP status code returned by the API.
• response: Additional response data or error details from the API.
• searchedIp: The IP address or subnet that was attempted.

The node does not output binary data.

Dependencies

• Requires an external firewall API service accessible via a configured API URL.
• Needs an API key credential (referred generically as "firewall API credentials") to authenticate requests.
• The API URL is obtained from the node's credentials configuration.
• The node sends HTTP GET requests to the endpoint /api/pt/ip with the IP address as a query parameter.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Providing an incorrectly formatted IP address or subnet may result in errors or no data found.
  • Network connectivity problems to the firewall API endpoint will cause request failures.

• Error messages:

  • Errors include detailed messages with HTTP status codes and response bodies when available.
  • If the node is set to continue on failure, it outputs error details in the JSON; otherwise, it throws an error stopping execution.

• Resolution tips:

  • Verify that the API credentials are correctly configured and valid.
  • Ensure the IP address format matches expected patterns (e.g., IPv4 or CIDR notation).
  • Check network access and firewall rules allowing communication with the API endpoint.
  • Review the error response body for specific API error messages.

Links and References

• Refer to your firewall API documentation for details on the /api/pt/ip endpoint and required authentication.
• n8n HTTP Request node documentation for understanding how HTTP calls are made within nodes: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/