v1

latestOpenAPI 3.0.32026-07-134103031.5 MB

Export

Send Export via 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.

post/export/{id}/send_email/

Path parameters

idstring required

A unique Base58 value identifying this object.

Request body

idstring required

A unique Base58 value identifying this object.

userstring required

A unique Base58 value identifying this object.

format'csv'

Export file format.

csv - CSV

endpointstring required

API endpoint to export data from. Available: targets, scans, domains, scheduled_scans, findings, discovery_assets

{"stackTrail":"components:schemas:ExportRequest:properties:filters","oasType":"schema","type":"unknown","description":"Filter parameters to apply when querying the endpoint."}

{"stackTrail":"components:schemas:ExportRequest:properties:fields","oasType":"schema","type":"unknown","description":"List of fields to include in the export."}

send_emailboolean required

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

submitted_atstring date-time required

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

generated_atstring date-time nullable required

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

row_countinteger nullable required

Total number of rows exported.

errorstring nullable required

Error message if export generation failed.

Response

idstring required

A unique Base58 value identifying this object.

userstring required

A unique Base58 value identifying this object.

format'csv'

Export file format.

csv - CSV

endpointstring required

API endpoint to export data from. Available: targets, scans, domains, scheduled_scans, findings, discovery_assets

{"stackTrail":"components:schemas:ExportRequest:properties:filters","oasType":"schema","type":"unknown","description":"Filter parameters to apply when querying the endpoint."}

{"stackTrail":"components:schemas:ExportRequest:properties:fields","oasType":"schema","type":"unknown","description":"List of fields to include in the export."}

send_emailboolean required

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

submitted_atstring date-time required

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

generated_atstring date-time nullable required

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

row_countinteger nullable required

Total number of rows exported.

errorstring nullable required

Error message if export generation failed.