ONoneuptime
Scheduled Maintenance Event

List Scheduled Maintenance Event

Endpoint to list all Scheduled Maintenance Event items

post/scheduled-maintenance/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "title": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "title": true,
    "scheduledMaintenanceNumberWithPrefix": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

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.