ONoneuptime
Incident On-Call Rule

Update Incident On-Call Rule

Endpoint to update an existing Incident On-Call Rule

put/incident-on-call-rule/{id}

Request

Path parameters

idstring uuid required

ID of the Incident On-Call Rule to update

Request body

Example request

{
  "data": {
    "whenToPage": "Example Text",
    "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
      }
    },
    "whenToPage": "Example Text",
    "workingHours": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "workingHoursTimezone": "Example Text",
    "aiHoldTimeInMinutes": 42,
    "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.",
    "isEnabled": true,
    "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.",
    "onCallDutyPolicies": [
      {
        "_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.