---
title: "Update global maintenance"
method: PATCH
path: "/api/{cloudId}/v1/maintenances/{id}"
tags: ["Maintenances"]
---

# Update global maintenance

`PATCH /api/{cloudId}/v1/maintenances/{id}`

This endpoint is used to update a global maintenance in Jira Service Management.

## Path parameters

- `id` string, required

## Request body

- UpdateMaintenanceRequest
  - `description` string — Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.
  - `startDate` string, date-time — Date and time when the maintenance plan starts.
  - `endDate` string, date-time — Date and time when the maintenance plan ends.
  - `rules` MaintenanceRule[] — Rules of maintenance, which takes a list of rule objects and defines the maintenance rules over policies, integrations and syncs.
    - `entity` MaintenanceEntity, required — Entities within a maintenance policy rule are used to specify which entity like policy, integration or sync should enabled or disabled during maintenance period.
      - `id` string
      - `type` 'sync' | 'integration' | 'policy'
    - `state` 'disabled' | 'enabled', required — State of rule that will be defined in maintenance. This field has to be disabled for integrations and syncs.

## Response `200`

Returned if the request is successful.

- GetGlobalMaintenance
  - `id` string — Identifier of the maintenance.
  - `status` 'cancelled' | 'past' | 'active' | 'planned' — Current status of the maintenance plan.
  - `description` string — Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.
  - `startDate` string, date-time — Date and time when the maintenance plan starts.
  - `endDate` string, date-time — Date and time when the maintenance plan ends.
  - `rules` object[] — Rules of maintenance, which takes a list of rule objects and defines the maintenance rules over policies, integrations and syncs.
    - `entity` MaintenanceEntity — Entities within a maintenance policy rule are used to specify which entity like policy, integration or sync should enabled or disabled during maintenance period.
      - `id` string
      - `type` 'sync' | 'integration' | 'policy'
    - `state` 'disabled' | 'enabled' — State of rule that will be defined in maintenance. This field has to be disabled for integrations and syncs.

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the request user does not have permission to update maintenance.
- `404` — Returned if the maintenance is not found.
- `422` — Returned if the payload cannot be validated.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)
