Solace DocsDeveloper HubSolace Community
API Reference

Create a maintenance window

post
https://api.solace.cloud/api/v2/missionControl/maintenanceWindows

Create a maintenance window for an event broker service upgrade on a maintenance schedule.

Token Permissions: [ maintenance_schedules:write ]

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

The unique identifier of the maintenance schedule the maintenance window belongs to.

string

The name of the maintenance window.

string
enum
required

The day of the week when maintenance will occur.

Allowed:
string
enum
required

The frequency of maintenance recurrence.

Allowed:
string
enum

Indicates the number of weeks between occurrences. This value only applies when recurrence frequency is set to weekly.

Allowed:
string
enum

Indicates the specific day within a month for the occurrence. This value only applies when recurrenceFrequency is set to monthly.
For example, if the recurrenceDayOfWeek returns Tuesday, and recurrenceDayOfWeekMonthly returns SECOND,
then upgrades are triggered on the second Tuesday of a month.

Allowed:
date-time
required

The start time of the maintenance window.

int32
required

The duration of the maintenance window in hours.

Responses

Updated 5 months ago

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

Updated 5 months ago