Is /rest/agile/1.0/epic/search deprecated

Jira Development Jira Cloud
1

Hi,

We use GET /rest/agile/1.0/epic/search in our application to get the list of epics per company-managed Jira project, filtered by a free-text query and excluding Done epics:

GET /rest/agile/1.0/epic/search?projectKey={key}&query={text}&excludeDone=true&maxResults={n}

It is not documented in the Jira Software Cloud REST API reference (https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic/) but still responds in production. The Epic Link / Parent Link deprecation announcement ( Deprecation of the Epic Link, Parent Link and other related fields in REST APIs and webhooks ) doesn’t appear to cover the /rest/agile/* namespace.

Is this endpoint deprecated, and what is the recommended replacement?

2

Welcome to the Atlassian Developer Community, @DavidMoriconi!

I do not remember using this REST API and there’s a possibility that you have stumbled upon what seems to be an undocumented API.

I would recommend using a documented alternative to ensure that your app does not face any interruptions if the undocumented API stops working—undocumented ones aren’t supported and does not undergo a deprecation period when removed. Try this Search for issues using JQL enhanced search REST endpoint while checking issueType if it is an EPIC and filtering the project via projectKey={key} in the JQL if it addresses your use case.

Kindly let us know how it goes.

Cheers,
Ian