Alert Grouping Rule

Update Alert Grouping Rule

Endpoint to update an existing Alert Grouping Rule

put/alert-grouping-rule/{id}

Request

Path parameters

idstring uuid required

ID of the Alert Grouping Rule to update

Request body

Example request

{
  "data": {
    "name": "Example Text",
    "isEnabled": 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"
      }
    ],
    "alertSeverities": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "alertLabels": [
      {
        "_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"
      }
    ],
    "alertTitlePattern": "This is an example of longer text content that provides detailed information.",
    "alertDescriptionPattern": "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,
    "groupByAlertTitle": true,
    "groupByAlertLabels": 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"
      }
    ],
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.