hornet icon

hornet

Interact with hornet API

Actions452

Emails Deny And Allowlisting → Emails Black White List Export Post

AI-generated

Summary

Exports the email deny/allow list for a given object (user, customer, or partner) with optional filters, delivering the result either by email or as a downloadable file.

Inputs

  • object_id (required) — ID of the object (user, customer, partner). Passed as a query parameter.
  • APP-ID (required) — Application identifier issued by Hornetsecurity. Sent in the HTTP header.
  • type (required) — List type: 1 = allowlist, 2 = denylist. Sent in the request body.
  • owner — Filter entries by owner. Sent in the request body.
  • value — Filter entries by value. Sent in the request body.
  • all — Filter entries by owner or value. Sent in the request body.
  • export_type (required) — Export delivery method: 'email' or 'download'. Sent in the request body.
  • bypassed_filters — JSON array of filters to bypass. Sent in the request body.
  • requestOptions — Advanced HTTP options such as batching, SSL verification, proxy, and timeout.

Output shape

object

The API returns the exported list. When export_type is 'email', the response indicates the email was sent; when 'download', the response contains the file data or a download link.

Examples

Example 1: Download the deny list for a customer

Set object_id to the customer ID, APP-ID to your app key, type to 2, export_type to 'download', and optionally filter by owner or value.

Links

Discussion