This functionality is available only with Barracuda Email Protection Premium and Premium Plus plans. To upgrade to one of these plans, contact your Barracuda Networks Sales Representative.
Retrieves a list of created incidents for a Microsoft 365 tenant.
See Get Incident to retrieve a single incident using the incident ID.
Endpoint
GET /beta/accounts/{accountId}/forensics/{tenantId}/incidents
Parameters
Name | Type | Required | Description |
---|---|---|---|
Path Parameters | |||
accountId | string | * | The Barracuda Cloud Control account ID obtained from the Get Accounts API. |
tenantId | string | * | The Microsoft 365 tenant ID obtained from the Get Tenants API. |
Query Parameters | |||
labels | array[string] | The labels used to filter results. | |
page | integer | The current page to return. Default value : 0 | |
size | integer | The number of results to return. Default value : 10 |
Response Codes
Code | Description |
---|---|
200 | OK |
401 | Unauthorized: There is a missing or incorrect API token in header or the client did not have permission to access the requested resource. |
Response
Entry | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
itemsTotal | The total number of items. | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pageNum | The current page number. | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pagesTotal | The total number of pages. | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results* |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resultsCount | The number of items on the current page. | integer |
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{accountId}/forensics/{tenantId}/incidents" \
--header "Authorization: Bearer {access_token}"
Sample Response
{
"resultsCount": 1,
"pageNum": 0,
"itemsTotal": 1,
"pagesTotal": 1,
"results": [
{
"id": "2047f505-ea48-4740-a370-a98611ea0c9f",
"created": "2021-04-05T09:00:00.000000Z",
"createdBy": "",
"createdByName": "Public API",
"sender": {
"email": "",
"displayName": ""
},
"subject": "Example Subject",
"attachmentName": "",
"timeframe": 720,
"remediatedEmailCount": 1,
"notifiedEmailCount": 0,
"continuousRemediationCount": 0,
"distinctRecipientCount": 1,
"remediationStatus": "Completed",
"remediationActions": {
"messageAction": "DELETE",
"notify": false,
"sendSummary": true,
"enableContinuousRemediation": false
},
"senderPolicies": [],
"domains": [
"barracuda.com"
],
"continuousRemediationUntil": null,
"incidentDetails": {
"source": "Public-Api",
"subSource": null
},
"labels": []
}
]
}