Get maintenance windows

Get the details of all maintenance windows for event broker service upgrades on a maintenance schedule.

Token Permissions: [ maintenance_schedules:read ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The identifier of the environment to filter by.

string

The identifier of the maintenance schedule to filter by.

integer
≥ 1
Defaults to 1

The page number for pagination.

integer
1 to 100
Defaults to 20

The number of items per page.

string
Defaults to createdTime,desc

The sorting criteria for the returned results.
You can sort the results by query parameter in ascending or descending order.
Define the sort order using the following string: field name:asc/desc where:

  • organizationId: The organization identifier.
  • maintenanceScheduleId: The identifier of the maintenance schedule.
  • maintenanceType: The type of maintenance type.
  • recurrenceDayOfWeek: The day of the week for the recurrence.
  • recurrenceFrequency: The frequency of the recurrence.
  • recurrenceDayOfWeekMonthly: The day of the recurrence, when the recurrence occurs on a specific day of the month. For example, if the recurrenceDayOfWeek returns Tuesday, and recurrenceDayOfWeekMonthly returns SECOND, then upgrades are triggered on the second Tuesday of a month.
  • startTime: The date and time of the recurrence starts.
  • durationInHours: The duration of the maintenance window, in hours.
  • createdBy: The identifier of the person who created the recurrence.
  • createdTime: The date and time the recurrence was created.
  • updatedBy: The identifier of the last person to update the recurrence.
  • updatedTime: The date and time the recurrence was last updated.
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json