Jira 9.12 REST API change log

Preparing for Jira 9.12

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

Jira 9.12 is a Long Term Support release and this change log will give you an overview of any REST API changes between Jira Long Term Support release 8.13 up through 9.4, and all the way until 9.12.


On this page:

8.13

No changes

8.14

ADDED

api/2/cluster

Request current index from node

PUT /rest/api/2/cluster/index-snapshot/{nodeId}

ADDED

api/2/email-templates

Upload email templates



POST /rest/api/2/email-templates

ADDED

api/2/email-templates

Download email templates



GET /rest/api/2/email-templates

ADDED

api/2/email-templates

Apply email templates



POST /rest/api/2/email-templates/apply

ADDED

api/2/email-templates

Revert email templates to default



POST /rest/api/2/email-templates/revert

ADDED

api/2/email-templates

Get email types



GET /rest/api/2/email-templates/types

ADDED

EXPERIMENTAL

api/2/nomenclature/entries

Get all nomenclature entries  

GET /rest/api/2/nomenclature/entries

ADDED

EXPERIMENTAL

api/2/nomenclature/entries

Set nomenclature entry 

POST /rest/api/2/nomenclature/entries

ADDED

EXPERIMENTAL

api/2/nomenclature/entries

Get nomenclature entry  

GET /rest/api/2/nomenclature/entries/{originalName}


8.15

ADDED

EXPERIMENTAL

api/2/terminology/entries

Get all terminology entries 


GET /rest/api/2/terminology/entries


ADDED

EXPERIMENTAL

api/2/terminology/entries

Set terminology entry

POST /rest/api/2/terminology/entries


ADDED

EXPERIMENTAL

api/2/terminology/entries

Get terminology entry  

GET /rest/api/2/terminology/entries/{originalName}


REMOVED

EXPERIMENTAL

api/2/nomenclature/entries

Get all nomenclature entries  

GET /rest/api/2/nomenclature/entries


REMOVED

EXPERIMENTAL

api/2/nomenclature/entries

Set nomenclature entry 

POST /rest/api/2/nomenclature/entries

REMOVED

EXPERIMENTAL

api/2/nomenclature/entries

Get nomenclature entry  

GET /rest/api/2/nomenclature/entries/{originalName}


8.16

ADDED


api/2/customFields

Bulk delete custom fields

DELETE /rest/api/2/customFields

ADDED

EXPERIMENTAL

api/2/terminology/entries

Set bulk terminology entries

POST /rest/api/2/terminology/entries/bulk


8.17

ADDED

EXPERIMENTAL

api/2/terminology/entries

Set terminology entries

POST /rest/api/2/terminology/entries

REMOVED

EXPERIMENTAL

api/2/terminology/entries

Set terminology entry

POST /rest/api/2/terminology/entries

REMOVED

EXPERIMENTAL

api/2/terminology/entries

Set bulk terminology entries

POST /rest/api/2/terminology/entries/bulk

8.18

No changes.

8.19

Jira Data Center and Server 8.19 platform REST API reference

ResourceMethodEndpointDescription
api/2/screensGET /rest/api/2/screensAdded the startAt, maxResults, expand, and search query parameters, as well as the 400 and 401 HTTP response codes.
api/2/statuscategoryGET /rest/api/2/statuscategory/{idOrKey}Added the X-Requested-With request header.
api/2/user

GET /rest/api/2/user/duplicated/count

Added a new method that returns the number of users whose accounts are duplicated.

GET /rest/api/2/user/duplicated/listAdded a new method that returns duplicated users mapped to their directories with an indication if their accounts are active or not. 

8.20

Jira Data Center and Server 8.20 platform REST API reference

ResourceMethodEndpointDescription
api/2/avatarGET /rest/api/2/avatar/{type}/system Added the 401 HTTP response code.
api/2/field

Get fields

UPDATED

GET /rest/api/2/field Added the 401 HTTP response code.
api/2/issueGET /rest/api/2/issue/createmeta/{projectIdOrKey}/issuetypes Added the 400 HTTP response code.
api/2/projectCategoryGET /rest/api/2/projectCategory/{id} Added the X-Requested-With request header.
api/2/resolutionGET /rest/api/2/resolution Added the X-Requested-With request header.
api/2/userGET /rest/api/2/user/assignable/multiProjectSearch Removed the startAt query parameter.
GET /rest/api/2/user/assignable/search Removed the startAt query parameter was removed.
GET /rest/api/2/user/permission/search This method has been deprecated and will be removed in a future release.
GET /rest/api/2/user/viewissue/search Removed the startAt query parameter.

8.21

Jira Data Center and Server 8.20 platform REST API reference

ResourceMethodEndpointDescription
Search for projectsGET /rest/api/2/projects/pickerA new resource with a method that returns a list of projects visible to the user.


GET /rest/api/2/user/assignable/multiProjectSearchThe startAt query parameter was added. 
GET /rest/api/2/user/assignable/searchThe startAt query parameter was added. 
GET /rest/api/2/user/viewissue/searchThe startAt query parameter was added. 

8.22

Jira Data Center and Server 8.22 platform REST API reference

ResourceMethodEndpointDescription
GET /rest/api/2/user/assignable/multiProjectSearchThe startAt query parameter was removed.
GET /rest/api/2/user/assignable/searchThe startAt  query parameter was removed.
GET /rest/api/2/user/viewissue/searchThe startAt query parameter was removed.

9.0

Jira Data Center and Server 9.0 platform REST API reference

ResourceMethodEndpointDescription
api/2/issue

Get create issue meta

DELETED

GET /rest/api/2/issue/createmetaMethod deleted.
api/2/issueLinkTypeGET /rest/api/2/issueLinkType/{issueLinkTypeId} The 401 HTTP response code was added.
GET /rest/api/2/issueLinkType The 401 HTTP response code was added.
api/2/priorityGET /rest/api/2/priority The 401 HTTP response code was added.
GET /rest/api/2/priority/{id} The 401 HTTP response code was added.
api/2/projects/pickerGET /rest/api/2/projects/pickerAdded maxResults query parameter.

9.1

Jira Data Center and Server 9.1 platform REST API reference

ResourceMethodEndpointDescription

Is app monitoring enabled

GET /rest/api/2/monitoring/app A new resource that allows the control of App monitoring.
Set app monitoring enabledPOST /rest/api/2/monitoring/app 
api/2/priorityGET /rest/api/2/priority/page 

The Get priorities method has a new endpoint URL and the following additional query parameters:

  • startAt
  • maxResults
  • query
api/2/status

Get paginated statuses

ADDED

EXPERIMENTAL

GET /rest/api/2/status/pageThe api/2/status resource gained a new method that returns a paginated list of filtered statuses.

9.2

Jira Data Center and Server 9.2 platform REST API reference

ResourceMethodEndpointDescription
api/2/component

Get paginated components

ADDED

EXPERIMENTAL

GET /rest/api/2/component/pageAdded a new method that returns a paginated list of filtered active components.
api/2/issuetype

Get paginated issue types

ADDED

EXPERIMENTAL

GET /rest/api/2/issuetype/pageAdded a new method that returns a paginated list of filtered issue types.
api/2/priorityGET /rest/api/2/priority/pageAdded the projectIds query parameter.
api/2/resolution

Get paginated resolutions

ADDED

EXPERIMENTAL

GET /rest/api/2/resolution/pageAdded a new method that returns a paginated list of filtered resolutions.
api/2/status

Get paginated statuses

UPDATED

EXPERIMENTAL

GET /rest/api/2/status/page Added the projectIds and issueTypeIds query parameters.
api/2/version

Get paginated versions

ADDED

EXPERIMENTAL

GET /rest/api/2/versionAdded anew method that returns a paginated collection of versions.

9.3

Jira Data Center and Server 9.3 platform REST API reference

ResourceMethodEndpointDescription
api/2/customFields

Get custom field options

ADDED

EXPERIMENTAL

GET /rest/api/2/customFields/{customFieldId}/optionsThe api/2/customFields resource gained a new method that returns the options for a custom field.

9.4

Jira Data Center and Server 9.4 platform REST API reference

No changes.

9.5

Jira Data Center and Server 9.5 REST API reference

No changes.

9.6

Jira Data Center and Server 9.6 REST API reference

No changes.

9.7

Jira Data Center and Server 9.7 REST API reference

ResourceMethodEndpoint
POST /rest/api/2/index-snapshot
List index snapshotGET /rest/api/2/index-snapshot
GET /rest/api/2/index-snapshot/isRunning
GET /rest/api/2/issue/{issueIdOrKey}/pinned-comments

PUT /rest/api/2/issue/{issueIdOrKey}/comment/{id}/pin

9.8

Jira Data Center and Server 9.8 REST API reference

ResourceMethodEndpoint
api/2/screens

Add field

DEPRECATED

POST /rest/api/2/screens/{screenId}/tabs/{tabId}/fields

Get all fields

DEPRECATED

GET /rest/api/2/screens/{screenId}/tabs/{tabId}/fields

9.9

Jira Data Center and Server 9.9 REST API references

ResourceMethodEndpoint
api/2/screensPUT /rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}

9.10

Jira Data Center and Server 9.10 REST API reference

ResourceMethodEndpoint
api2/projects/pickerGET /rest/api/2/projects/picker

9.11

Jira Data Center and Server 9.11 REST API reference

ResourceMethodEndpoint
api2/customFields

Get custom field options

ADDED

EXPERIMENTAL

GET /rest/api/2/customFields/{customFieldId}/options
DELETE /rest/api/2/user/session/{username}


9.12

Jira Data Center and Server 9.12 REST API reference

No changes.

Last modified on Nov 30, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.