breaches
Get the details for an identity breach
Returns the details of an identity breach.
Required API key permissions: IdentityBreaches (select when creating API key in Account Settings)
get/breach
Request
- Base URLhttps://cyber-risk.upguard.com/api/public
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
idstring
The ID of the breach to fetch
Response
Details of an identity breach
Example response
{
"breach": {
"assignee_user_email": "viggo@example.com",
"breach_status": "active",
"breach_type": "Company",
"date_notified": "2019-11-09T03:48:57Z",
"date_occurred": "2019-11-09T03:48:57Z",
"date_published": "2019-11-09T03:48:57Z",
"description": "In November 2019, all customer records of Acme Inc. were made publicly available for 13 hours.",
"domain": "acme.com",
"employee_count": 10,
"exposed_data_classes": [
"Passwords",
"Usernames",
"Email addresses",
"Social security numbers",
"Banking PINs",
"Credit cards"
],
"id": 101,
"name": "AcmeInc",
"severity": "High",
"title": "Acme Inc.",
"total_exposures": 9673824
},
"comments": [
{
"comment": "My comment text",
"created_at": "2019-11-09T03:48:57Z",
"created_by_email": "viggo@example.com"
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.