Incident Grouping Rule
Update Incident Grouping Rule
Endpoint to update an existing Incident Grouping Rule
put/incident-grouping-rule/{id}
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Incident Grouping Rule to update
Request body
Example request
{
"data": {
"name": "Example Text",
"isEnabled": true,
"showEpisodeOnStatusPage": true
}
}Response
Updated successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"criteria": {
"key": "value",
"nested": {
"data": 123
}
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Example Text",
"description": "This is an example of longer text content that provides detailed information.",
"priority": 42,
"isEnabled": true,
"matchCriteria": {
"key": "value",
"nested": {
"data": 123
}
},
"monitors": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentSeverities": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentLabels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"monitorLabels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentTitlePattern": "This is an example of longer text content that provides detailed information.",
"incidentDescriptionPattern": "This is an example of longer text content that provides detailed information.",
"monitorNamePattern": "This is an example of longer text content that provides detailed information.",
"monitorDescriptionPattern": "This is an example of longer text content that provides detailed information.",
"groupByMonitor": true,
"groupBySeverity": true,
"groupByIncidentTitle": true,
"groupByIncidentLabels": true,
"groupByMonitorLabels": true,
"enableTimeWindow": true,
"timeWindowMinutes": 42,
"groupByFields": {
"key": "value",
"nested": {
"data": 123
}
},
"episodeTitleTemplate": "This is an example of longer text content that provides detailed information.",
"episodeDescriptionTemplate": "This is an example of longer text content that provides detailed information.",
"enableResolveDelay": true,
"resolveDelayMinutes": 42,
"enableReopenWindow": true,
"reopenWindowMinutes": 42,
"enableInactivityTimeout": true,
"inactivityTimeoutMinutes": 42,
"onCallDutyPolicies": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"defaultAssignToUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"defaultAssignToUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"defaultAssignToTeam": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"defaultAssignToTeamId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"episodeLabels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"episodeOwnerUsers": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"episodeOwnerTeams": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"episodeMemberRoles": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"episodeMemberRoleAssignments": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"showEpisodeOnStatusPage": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.