Scheduled Maintenance Template

Update Scheduled Maintenance Template

Endpoint to update an existing Scheduled Maintenance Template

put/scheduled-maintenance-template/{id}

Request

Path parameters

idstring uuid required

ID of the Scheduled Maintenance Template to update

Request body

Example request

{
  "data": {
    "templateName": "Example Text",
    "templateDescription": "This is an example of longer text content that provides detailed information.",
    "title": "Example Text"
  }
}

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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "templateName": "Example Text",
    "templateDescription": "This is an example of longer text content that provides detailed information.",
    "title": "Example Text",
    "description": null,
    "slug": "example-slug",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitors": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "hosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "kubernetesClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dockerHosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "podmanHosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "services": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "statusPages": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "changeMonitorStatusTo": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "changeMonitorStatusToId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "firstEventScheduledAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "firstEventStartsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "firstEventEndsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "recurringInterval": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isRecurringEvent": true,
    "scheduleNextEventAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "shouldStatusPageSubscribersBeNotifiedOnEventCreated": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": true,
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "sendSubscriberNotificationsOnBeforeTheEvent": {
      "key": "value",
      "nested": {
        "data": 123
      }
    }
  }
}

Changes

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