ONoneuptime
Scheduled Maintenance Template

Get Scheduled Maintenance Template

Endpoint to retrieve a single Scheduled Maintenance Template by ID

post/scheduled-maintenance-template/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Scheduled Maintenance Template to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "templateName": true,
    "title": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "templateName": "Database Upgrade Template",
    "templateDescription": "Use this template for scheduled database upgrades and migrations. Includes pre-maintenance notifications, maintenance window updates, and post-maintenance completion notifications.",
    "title": "Scheduled Database Maintenance - PostgreSQL Upgrade",
    "description": "# Heading\n\nThis is **markdown** content",
    "slug": "example-slug-value",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "monitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "hosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "kubernetesClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dockerHosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "podmanHosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "services": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "statusPages": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "changeMonitorStatusToId": "123e4567-e89b-12d3-a456-426614174000",
    "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.