Maintenance Events

[
  {
    "endTime": "2024-05-24T09:42:00.000Z",
    "eventId": "CSS-1234",
    "eventType": "Emergency",
    "impact": "There will be minor impact on services.",
    "purpose": "Services will become more effective",
    "services": [
      "f06c80bc",
      "0746e9a3"
    ],
    "startTime": "2024-05-24T09:12:00.000Z",
    "state": "Scheduled"
  },
  {
    "cancelReason": "Not Needed",
    "endTime": "2024-05-24T09:42:00.000Z",
    "eventId": "CSS-1235",
    "eventType": "Emergency",
    "impact": "There will be minor impact on services.",
    "purpose": "Services will become more effective",
    "services": [
      "f06c80bc",
      "0746e9a3"
    ],
    "startTime": "2024-05-24T09:12:00.000Z",
    "state": "Cancelled"
  }
]

Returns details about maintenance events, filtered by the specified state value.

The following information is returned for maintenance events in the response, with some fields being optional and only included under certain conditions. For example, cancelReason is returned only if the event is canceled.

eventId - Ticket number against which a particular event is created.
state - Current state of the event.
startTime - Event start time in ISO 8601 UTC format (yyyy-MM-dd’T’HH:mm:ss.SSSX).
endTime - Event end time in ISO 8601 UTC format (yyyy-MM-dd’T’HH:mm:ss.SSSX).
impact - Impact of the event on the services, if any.
purpose - Reason why this event is created.
cancelReason - Field returned if the event is canceled, stating the cancellation reason.
eventType - If the event is created on short notice, the event type is “Emergency”; otherwise, it is a “Planned” event.
services - List of services affected by the event, containing the short UUIDs of the services.

Query parameters

statestringOptional

Filter by the state of the maintenance event. The values for state are “Completed”, “Cancelled”, “Scheduled” and “Running”. If you don’t specify a value, the default is “Running”. Values are case-insensitive. (Optional).

Response

Maintenance Events - Scheduled / Maintenance Events - Managed Account / Maintenance Events - Managed Account / Maintenance Events - Scheduled

cancelReasonstringOptional

endTimestringOptional

eventIdstringOptional

eventTypestringOptional

impactstringOptional

purposestringOptional

serviceslist of stringsOptional

startTimestringOptional

statestringOptional