Alert - Update

PATCH

/alerts/:alertId

Update Alert

Path parameters

alertIdstringRequired

Request

This endpoint expects an object.

priorityenumOptional

Allowed values: P1P2P3P4

tagslist of objectsOptional

creationReasonobjectOptional

entityDetailsobjectOptional

assignmentslist of objectsOptional

ruleDetailsobjectOptional

Response

This endpoint returns an object.

alertIdstring

createdTimestampdouble

caseIdstring

priorityenum

Allowed values: P1P2P3P4

entityDetailsobject

ruleDetailsobject

alertStatusenum

updatedAtdouble

tagslist of objectsOptional

creationReasonobjectOptional

assignmentslist of objectsOptional

Errors

PATCH

1 curl -X PATCH https://sandbox.api.flagright.com/management/alerts/:alertId \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

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

Built with

1	curl -X PATCH https://sandbox.api.flagright.com/management/alerts/:alertId \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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