Alert - Get

GET

/alerts/:alertId

GET

/management/alerts/:alertId

1 curl https://sandbox.api.flagright.com/management/alerts/alertId \
2      -H "x-api-key: <x-api-key>"

Try it

200getAlertsAlertIdExample

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

Retrieve an Alert

Path parameters

alertIdstringRequired

Response

alertIdstring

createdTimestampdouble>=1262300400000<=4133890801000

caseIdstring

priorityenum

Allowed values:

entityDetailsobject

ruleDetailsobject

alertStatusenum

updatedAtdouble

tagslist of objects or null

creationReasonobject or null

assignmentslist of objects or null

Alert - Get

Retrieve an Alert

Path parameters

Headers

Response

Errors