A set of rules that can be added to enable or disable multiple policies, integrations or syncs with a single entry. This resource represents the all contracts of maintenance plans in Jira Service Management.
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.
read:ops-config:jira-service-managementstring
integer
integer
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"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"
}
}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. Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementMaintenanceDescription
StartDate
EndDate
array<MaintenanceRule>
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"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"
}
}
]
}Gets an account based global maintenance with given id in the request.
read:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"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"
}
}
]
}This request is used to delete a global maintenance.
read:ops-config:jira-service-managementdelete:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances/{id}' \
--user 'email@example.com:<api_token>'This endpoint is used to update a global maintenance in Jira Service Management.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
RequiredMaintenanceDescription
StartDate
EndDate
array<MaintenanceRule>
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"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"
}
}
]
}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.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/maintenances/{id}/cancel' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"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"
}
}
]
}This endpoint is used to retrieve a list of maintenance associated with a specific team in the Jira Service Management system. It optionally takes three parameters - offset, size and type.
read:ops-config:jira-service-managementstring
Requiredstring
integer
integer
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"values": [
{
"id": "0762db96-f795-4246-90be-edd295af8fca",
"status": "cancelled",
"description": "Maintenance Plan",
"startDate": "2023-12-11T11:37:39.501Z",
"endDate": "2023-12-11T11:42:39.501Z",
"rules": [
{
"entity": {
"id": "258bec1f-bae6-4190-bcc6-56c42990131c",
"type": "policy"
},
"state": "enabled"
}
],
"teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25"
}
],
"links": {
"next": "/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/maintenances?offset=50&size=25"
}
}This endpoint is used to create a new maintenance for a specific team in Jira Service Management. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
RequiredMaintenanceDescription
StartDate
EndDate
array<MaintenanceRule>
RequiredReturned if the request is successful and a new maintenance has been created.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25",
"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"
}
}
]
}This request is used to retrieve a specific maintenance of a specific team.
read:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25",
"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"
}
}
]
}Deletes a maintenance with given id in the request.
read:ops-config:jira-service-managementdelete:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances/{id}' \
--user 'email@example.com:<api_token>'Updates a team maintenance with given id in the request.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
RequiredMaintenanceDescription
StartDate
EndDate
array<MaintenanceRule>
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25",
"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"
}
}
]
}This endpoint is used to stop an ongoing maintenance plan of a specific team early. The functionality allows you to end the maintenance period before the initially set end time.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/maintenances/{id}/cancel' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"teamId": "77b933c9-92bb-46e7-a73c-764b8d7c3c25",
"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"
}
}
]
}Rate this page: