Skip to main content

Send Export via Email

POST 
/export/:id/send_email/

Send the export file to the user via email. If the export is already generated, the email is sent immediately. Otherwise, it will be sent when generation completes.

Request​

Path Parameters

    id stringrequired

Body

required

    format string

    Possible values: [csv]

    Export file format.

    • csv - CSV
    endpoint stringrequired

    Possible values: <= 64 characters

    API endpoint to export data from. Available: account_findings, target_findings, targets, scans, domains, scheduled_scans

    filters

    Filter parameters to apply when querying the endpoint.

    fields

    List of fields to include in the export.

Responses​

Schema

    id stringrequired

    A unique Base58 value identifying this object.

    user stringrequired

    A unique Base58 value identifying this object.

    format string

    Possible values: [csv]

    Export file format.

    • csv - CSV
    endpoint stringrequired

    Possible values: <= 64 characters

    API endpoint to export data from. Available: account_findings, target_findings, targets, scans, domains, scheduled_scans

    filters

    Filter parameters to apply when querying the endpoint.

    fields

    List of fields to include in the export.

    send_email booleanrequired

    If true, the export file will be sent to the user via email when ready. Defaults to false.

    submitted_at date-timerequired

    Date and time when the export was requested, in ISO 8601 UTC format.

    generated_at date-timenullablerequired

    Date and time when the export file was generated, in ISO 8601 UTC format.

    row_count integernullablerequired

    Total number of rows exported.

    error stringnullablerequired

    Error message if export generation failed.

Loading...