v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Maintenances

List global maintenances

This endpoint is used to retrieve a list of maintenance that have been created within your organization's account in the Jira Service Management system. It optionally takes three parameters - offset, size and type.

get/api/{cloudId}/v1/maintenances

Query parameters

type'all' | 'non-expired' | 'past'

Defines which maintenance will be listed according to maintenance status.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "links": {
    "next": "/v1/maintenances?offset=50&size=25"
  }
}