Upcoming Deprecation of Jira Cloud Search APIs

[glewandowski]

On October 31, 2024, Atlassian announced the deprecation of four Jira Cloud search APIs. These APIs will be replaced with new, more efficient alternatives through our enhanced JQL service, which are currently available for use. You can read more about these new APIs here. Effective May 1, 2025, Atlassian will remove the following Jira REST endpoints:

• GET /rest/api/3/search
• POST /rest/api/3/search
• POST /rest/api/3/search/id
• POST /rest/api/3/expression/eval We have identified that this library may be used to access the deprecated endpoints in Jira Cloud. Failing to migrate to the new APIs before May 1, 2025, could negatively impact any solutions that depend on this library. By evolving our JQL service, we aim to provide a more reliable, performant, and scalable Jira experience tailored to meet the needs of enterprise customers. If you have any questions or require further assistance, please do not hesitate to ask on our developer community forum

[zackiles]

Is there a plan from the maintainers of this package to update?

I've been considering starting a jira-client-v3 and making it cross compatible with node/deno/bun. From what I can find, there are no other client libraries out there for javascript that support v3.

[Konfuze]

As a workaround, you can use .genericGet to replace some deprecated Jira API calls.

For example, this code:

const issues = await jiraClient
  .searchJira(`summary ~ "someSummary" and project = "projectName"`);

return issues?.issues[0]?.key;

Can be replaced with:

const jql = `summary ~ "someSummary" and project = "projectName"`;

const issues = await jiraClient.genericGet(
  `search/jql?fields=key&jql=${encodeURIComponent(jql)}`
);

return issues?.issues[0]?.key;

Note: the deprecated endpoint and the replacement endpoint don’t have identical response shapes. Be sure to review the response contract when switching

[zystudios]

Is there a plan from the maintainers of this package to update?

I've been considering starting a jira-client-v3 and making it cross compatible with node/deno/bun. From what I can find, there are no other client libraries out there for javascript that support v3.

I don't think it will be updated anymore, after all, the last update was three years ago.

[joshcruz67]

Womp womp... The requested API has been removed. Please migrate to the /rest/api/3/search/jql API. A full migration guideline is available at https://developer.atlassian.com/changelog/#CHANGE-2046"