hornet icon

hornet

Interact with hornet API

Actions452

Groups → Groups Export Post

AI-generated

Summary

Export group data from Hornetsecurity based on specified search filters, export type, and object ID.

Inputs

  • object_id (required) — The ID of the object (user, customer, or partner) to query.
  • APP-ID (required) — Unique application identifier header issued for authentication.
  • export_type (required) — Defines the delivery or format of the export (Download, Row Download, Email, or Row Email).
  • group_list — JSON array of specific group identifiers to filter the export.
  • name — Filter to export groups with a specific name.
  • description — Filter to export groups matching a specific description.
  • query — Search string across group names and descriptions.
  • export_keys — JSON array specifying which table column names to include in the export.

Output shape

a single record

Returns the API response object containing the results or status of the requested export.

Examples

Example 1: Trigger a group download export for an object

Set Object Id to 101, APP ID to your app token, and Export Type to Download.

Example 2: Send an emailed export of specific group columns matching a search term

Set Object Id to 101, APP ID, Export Type to Email, Query to 'admin', and Export Keys to ["id", "name", "description"].

Links

Discussion