manage_maintenance_window
Manage Freshservice maintenance windows: create, update, list, get, or delete them, and optionally link changes and publish status page maintenance.
Instructions
Manage Freshservice Maintenance Windows.
Maintenance Windows are time-based windows used to schedule planned
maintenance. They can be associated with Changes and are REQUIRED
to publish a maintenance on a Status Page.
ONE-STOP WORKFLOW — Create MW + associate Change + publish on Status Page:
Call action='create' with:
- name, description, start_time, end_time (MW fields)
- change_id (auto-associates MW with the Change)
- impacted_services (triggers auto-publish on Status Page)
This single call will:
a) Create the Maintenance Window
b) Associate it with the Change (if change_id provided)
c) Publish it on the Status Page (if impacted_services provided)
d) Return MW details, association status, and Status Page maintenance
impacted_services format: [{"id": <service_component_id>, "status": N}]
Status: 1=Operational, 5=Under maintenance, 10=Degraded,
20=Partial outage, 30=Major outage
To find service_component IDs, use manage_status_page
action='list_components'.
ALTERNATIVE: You can also do each step separately:
- manage_maintenance_window create (without impacted_services)
- manage_change update with maintenance_window_id
- manage_status_page create_maintenance with maintenance_window_id
Args:
action: One of 'list', 'get', 'create', 'update', 'delete'.
maintenance_window_id: MW ID (required for get/update/delete).
change_id: Change ID — if provided on 'create', the new MW
is automatically associated with this Change.
name: MW name (required for create).
description: MW description.
start_time: ISO datetime — window start (required for create).
end_time: ISO datetime — window end (required for create).
workspace_id: Workspace ID (required for create; auto-discovered
if omitted).
alert_suppression: Suppress alerts during window (default false).
impacted_services: If provided on 'create', auto-publishes a
maintenance on the Status Page after creating the MW.
Format: [{"id": <service_component_id>, "status": <int>}]
Status: 1=Operational, 5=Under maintenance, 10=Degraded,
20=Partial outage, 30=Major outage.
notifications: Status Page notification triggers (optional).
Format: [{"trigger": N, "options": {"value": V}}]
Trigger: 1=On start, 2=Before start, 3=On complete.
is_private: Mark the Status Page maintenance as private.
page/per_page: Pagination (list).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| action | Yes | ||
| end_time | No | ||
| per_page | No | ||
| change_id | No | ||
| is_private | No | ||
| start_time | No | ||
| description | No | ||
| workspace_id | No | ||
| notifications | No | ||
| alert_suppression | No | ||
| impacted_services | No | ||
| maintenance_window_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |