Alert - Get

GET

/alerts/:alertId

GET

/management/alerts/:alertId

1 import requests
2 
3 url = "https://sandbox.api.flagright.com/management/alerts/alertId"
4 
5 headers = {"x-api-key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

1 {
2   "alertId": "string",
3   "createdTimestamp": 2700000000000,
4   "caseId": "string",
5   "priority": "P1",
6   "ruleDetails": {
7     "id": "string",
8     "name": "string",
9     "action": "ALLOW",
10     "description": "string",
11     "instanceId": "string",
12     "nature": "AML"
13   },
14   "alertStatus": "OPEN",
15   "updatedAt": 1.1,
16   "tags": [
17     {
18       "key": "string",
19       "value": "string",
20       "isTimestamp": true
21     }
22   ],
23   "creationReason": {
24     "reasons": [
25       "string"
26     ],
27     "comment": "string",
28     "timestamp": 2700000000000
29   },
30   "entityDetails": {
31     "type": "TRANSACTION",
32     "transactionIds": [
33       "string"
34     ]
35   },
36   "assignments": [
37     {
38       "assigneeEmail": "string",
39       "assignedByEmail": "string",
40       "timestamp": 2700000000000
41     }
42   ]
43 }

Retrieve an Alert

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

alertIdstringRequired

Response

alertIdstring

createdTimestampdouble1262300400000-4133890801000

caseIdstring

priorityenum

Allowed values:

ruleDetailsobject

alertStatusenum

updatedAtdouble

tagslist of objects or null

creationReasonobject or null

entityDetailsobject or null

assignmentslist of objects or null

Retrieve an Alert

Authentication

Path parameters

Response

Errors