Delete IP Object icon

Delete IP Object

Delete an IP object by ID

Overview

This node deletes an IP object identified by its ID from a firewall management system via an API call. It is useful in scenarios where you need to programmatically remove IP objects, such as cleaning up obsolete or unauthorized IP entries in your firewall configuration. For example, if you maintain a dynamic list of IP addresses for access control, this node can automate the removal of specific IP objects based on their IDs.

Properties

Name Meaning
IP Object ID The unique identifier of the IP object to delete. Example format: "ip-object-123".

Output

The node outputs JSON data for each input item processed, containing:

  • success: Boolean indicating whether the deletion was successful.
  • message: A message returned from the API or a default success message.
  • id: The ID of the IP object that was attempted to be deleted.
  • response: The full response object from the API call.

If the deletion fails and the node is set to continue on failure, the output JSON will include:

  • success: false
  • error: Error message describing what went wrong.
  • statusCode: HTTP status code returned by the API.
  • response: Response body or error details from the API.
  • id: The IP object ID that failed to delete.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the firewall management API.
  • The node expects the API URL to be provided via credentials.
  • The node makes HTTP DELETE requests to the endpoint /api/pt/ip/{id} on the configured API URL.

Troubleshooting

  • Common issues:

    • Invalid or missing IP Object ID will cause the request to fail.
    • Network connectivity problems or incorrect API URL will prevent successful deletion.
    • Insufficient permissions or invalid API credentials will result in authorization errors.

  • Error messages:

    • Errors include detailed information such as HTTP status code and response body.
    • If the node is not set to continue on failure, it throws an error with context including the URL, status, and object ID.
    • To resolve errors, verify the IP Object ID exists, check API credentials, and ensure the API endpoint is reachable.

Links and References

  • Refer to your firewall management system's API documentation for details on the IP object deletion endpoint.
  • n8n HTTP Request node documentation for understanding HTTP methods and error handling.

Discussion