ATatlassian
Maintenances

Cancel global maintenance

This endpoint is used to stop an ongoing maintenance plan early. The functionality allows you to end the maintenance plan before the initially set end time.

post/api/{cloudId}/v1/maintenances/{id}/cancel

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances/{id}/cancel
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-config:jira-service-management, write:ops-config:jira-service-management

Path parameters

idstring required

Identifier of the maintenance.

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"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.