---
updatedAt: 2026-07-28T19:57:20.000Z
---
# Update a maintenance window
Update a maintenance window for an event broker service upgrade on a maintenance schedule.
The changes you make with this API do not affect scheduled upgrades for event brokers services in the maintenance window.
Token Permissions: [ maintenance_schedules:write ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/maintenanceWindows/{maintenanceWindowId}": {
"put": {
"tags": [
"Maintenance Windows"
],
"summary": "Update a maintenance window",
"description": "Update a maintenance window for an event broker service upgrade on a maintenance schedule.\nThe changes you make with this API do not affect scheduled upgrades for event brokers services in the maintenance window.\n
Token Permissions: [ maintenance_schedules:write ]",
"operationId": "updateMaintenanceWindow",
"parameters": [
{
"name": "maintenanceWindowId",
"in": "path",
"description": "The unique identifier of the maintenance window you want to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceWindowRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceWindowResponse"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "You do not have permissions to perform this operation.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/json": {}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']",
"items": {
"type": "string",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
}
},
"MaintenanceWindow": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the maintenance window."
},
"name": {
"type": "string",
"description": "The name of the maintenance window."
},
"environmentId": {
"type": "string",
"description": "The unique identifier of the environment the maintenance window belongs to."
},
"organizationId": {
"type": "string",
"description": "The unique identifier of the organization the maintenance window belongs to."
},
"maintenanceScheduleId": {
"type": "string",
"description": "The unique identifier of the maintenance schedule the maintenance window belongs to."
},
"maintenanceType": {
"type": "string",
"description": "The type of maintenance schedule. \n\n- DATA_PATH: Maintenance affecting resources responsible for data operations, such as event broker services.
\n\n- CONTROL_PLANE: Maintenance affecting resources responsible for environment operations, such as the Mission Control Agent.
\n\n
",
"enum": [
"DATA_PATH",
"CONTROL_PLANE"
]
},
"recurrenceDayOfWeek": {
"type": "string",
"description": "The day of the week when maintenance will occur.",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"recurrenceFrequency": {
"type": "string",
"description": "The frequency of maintenance recurrence.",
"enum": [
"WEEKLY",
"MONTHLY"
]
},
"recurrenceDayWeekly": {
"type": "string",
"description": "Indicates the number of weeks between occurrences. This value only applies when recurrence frequency is set to weekly.",
"enum": [
"EVERY",
"EVERY_OTHER",
"EVERY_THREE",
"EVERY_FOUR"
]
},
"recurrenceDayOfWeekMonthly": {
"type": "string",
"description": "Indicates the specific day within a month for the occurrence. This value only applies when recurrenceFrequency is set to monthly.\nFor example, if the recurrenceDayOfWeek returns Tuesday, and recurrenceDayOfWeekMonthly returns SECOND,\nthen upgrades are triggered on the second Tuesday of a month.\n",
"enum": [
"FIRST",
"SECOND",
"THIRD",
"LAST"
]
},
"startTime": {
"type": "string",
"description": "The start time of the maintenance window.",
"format": "date-time"
},
"durationInHours": {
"type": "integer",
"description": "The duration of the maintenance window in hours.",
"format": "int32"
},
"createdBy": {
"type": "string",
"description": "The identifier of the user who created the maintenance window."
},
"createdTime": {
"type": "string",
"description": "The timestamp when the maintenance window was created.",
"format": "date-time"
},
"updatedBy": {
"type": "string",
"description": "The identifier of the user who last updated the maintenance window."
},
"updatedTime": {
"type": "string",
"description": "The timestamp when the maintenance window was last updated.",
"format": "date-time"
},
"maintenanceWindowScope": {
"type": "string",
"description": "The scope of the maintenance window. ENVIRONMENT indicates environment-specific maintenance, SYSTEM indicates system-wide maintenance.",
"enum": [
"ENVIRONMENT",
"SYSTEM"
]
},
"upcomingMaintenanceTimes": {
"type": "array",
"description": "Shows a list of available times for the maintenance window.",
"items": {
"$ref": "#/components/schemas/UpcomingMaintenanceTime"
}
},
"type": {
"type": "string",
"description": "The type of object for informational purposes."
}
}
},
"MaintenanceWindowRequest": {
"required": [
"durationInHours",
"maintenanceScheduleId",
"recurrenceDayOfWeek",
"recurrenceFrequency",
"startTime"
],
"type": "object",
"properties": {
"maintenanceScheduleId": {
"type": "string",
"description": "The unique identifier of the maintenance schedule the maintenance window belongs to."
},
"name": {
"type": "string",
"description": "The name of the maintenance window."
},
"recurrenceDayOfWeek": {
"type": "string",
"description": "The day of the week when maintenance will occur.",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"recurrenceFrequency": {
"type": "string",
"description": "The frequency of maintenance recurrence.",
"enum": [
"WEEKLY",
"MONTHLY"
]
},
"recurrenceDayWeekly": {
"type": "string",
"description": "Indicates the number of weeks between occurrences. This value only applies when recurrence frequency is set to weekly.",
"enum": [
"EVERY",
"EVERY_OTHER",
"EVERY_THREE",
"EVERY_FOUR"
]
},
"recurrenceDayOfWeekMonthly": {
"type": "string",
"description": "Indicates the specific day within a month for the occurrence. This value only applies when recurrenceFrequency is set to monthly.\nFor example, if the recurrenceDayOfWeek returns Tuesday, and recurrenceDayOfWeekMonthly returns SECOND,\nthen upgrades are triggered on the second Tuesday of a month.\n",
"enum": [
"FIRST",
"SECOND",
"THIRD",
"LAST"
]
},
"startTime": {
"type": "string",
"description": "The start time of the maintenance window.",
"format": "date-time"
},
"durationInHours": {
"type": "integer",
"description": "The duration of the maintenance window in hours.",
"format": "int32"
}
}
},
"MaintenanceWindowResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MaintenanceWindow"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"UpcomingMaintenanceTime": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
}
},
"description": "Shows a list of available times for the maintenance window."
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```