Platform
Notifications and reports.
- Base URL
https://api.deepinfo.com/v1
Notifications
Rules that send email notifications when an event of their scope happens, and the log of emails sent.
| Method | Endpoint | Path |
|---|---|---|
| GET | Notification Email List/platform/notification-emailsLists notification emails that were sent, with the rule that triggered them. | /platform/notification-emails |
| GET | Notification Rule List/platform/notification-rulesLists notification rules. Filter and sort with the optional query parameters. | /platform/notification-rules |
| GET | Notification Rule Detail/platform/notification-rules/{rule_id}Returns one notification rule. | /platform/notification-rules/{rule_id} |
| POST | Notification Rule Create/platform/notification-rulesCreates a notification rule: the event scope (e.g. new_issue_detected), an optional strategy (conditions such as asset, severity, tags), frequency (instant, hourly, daily, weekly, monthly), delivery_hour / delivery_day_of_week and the team members (user ids) to email. | /platform/notification-rules |
| PUT | Notification Rule Update/platform/notification-rules/{rule_id}Updates a notification rule's name, delivery time, members and enabled. scope and strategy cannot be changed. | /platform/notification-rules/{rule_id} |
| DELETE | Notification Rule Delete/platform/notification-rules/{rule_id}Deletes a notification rule. | /platform/notification-rules/{rule_id} |
Reports
Generate, download and manage PDF reports.
| Method | Endpoint | Path |
|---|---|---|
| POST | Report Search/platform/reports/searchSearches reports. Different filter format: filters.type is required, other filters use operators like {"name": {"contains": "…"}}. | /platform/reports/search |
| GET | Report Detail/platform/reports/{report_id}Returns one report and its generation status. | /platform/reports/{report_id} |
| POST | Report Create/platform/reportsGenerates a report. type is one of easm_executive_summary, easm_weekly_progress, easm_asset_detail, easm_vulnerability_detail, easm_vulnerability_overview, easm_issue_overview, easm_issue_detail, cti_email_breach_summary. Generation takes a while; poll Report Detail, then Report Download. | /platform/reports |
| GET | Report Download/platform/reports/{report_id}/downloadReturns a pre-signed download_url for the report PDF. | /platform/reports/{report_id}/download |
| DELETE | Report Delete/platform/reports/{report_id}Deletes a report. | /platform/reports/{report_id} |
Scheduled Reports
Rules that generate and email reports on a schedule.
| Method | Endpoint | Path |
|---|---|---|
| GET | Scheduled Report Rule List/platform/scheduled-reports/rulesLists scheduled report rules. | /platform/scheduled-reports/rules |
| GET | Scheduled Report Rule Detail/platform/scheduled-reports/rules/{rule_id}Returns one scheduled report rule with last and next send dates. | /platform/scheduled-reports/rules/{rule_id} |
| POST | Scheduled Report Rule Create/platform/scheduled-reports/rulesCreates a scheduled report: type, frequency (daily, weekly, monthly) and the team members (user ids) who receive it. | /platform/scheduled-reports/rules |
| DELETE | Scheduled Report Rule Delete/platform/scheduled-reports/rules/{rule_id}Deletes a scheduled report rule. (There is no update; delete and create again.) | /platform/scheduled-reports/rules/{rule_id} |