ONoneuptime
Scheduled Maintenance Event

Get Scheduled Maintenance Event

Endpoint to retrieve a single Scheduled Maintenance Event by ID

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

Request

Path parameters

idstring uuid required

ID of the Scheduled Maintenance Event to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "title": true,
    "scheduledMaintenanceNumberWithPrefix": 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",
    "title": "Database Migration and Server 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"
      }
    ],
    "proxmoxClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "openStackClouds": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "vmwareVCenters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "iotFleets": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "networkSites": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dockerSwarmClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "cephClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "storageArrays": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "databaseServers": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dataStoreIds": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "openStackParts": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "services": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "statusPages": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "currentScheduledMaintenanceStateId": "123e4567-e89b-12d3-a456-426614174000",
    "changeMonitorStatusToId": "123e4567-e89b-12d3-a456-426614174000",
    "startsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "endsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "subscriberNotificationStatusOnEventScheduled": "Skipped",
    "subscriberNotificationStatusMessage": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "shouldStatusPageSubscribersBeNotifiedOnEventCreated": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": true,
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isOwnerNotifiedOfResourceCreation": true,
    "sendSubscriberNotificationsOnBeforeTheEvent": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "nextSubscriberNotificationBeforeTheEventAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "scheduledMaintenanceNumber": 42,
    "scheduledMaintenanceNumberWithPrefix": "Example short text",
    "isVisibleOnStatusPage": true,
    "publishOnStatusPageAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "enableReminders": true,
    "nextReminderNotificationAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "reminderNotificationSentCount": 42
  }
}

Changes

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