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.

Operations

GET/POST/GET/{service}DEL/{service}PATCH/{service}

GET

List servicesExperimental

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.

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

Request

Query parameters

offset

integer

size

integer

Responses

Services returned successfully

application/json

ListServicesResponse

GET/

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

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

POST

Create a new serviceExperimental

The endpoint allows users to programmatically generate services with customized parameters, including owners, approvers, and stakeholders.

OAuth 2.0 scopes required:

write:ops-config:jira-service-management

read:ops-config:jira-service-management

Request

Request bodyapplication/json

Service creation request

name

string

Required

description

string

tier

integer

Required

type

string

owner

string

changeApprovers

ChangeApprovers

responders

Responders

stakeholders

Stakeholders

projects

Projects

Responses

Service created successfully

application/json

Service

POST/

curl

Node.js

Java

Python

PHP

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

201Response

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

GET

Get serviceExperimental

This endpoint provides users the ability to retrieve comprehensive details of a specific service using its id (ARI).

OAuth 2.0 scopes required:

read:ops-config:jira-service-management

Request

Path parameters

service

string

Required

Responses

Service returned successfully

application/json

Service

GET/{service}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/{service}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

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

DEL

Delete serviceExperimental

This endpoint is utilized to delete services.

OAuth 2.0 scopes required:

write:ops-config:jira-service-management

read:ops-config:jira-service-management

Request

Path parameters

service

string

Required

Responses

Service deleted successfully

DEL/{service}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/api/{cloudId}/v1/services/{service}' \
  --user 'email@example.com:<api_token>'

PATCH

Update a serviceExperimental

This endpoint is used to update an existing service with the specified configuration. Only provided fields will be updated.

OAuth 2.0 scopes required:

write:ops-config:jira-service-management

read:ops-config:jira-service-management

Request

Path parameters

service

string

Required

Request bodyapplication/json

Service update request

name

string

description

string

tier

integer

type

string

owner

string

changeApprovers

ChangeApprovers

responders

Responders

stakeholders

Stakeholders

projects

Projects

Responses

Service updated successfully

application/json

Service

PATCH/{service}

curl

Node.js

Java

Python

PHP

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

200Response

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