Alert - Get

GET

/alerts/:alertId

GET

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

Try it

200Retrieved

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

Retrieve an Alert

Path parameters

alertIdstringRequired

Response

alertIdstring

createdTimestampdouble>=1262300400000<=4133890801000

caseIdstring

priorityenum

Allowed values:

entityDetailsobject

ruleDetailsobject

alertStatusenum

updatedAtdouble

tagslist of objectsOptional

creationReasonobjectOptional

assignmentslist of objectsOptional

Alert - Get

Retrieve an Alert

Path parameters

Headers

Response

Errors