Huntress icon

Huntress

Interact with Huntress API

Actions86

UnwantedAccessRules → Update an Unwanted Access Rule

AI-generated

Summary

Update an existing Unwanted Access Rule identified by its ID with specified fields such as activation start date, expiration date, and notes; allows custom request body, headers, and query parameters.

Inputs

  • id (required) — Numeric ID of the Unwanted Access Rule to update.
  • additionalFields — Optional fields to update: 'Starts At' (UTC date when the rule becomes active), 'Expires At' (UTC date when the rule expires), and 'Notes' (free-text note; passing empty string or null clears the field).
  • options — Additional request options including 'Custom Body' to send arbitrary JSON merged with other fields (custom body takes priority), 'Custom Headers' for HTTP headers, 'Query Filters' for URL query parameters, 'Batching' settings for controlling multiple input items, 'Debug' mode to include request details in output, 'Pagination' options (not typically relevant for update), and 'Timeout' for request duration.

Output shape

a single JSON object representing the updated Unwanted Access Rule.

The operation makes a PATCH request to '/v1/unwanted_access_rules/{id}'. The response from the API is returned as the output. When 'debug' is enabled, additional request details are included under a debug entry in the output.

Links

Discussion