Settings
PreviewNotification preferences and audit logs. Reference for API version next.
On this page
Get notification preferences
GET
/api/v1/settings/notifications Authentication
- API key in X-API-Key
- API key or session token in Authorization: Bearer
Responses
200Preferences.Body (application/json)
preferencesobject16 fields in
preferencesemail_enabledbooleanemail_scan_completebooleanemail_finding_criticalbooleanemail_finding_highbooleanemail_finding_mediumbooleanemail_finding_lowbooleanemail_weekly_digestbooleanemail_security_alertsbooleanemail_product_updatesbooleanbrowser_enabledbooleanbrowser_scan_completebooleanbrowser_findingsbooleanslack_enabledbooleanslack_scan_completebooleanslack_findings_criticalbooleansound_enabledboolean
Example
curl "https://api.breachline.io/api/v1/settings/notifications" \
-H "Authorization: Bearer $BREACHLINE_API_KEY"
{
"preferences": {
"email_enabled": true,
"email_scan_complete": true,
"email_finding_critical": true,
"email_finding_high": true,
"email_finding_medium": true,
"email_finding_low": true,
"email_weekly_digest": true,
"email_security_alerts": true,
"email_product_updates": true,
"browser_enabled": true,
"browser_scan_complete": true,
"browser_findings": true,
"slack_enabled": true,
"slack_scan_complete": true,
"slack_findings_critical": true,
"sound_enabled": true
}
}
Update notification preferences
PUT
/api/v1/settings/notifications Send only the fields to change.
Authentication
- API key in X-API-Key
- API key or session token in Authorization: Bearer
Request body
email_enabledbooleanemail_scan_completebooleanemail_finding_criticalbooleanemail_finding_highbooleanemail_finding_mediumbooleanemail_finding_lowbooleanemail_weekly_digestbooleanemail_security_alertsbooleanemail_product_updatesbooleanbrowser_enabledbooleanbrowser_scan_completebooleanbrowser_findingsbooleanslack_enabledbooleanslack_scan_completebooleanslack_findings_criticalbooleansound_enabledboolean
Responses
200The saved preferences.Body (application/json)
preferencesobject16 fields in
preferencesemail_enabledbooleanemail_scan_completebooleanemail_finding_criticalbooleanemail_finding_highbooleanemail_finding_mediumbooleanemail_finding_lowbooleanemail_weekly_digestbooleanemail_security_alertsbooleanemail_product_updatesbooleanbrowser_enabledbooleanbrowser_scan_completebooleanbrowser_findingsbooleanslack_enabledbooleanslack_scan_completebooleanslack_findings_criticalbooleansound_enabledboolean
Example
curl -X PUT "https://api.breachline.io/api/v1/settings/notifications" \
-H "Authorization: Bearer $BREACHLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
{
"preferences": {
"email_enabled": true,
"email_scan_complete": true,
"email_finding_critical": true,
"email_finding_high": true,
"email_finding_medium": true,
"email_finding_low": true,
"email_weekly_digest": true,
"email_security_alerts": true,
"email_product_updates": true,
"browser_enabled": true,
"browser_scan_complete": true,
"browser_findings": true,
"slack_enabled": true,
"slack_scan_complete": true,
"slack_findings_critical": true,
"sound_enabled": true
}
}
List audit log entries
GET
/api/v1/settings/audit-logs Your own trail with audit:read, or the whole organization's with scope=org and audit:read:org.
Authentication
- API key in X-API-Key
- API key or session token in Authorization: Bearer
Query parameters
limitinteger- Default
100- Minimum
1- Maximum
500
offsetinteger- Default
0- Minimum
0
severitystring or nullaction_typestring or nullscopestring- One of
meorg- Default
me
Responses
200A page of entries.Body (application/json)
successbooleanscopestringtotalintegerlimitintegeroffsetintegerlogsarray of objects12 fields in
logsidstringtimestampstring (date-time)actionstringtypestringseveritystringstatusstringactorstring or object or nulltargetstring or object or nullip_addressstring or nulluser_agentstring or nulldetailsobject or nullcompliance_tagsarray of strings
Example
curl "https://api.breachline.io/api/v1/settings/audit-logs" \
-H "Authorization: Bearer $BREACHLINE_API_KEY"
{
"success": true,
"scope": "string",
"total": 0,
"limit": 0,
"offset": 0,
"logs": [
{
"id": "string",
"timestamp": "2026-11-11T00:00:00Z",
"action": "string",
"type": "string",
"severity": "string",
"status": "string",
"actor": "string",
"target": "string",
"ip_address": "string",
"user_agent": "string",
"details": {},
"compliance_tags": [
"string"
]
}
]
}
Export audit log entries
GET
/api/v1/settings/audit-logs/export Requires audit:export (audit:export:org with scope=org).
Authentication
- API key in X-API-Key
- API key or session token in Authorization: Bearer
Query parameters
severitystring or nullaction_typestring or nullscopestring- One of
meorg- Default
me
Responses
200The export file.application/octet-stream
Example
curl "https://api.breachline.io/api/v1/settings/audit-logs/export" \
-H "Authorization: Bearer $BREACHLINE_API_KEY"