Sign in

v1

latestOpenAPI 3.0.02026-07-1310691106.0 KB
MaintenanceWindows
PreferredMaintenanceWindows

Returns all available windows for a given stack that a customer can choose as 'Preferred time and day of week'. The response groups available days by predefined regional off-hours time slots, with days ordered by availability (most available first). If start and end query parameters are provided, they must match one of the predefined time slots to filter results to that specific time slot only.

get/{stack}/adminconfig/v2/maintenance-windows/preferences/available-windows

Path parameters

stackstring required

The name of the stack.

Query parameters

startstring
Example:21:00

Start time of a predefined regional off-hours time slot in HH:MM UTC format. Must match one of the predefined time slots and be provided together with the corresponding end parameter.

endstring
Example:05:00

End time of a predefined regional off-hours time slot in HH:MM UTC format. Must match one of the predefined time slots and be provided together with the corresponding start parameter.

Response

successfully listed all available windows for preference selection

Example response

{
  "availableWindows": [
    {
      "daysOfWeek": [
        "Monday"
      ],
      "timeSlot": {
        "end": "21:00",
        "start": "13:00"
      }
    }
  ]
}