ONoneuptime
Scheduled Maintenance Event

Create Scheduled Maintenance Event

Endpoint to create a new Scheduled Maintenance Event

post/scheduled-maintenance

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "title": "Example Text",
    "slug": "example-slug",
    "startsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "endsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    }
  }
}

Response

Created 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",
    "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"
      }
    ],
    "proxmoxClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "openStackClouds": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "vmwareVCenters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "iotFleets": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "networkSites": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dockerSwarmClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "cephClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "storageArrays": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "databaseServers": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dataStoreIds": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "openStackParts": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "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"
      }
    ],
    "currentScheduledMaintenanceState": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "currentScheduledMaintenanceStateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "changeMonitorStatusTo": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "changeMonitorStatusToId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "startsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "endsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "subscriberNotificationStatusMessage": "This is an example of longer text content that provides detailed information.",
    "shouldStatusPageSubscribersBeNotifiedOnEventCreated": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": true,
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": true,
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "sendSubscriberNotificationsOnBeforeTheEvent": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "nextSubscriberNotificationBeforeTheEventAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "scheduledMaintenanceNumber": 42,
    "scheduledMaintenanceNumberWithPrefix": "Example 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.