Update Incident

POST

https://api.devrev.ai/incidents.update

POST

/incidents.update

1 curl -X POST https://api.devrev.ai/incidents.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "id": "foo"
6 }'

Try it

200incidentsUpdateExample

1 {
2   "incident": {
3     "id": "foo",
4     "title": "foo",
5     "acknowledged_date": "2023-01-01T12:00:00.000Z",
6     "actual_close_date": "2023-01-01T12:00:00.000Z",
7     "applies_to_parts": [
8       {
9         "display_id": "foo",
10         "id": "foo",
11         "name": "foo",
12         "owned_by": [
13           {}
14         ],
15         "sync_metadata": {
16           "external_reference": "foo",
17           "origin_system": "foo"
18         }
19       }
20     ],
21     "artifacts": [
22       {
23         "id": "foo",
24         "display_id": "foo",
25         "file": {
26           "type": "foo",
27           "name": "foo",
28           "size": 42
29         }
30       }
31     ],
32     "body": "foo",
33     "created_by": {
34       "display_id": "foo",
35       "id": "foo",
36       "display_name": "foo",
37       "display_picture": {
38         "display_id": "foo",
39         "id": "foo",
40         "file": {
41           "type": "foo",
42           "name": "foo",
43           "size": 42
44         }
45       },
46       "email": "foo",
47       "full_name": "foo",
48       "state": "active"
49     },
50     "created_date": "2023-01-01T12:00:00.000Z",
51     "custom_fields": {},
52     "custom_schema_fragments": [
53       "foo"
54     ],
55     "display_id": "foo",
56     "identified_date": "2023-01-01T12:00:00.000Z",
57     "impact": {
58       "count": {
59         "id": 42,
60         "label": "foo",
61         "ordinal": 42,
62         "value": null
63       },
64       "customer_ids": [
65         {
66           "id": "foo",
67           "display_id": "foo",
68           "display_name": "foo"
69         }
70       ]
71     },
72     "mitigated_date": "2023-01-01T12:00:00.000Z",
73     "modified_by": {
74       "display_id": "foo",
75       "id": "foo",
76       "display_name": "foo",
77       "display_picture": {
78         "display_id": "foo",
79         "id": "foo",
80         "file": {
81           "type": "foo",
82           "name": "foo",
83           "size": 42
84         }
85       },
86       "email": "foo",
87       "full_name": "foo",
88       "state": "active"
89     },
90     "modified_date": "2023-01-01T12:00:00.000Z",
91     "owned_by": [
92       {
93         "display_id": "foo",
94         "id": "foo",
95         "display_name": "foo",
96         "display_picture": {
97           "display_id": "foo",
98           "id": "foo",
99           "file": {
100             "type": "foo",
101             "name": "foo",
102             "size": 42
103           }
104         },
105         "email": "foo",
106         "full_name": "foo",
107         "state": "active"
108       }
109     ],
110     "pia": [
111       {
112         "id": "foo",
113         "article_type": "article",
114         "display_id": "foo",
115         "resource": {
116           "artifacts": [
117             {
118               "id": "foo",
119               "display_id": "foo",
120               "file": {
121                 "type": "foo",
122                 "name": "foo",
123                 "size": 42
124               }
125             }
126           ],
127           "url": "foo"
128         },
129         "sync_metadata": {
130           "external_reference": "foo",
131           "origin_system": "foo"
132         },
133         "title": "foo"
134       }
135     ],
136     "playbooks": [
137       {
138         "id": "foo",
139         "article_type": "article",
140         "display_id": "foo",
141         "resource": {
142           "artifacts": [
143             {
144               "id": "foo",
145               "display_id": "foo",
146               "file": {
147                 "type": "foo",
148                 "name": "foo",
149                 "size": 42
150               }
151             }
152           ],
153           "url": "foo"
154         },
155         "sync_metadata": {
156           "external_reference": "foo",
157           "origin_system": "foo"
158         },
159         "title": "foo"
160       }
161     ],
162     "reported_by": {
163       "id": 42,
164       "label": "foo",
165       "ordinal": 42,
166       "value": null
167     },
168     "severity": {
169       "id": 42,
170       "label": "foo",
171       "ordinal": 42,
172       "value": null
173     },
174     "source": {
175       "id": 42,
176       "label": "foo",
177       "ordinal": 42,
178       "value": null
179     },
180     "stage": {
181       "stage": {
182         "id": "foo",
183         "display_id": "foo",
184         "name": "foo"
185       },
186       "state": {
187         "id": "foo",
188         "display_id": "foo",
189         "is_final": true,
190         "name": "foo"
191       }
192     },
193     "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
194     "subtype": "foo",
195     "sync_metadata": {
196       "external_reference": "foo",
197       "last_sync_in": {
198         "status": "failed",
199         "sync_date": "2023-01-01T12:00:00.000Z",
200         "sync_unit": {
201           "id": "foo",
202           "display_id": "foo",
203           "external_system_type": "adaas",
204           "is_archived": true,
205           "name": "foo",
206           "sync_run": {
207             "mode": "initial",
208             "progress": {
209               "state": "completed"
210             }
211           },
212           "sync_type": "manual"
213         }
214       },
215       "last_sync_out": {
216         "status": "failed",
217         "sync_date": "2023-01-01T12:00:00.000Z",
218         "sync_unit": {
219           "id": "foo",
220           "display_id": "foo",
221           "external_system_type": "adaas",
222           "is_archived": true,
223           "name": "foo",
224           "sync_run": {
225             "mode": "initial",
226             "progress": {
227               "state": "completed"
228             }
229           },
230           "sync_type": "manual"
231         }
232       },
233       "origin_system": "foo"
234     },
235     "tags": [
236       {
237         "tag": {
238           "id": "foo",
239           "name": "foo",
240           "display_id": "foo",
241           "style_new": {
242             "color": "foo"
243           }
244         },
245         "value": "foo"
246       }
247     ],
248     "target_close_date": "2023-01-01T12:00:00.000Z"
249   }
250 }

Updates an incident.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The ID of the incident to be updated.

acknowledged_datestringOptionalformat: "date-time"

Timestamp when the incident was acknowledged.

applies_to_partsobjectOptional

artifactsobjectOptional

bodystringOptionalformat: "text"

Body of the incident.

custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

external_source_dataobjectOptional

identified_datestringOptionalformat: "date-time"

Time when the incident was identified/reported.

impactobjectOptional

mitigated_datestringOptionalformat: "date-time"

Timestamp when the incident was mitigated.

owned_byobjectOptional

piaobjectOptional

playbooksobjectOptional

related_docsobjectOptional

reported_bylongOptional

The entity that first reported the incident.

severitylongOptional

Severity of the incident.

stageobjectOptional

Update object for Stage.

stage_validation_optionslist of enumsOptional

The type of stage validations options when updating the stage or the stage diagram of an incident.

Allowed values:

staged_infoobjectOptional

Update object for StagedInfo.

sync_metadataobjectOptional

tagsobjectOptional

target_close_datestringOptionalformat: "date-time"

Timestamp when the incident is expected to be resolved.

titlestringOptionalformat: "text"

Title of the incident.

sourcelongOptionalDeprecated

Source of where the incident was created. Only sys users and service accounts are supposed to set this field.

Response

Success.

incidentobject

Update Incident

Headers

Request

Response

Errors