Submit Report¶
POST /1.3/redaction/report
Description¶
Redact a report using your company’s redaction library. All terms from your current redaction library will be applied to the title and body of your report. A report will be returned as a response for you to review before submitting to TruSTAR using the submit/update API endpoints.
Parameters¶
The request body must be well formed json with the following fields:
| Parameter | Required | Default | Description |
|---|---|---|---|
| title | X | Title of the report | |
| reportBody | X | Text content of report |
Response (200)¶
A JSON with the same format as the request body, where redaction has been applied to the title and body fields.
Example Usage¶
Request¶
curl -k -H "Content-Type: application/json" -X POST -d \
'{"title":"curl api-report for CompanyX", "reportBody":"This is a test report body that Jane Doe, jdoe@email.com, at CompanyX submitted with some indicators: 1.2.3.4, evil.exe, api.evildomain.com, hash d2dd1bcdd6d6cfac59ba9638d2cd886c"}' \
-H "Authorization: Bearer {access_token}" "https://api.trustar.co/api/1.3/redaction/report"
Response¶
{
"title": "curl api-report for <company>",
"reportBody": "This is a test report body that <person>, <email-address>, at <company> submitted with some indicators: 1.2.3.4, evil.exe, api.evildomain.com, hash d2dd1bcdd6d6cfac59ba9638d2cd886c",
}