---
title: "Create global maintenance"
method: POST
path: "/api/{cloudId}/v1/maintenances"
tags: ["Maintenances"]
---

# Create global maintenance

`POST /api/{cloudId}/v1/maintenances`

This endpoint is used to create a new maintenance which applies rules to all teams across your organization in Jira Service Management. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. <b>Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.</b>

## Request body

- CreateMaintenanceRequest
  - `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[], required — 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 `201`

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

- `400` — Returned if the request is malformed or the request data is invalid.
- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the request user does not have permission to create maintenance.
- `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/revisions/ed65f017bcb8/schema)
