Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Maintenances

Create global maintenance

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>

post/api/{cloudId}/v1/maintenances

Request body

descriptionstring

Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.

startDatestring date-time

Date and time when the maintenance plan starts.

endDatestring date-time

Date and time when the maintenance plan ends.

Example request

{
  "description": "Maintenance Plan",
  "startDate": "2023-12-11T11:37:40.501Z",
  "endDate": "2023-12-11T11:42:40.501Z",
  "rules": [
    {
      "state": "disabled",
      "entity": {
        "id": "51e9e162-767b-47a6-a00a-4cd8b6f94829",
        "type": "integration"
      }
    }
  ]
}

Response

Returned if the request is successful.

idstring

Identifier of the maintenance.

status'cancelled' | 'past' | 'active' | 'planned'

Current status of the maintenance plan.

descriptionstring

Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.

startDatestring date-time

Date and time when the maintenance plan starts.

endDatestring date-time

Date and time when the maintenance plan ends.

Example response

{
  "id": "0762db96-f795-4246-90be-edd295af8fca",
  "status": "cancelled",
  "description": "Maintenance Plan",
  "startDate": "2023-12-11T11:37:40.501Z",
  "endDate": "2023-12-11T11:42:40.501Z",
  "rules": [
    {
      "state": "disabled",
      "entity": {
        "id": "51e9e162-767b-47a6-a00a-4cd8b6f94829",
        "type": "integration"
      }
    }
  ]
}