The Services API is designed to manage services and enable teams to manage services effectively. This resource represents the all contracts of Services in Jira Service Management.
This endpoint is designed to provide a comprehensive view of all services in your system. This API supports pagination with allowing you to customize the view based on your specific needs.
Forge and OAuth2 apps cannot access this REST resource.
integer
integer
Services returned successfully
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/' \
--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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"services": [
{
"id": "b:YXJpOmNsb3VkOmdyYXBoOjpzZXJ2aWNlLzIzYmNiMzU4LWUwNzItNDM0Ny05YzkyLWRhY2RjYjVmNGM0Zi84MjBiZjAxOC02OTQ1LTExZjAtYjcyNy0wYWZmZWM0NzkxZmY=",
"name": "AAAAAA - API - TEST 7",
"description": "Description",
"tier": 3,
"type": "SOFTWARE_SERVICES",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
},
"owner": "a1b2c3d4e5f6"
}
],
"pagination": {
"totalCount": 64,
"hasNext": true
}
}The endpoint allows users to programmatically generate services with customized parameters, including owners, approvers, and stakeholders.
Forge and OAuth2 apps cannot access this REST resource.
Service creation request
string
Requiredstring
integer
Requiredstring
string
ChangeApprovers
Responders
Stakeholders
Projects
Service created successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
curl --request POST \
--url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "My Service",
"description": "This is a sample service",
"tier": 2,
"type": "SOFTWARE_SERVICES",
"owner": "a1b2c3d4e5f6",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"id": "b:YXJpOmNsb3VkOmdyYXBoOjpzZXJ2aWNlLzIzYmNiMzU4LWUwNzItNDM0Ny05YzkyLWRhY2RjYjVmNGM0Zi84MjBiZjAxOC02OTQ1LTExZjAtYjcyNy0wYWZmZWM0NzkxZmY=",
"name": "AAAAAA - API - TEST 7",
"description": "Description",
"tier": 3,
"type": "SOFTWARE_SERVICES",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
},
"owner": "a1b2c3d4e5f6"
}This endpoint provides users the ability to retrieve comprehensive details of a specific service using its id (ARI).
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredService returned successfully
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/{service}' \
--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
25
26
27
28
29
30
31
32
{
"id": "b:YXJpOmNsb3VkOmdyYXBoOjpzZXJ2aWNlLzIzYmNiMzU4LWUwNzItNDM0Ny05YzkyLWRhY2RjYjVmNGM0Zi84MjBiZjAxOC02OTQ1LTExZjAtYjcyNy0wYWZmZWM0NzkxZmY=",
"name": "AAAAAA - API - TEST 7",
"description": "Description",
"tier": 3,
"type": "SOFTWARE_SERVICES",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
},
"owner": "a1b2c3d4e5f6"
}This endpoint is utilized to delete services.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredService deleted successfully
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/{service}' \
--user 'email@example.com:<api_token>'This endpoint is used to update an existing service with the specified configuration. Only provided fields will be updated.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredService update request
string
string
integer
string
string
ChangeApprovers
Responders
Stakeholders
Projects
Service updated successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/{service}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "My Service",
"description": "This is a sample service",
"tier": 2,
"type": "SOFTWARE_SERVICES",
"owner": "a1b2c3d4e5f6",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"id": "b:YXJpOmNsb3VkOmdyYXBoOjpzZXJ2aWNlLzIzYmNiMzU4LWUwNzItNDM0Ny05YzkyLWRhY2RjYjVmNGM0Zi84MjBiZjAxOC02OTQ1LTExZjAtYjcyNy0wYWZmZWM0NzkxZmY=",
"name": "AAAAAA - API - TEST 7",
"description": "Description",
"tier": 3,
"type": "SOFTWARE_SERVICES",
"changeApprovers": {
"groups": [
"0ab1db2d-4880-4c14-adc3-c4677f730dc8"
]
},
"responders": {
"users": [
"61a11abf3618cd006fa95ff8"
],
"teams": [
"7h8j9k0l1m2n",
"3p4q5r6s7t8u"
]
},
"stakeholders": {
"users": [
"61a11abf3618cd006fa95ff8"
]
},
"projects": {
"ids": [
"10002"
]
},
"owner": "a1b2c3d4e5f6"
}Rate this page: