The requested API has been removed. Please migrate to the /rest/api/3/search/jql when using get-jiraissue

[joshuameador]

Description

When using get-jiraissue I see Invoke-JiraMethod: 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
Invoke-JiraMethod:

Steps To Reproduce

When running get-jiraissue against our prod instance we see this error, is there going to be an update to jiraps that addresses this?

Steps to reproduce:

Command was $issues = get-jiraissue -query 'project = PROJECT and issuetype = ISSUETYPE and status = 'to do' (for example)'

Expected behavior

This should return a Jira issue like 'issue-1234' instead of the API error.

Screenshots

Your Environment

Not much here, I was writing a script to get some issues and act against them and saw this error.

PS C:\scripts> get-module jiraps -listavailable |select name, version

Name Version

---

JiraPS 2.14.7

Update module to update the API endpoints?

[auzgood]

Experiencing the same issue with Invoke-JiraMethod as of today. looks like it relates to issue #530

[JulianHenjes]

This workaround worked for me, hope it helps anyone stuck with the same issue

$USERNAME = ""
$JIRA_API_TOKEN = ""
$ORGANIZATION = ""
$JQL = ""

$encodedJql = [uri]::EscapeDataString($JQL)
$maxResults = 10
$headers = @{
    "Accept" = "application/json"
    "Authorization" = "Basic " + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("$($USERNAME):$($JIRA_API_TOKEN)")))
}

$response = Invoke-WebRequest -Method Get -Uri "https://$ORGANIZATION.atlassian.net/rest/api/3/search/jql?jql=$encodedJql&maxResults=$maxResults&fields=*all&expand=%3Cstring%3E" `
    -Headers $headers


$issues= ($response.Content | ConvertFrom-Json).issues

Write-Host $issues

[victormaso]

Thank you for the idea @JulianHenjes

For my use case the output of the V3 endpoint is not the same format as v2.
To maintain compatibility with other JiraPS commands I created this function which will use the v3 api for the search but then loop the results into a normal Get-JiraIssue -Key command which still works. This allows you to maintain the JiraPS.Issue object and format that can be piped into other JiraPS commands.
Note: since this loops through each result of your query to many another restapi call be mindful of your query result size.

Update: I included &maxResults=1000 to the url because the default max results was 25.
Please note it processes about 3 jira cases per second so if you plan on using this for a large count of results consider using -parallel (if using PS 7) in the foreach-object and include another "New-JiraSession" in the Foreach-object script block. I kept the below example without it to support 5.1 PowerShell.

function Get-JiraJQLSearch {
    param (
        [Parameter()]
        [String]
        $JQL
    )
    
    $JQLEncoded = [uri]::EscapeDataString($JQL)

    $response = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/3/search/jql?jql=$JQLEncoded&fields=key&maxResults=1000" -Method Get

    $LegacyFormatJira_All = $response.issues | ForEach-Object {
        $JiraResponse = $_
        Get-JiraIssue -Key $JiraResponse.Key
    }

    $LegacyFormatJira_All
}



Get-JiraJQLSearch -JQL $jql | Get-Member

   TypeName: JiraPS.Issue

[1ARdotNO]

Thank you for the idea @JulianHenjes

For my use case the output of the V3 endpoint is not the same format as v2. To maintain compatibility with other JiraPS commands I created this function which will use the v3 api for the search but then loop the results into a normal Get-JiraIssue -Key command which still works. This allows you to maintain the JiraPS.Issue object and format that can be piped into other JiraPS commands. Note: since this loops through each result of your query to many another restapi call be mindful of your query result size.

function Get-JiraJQLSearch {
    param (
        [Parameter()]
        [String]
        $JQL
    )
    
    $JQLEncoded = [uri]::EscapeDataString($JQL)

    $response = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/3/search/jql?jql=$JQLEncoded&fields=key" -Method Get

    $LegacyFormatJira_All = $response.issues | ForEach-Object {
        $JiraResponse = $_
        Get-JiraIssue -Key $JiraResponse.Key
    }

    $LegacyFormatJira_All
}



Get-JiraJQLSearch -JQL $jql | Get-Member

   TypeName: JiraPS.Issue

I was getting errors with this in ases where the search results where empty, so, added a quick check
for that in the foreach-object, like this

$LegacyFormatJira_All = $response.issues | where {$_ -ne $null} | ForEach-Object {

[MrMontesa]

same problem on my end. Implemented the workaround documented here. A permanent fix would be great though.

[msaravanaganesh]

function Get-JiraJQLSearch {
param (
[Parameter()]
[String]
$JQL
)

$JQLEncoded = [uri]::EscapeDataString($JQL)
$uri = '$(Get-JiraConfigServer)/rest/api/3/search/jql?expand=transitions&validateQuery=True&jql=Project+%3d+"Change+Management+Project"&maxResults=5000&fields=*all'
$response = Invoke-JiraMethod -URI $uri -Method Get
$LegacyFormatJira_All = $response.issues | ForEach-Object {
$JiraResponse = $_
Get-JiraIssue -Key $JiraResponse.Key
}
$LegacyFormatJira_All
}

This gives me just few records not the full list of issue under the project.

Is there a way to obtain the full list of issue.

[victormaso]

I updated my reply with the example that works for me to retrieve results up to 1000. Previously it was limited to the first 25 results.

Note: When I tried to use the -Paging with Invoke-JiraMethod did not give me accurate results. It may not be compatible with the output of the v3 api for this command.

@msaravanaganesh
Looking at your example It looks like using the "&fields=*all" limits your results to the first 100 even with the "&maxResults=5000" you included at least in my testing. You don't need anything other than the Key field since we are using the "Get-JiraIssue" legacy command to get the Transitions and all the other fields anyway by default.

[msaravanaganesh]

@victormaso

Thanks for your input, if we add "New-Jirasession' in the Foreach-object block will it not create multiple treads to the Jira server and create malicious activity?

Do we know when we can get a permanent fix for the Jira-issue -query command

[victormaso]

If you do something like the below you can reuse your existing session in the parallel sessions. Note the $using: variable.
I did a test in my environment and queried 500 Jira issues in one go without any trouble. Took 10 seconds to run.

$JiraHeaders = (Get-JiraSession).websession.headers

$jiraKeyArray = 100..600 | ForEach-Object { "VVV-$_" } 

$results = $jiraKeyArray | ForEach-Object -ThrottleLimit 25 -Parallel {
    $null = New-JiraSession -Headers $using:JiraHeaders
    Get-JiraIssue -Key $_
}

[darksidemilk]

Many thanks to those posting examples @victormaso @1ARdotNO @msaravanaganesh @JulianHenjes ! That was a huge help in getting to a workaround.
I kinda combined all of what's discussed here into one function. We threw this into our internal module that we use to extend JiraPS for internal needs and replaced everywhere we were calling Get-JiraIssue -Query "some jql" and we're back up and running again.

I made paging work, added thread options for when pwsh 7 is in use and maxresults options in params.

I added an arbitrary calculation for coming up with a thread value based on the result set. I honestly didn't find more than a few seconds difference between 25 threads and 1000 though on a result set of 1250. You should probably set the threads with caution especially if you might run this in more than one place as you can get hit with rate limit errors.

If you're using powershell 5.1 I added a progress bar.

Hopefully we'll get a full upgrade to JiraPS that includes this and other api v3 improvements, but can be patient.

function Get-JiraJQLSearch {
<#
    .SYNOPSIS
    Get jira issues from a jql search in the v3 api and then rerun them through get-jiraissue to get the full object via the issue key
    
    .DESCRIPTION
    Workaround function for deprecetated api until a full v3 version of JiraPS is available.
    Uses the v3 api to do a jql search and then reruns each issue key through get-jiraissue to get the full object

    .PARAMETER JQL
    The jql string to search for, was -query in Get-JiraIssue

    .PARAMETER threads
    The number of parallel threads to use when getting the full issue objects, defaults to half of the average results per page gotten from the jql search

    .PARAMETER MaxResults
    The max results to get per page, defaults to 1000, max allowed by jira is 1000

    .EXAMPLE
    $issues = Get-JiraJqlSearch -jql "Project='ABC' AND status = 'To Do' and Summary ~ 'easy as 123'";

    Will search jira project ABC for a to do work item that's as 'easy as 123'.

    .LINK
    https://github.com/AtlassianPS/JiraPS/issues/535
    
#>
    
    [CmdletBinding()]
    param (
        $JQL,
        $threads,
        $MaxResults = 1000
     )

    process {
        
        $JQLEncoded = [uri]::EscapeDataString($JQL)

        $response = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/3/search/jql?jql=$JQLEncoded&fields=key&maxResults=$MaxResults" -Method Get
        $i = 1; #page 1
        if ($response.isLast -eq $false) {
            Write-Verbose "More than $MaxResults results, getting next page"
            $issues = $response.issues;
            $nextPageToken = $response.nextPageToken;
            do {
                $i++;
                Write-Verbose "Getting page $i"
                $nextresponse = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/3/search/jql?jql=$JQLEncoded&fields=key&maxResults=$MaxResults&nextPageToken=$($nextPageToken)" -Method Get
                $issues += $nextresponse.issues;
                $nextPageToken = $nextresponse.nextPageToken;
            } while ($nextresponse.isLast -eq $false)
        } else {
            $issues = $response.issues;
        }
        Write-Verbose "Search for issue keys complete, found $($issues.count) issues in $i pages, getting full issue objects"
        
        
        if ($host.Version.major -ge 7) {
            Write-Verbose "pwsh core detected using ForEach-Object -Parallel to speed up getting full issue objects"
            if ($null -eq $threads) {
                if ($issues.count -lt 100) {
                    $threads = 10;
                    Write-Verbose "No thread count specified, less than 100 issues found, defaulting to - $threads threads"
                } else {
                    $threads = [math]::Ceiling(($($issues.count)/$i)/2);
                    Write-Verbose "No thread count specified, defaulting to half of the average results per page - $threads threads"
                }
                
            } else {
                Write-Verbose "using $threads threads specified"
            }
            $JiraHeaders = (Get-JiraSession).websession.headers
            $LegacyFormatJira_All = $issues | Where-Object {$_ -ne $null} | ForEach-Object -ThrottleLimit $threads -Parallel {
                $null = New-JiraSession -Headers $using:JiraHeaders
                Get-JiraIssue -Key $_.key
            }
        } else {
            Write-Verbose "Getting full issue objects sequentially, this may take a while with large result sets"
            $j = 1;
            $LegacyFormatJira_All = $issues | Where-Object {$_ -ne $null} | ForEach-Object {
                Write-Progress -Activity "Getting full issue objects" -Status "$($_.key) - $j of $($issues.count)" -Id 1 -PercentComplete (($j/$issues.count)*100); $j++;
                Get-JiraIssue -Key $_.Key
            }
        }
        
        return $LegacyFormatJira_All
    }
    
}

[msaravanaganesh]

Thanks @darksidemilk for the update and finding a solution.

But while I execute this getting error after 18th page like Nextpage token is expired, Also the issue count mentioned in the Verbose message 17001 is not correct becuase the current issue number is somewhere around tikcet-162478.

Get-JiraJQLSearch -JQL $jql -Verbose -Debug
VERBOSE: More than 1000 results, getting next page
VERBOSE: Getting page 2
VERBOSE: Getting page 3
VERBOSE: Getting page 4
VERBOSE: Getting page 5
VERBOSE: Getting page 6
VERBOSE: Getting page 7
VERBOSE: Getting page 8
VERBOSE: Getting page 9
VERBOSE: Getting page 10
VERBOSE: Getting page 11
VERBOSE: Getting page 12
VERBOSE: Getting page 13
VERBOSE: Getting page 14
VERBOSE: Getting page 15
VERBOSE: Getting page 16
VERBOSE: Getting page 17
VERBOSE: Getting page 18
Invoke-JiraMethod:
Line |
49 | … tresponse = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/ …
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| The provided next page token is invalid or expired.
Invoke-JiraMethod:
Line |
49 | … tresponse = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/ …
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
VERBOSE: Search for issue keys complete, found 17001 issues in 18 pages, getting full issue objects
VERBOSE: pwsh core detected using ForEach-Object -Parallel to speed up getting full issue objects
VERBOSE: No thread count specified, defaulting to half of the average results per page - 473 threads

Also, I am getting error I don't have permission

Invoke-JiraMethod: Issue does not exist, or you do not have permission to see it.
Invoke-JiraMethod:
Invoke-JiraMethod: Issue does not exist or you do not have permission to see it.
Invoke-JiraMethod: Issue does not exist or you do not have permission to see it.
Invoke-JiraMethod:
Invoke-JiraMethod: Issue does not exist, or you do not have permission to see it.

I was trying to fix this will keep you posted if I found anything and also, please let me know if you find something.

Thanks

[darksidemilk]

I would guess that you're getting rate limited by Atlassian with a query that big. Might have to do less threads to get through it or mess with the rate limit headers.

…

________________________________ JJ Fullmer Senior IT Systems Engineer [Arrowhead Dental Laboratory] Email ***@***.******@***.***> Phone (801) 572-7253<tel:+1(801)%20572-7253> Web arrowheaddental.com<https://www.arrowheaddental.com/>

________________________________ [Facebook] <https://www.facebook.com/ArrowheadDentalLab> [Instagram] <https://www.instagram.com/arrowheaddentallab/> [YouTube] CONFIDENTIALITY NOTICE: This e-mail, including any attachments, may contain confidential information which is intended only for the use of the individual(s) or entities named. If you receive this e-mail message in error, please immediately notify the sender by e-mail and delete it. Dissemination, forwarding, printing or copying of this e-mail without prior consent of the sender is strictly prohibited.

________________________________ From: Saravana Ganesh M ***@***.***> Sent: Wednesday, October 8, 2025 2:03:27 AM To: AtlassianPS/JiraPS ***@***.***> Cc: JJ Fullmer ***@***.***>; Mention ***@***.***> Subject: [External]Re: [AtlassianPS/JiraPS] The requested API has been removed. Please migrate to the /rest/api/3/search/jql when using get-jiraissue (Issue #535) [https://avatars.githubusercontent.com/u/97063332?s=20&v=4]msaravanaganesh left a comment (AtlassianPS/JiraPS#535)<#535 (comment)> Thanks @darksidemilk<https://github.com/darksidemilk> for the update and finding a solution. But while I execute this getting error after 18th page like Nextpage token is expired, Also the issue count mentioned in the Verbose message 17001 is not correct becuase the current issue number is somewhere around tikcet-162478. Get-JiraJQLSearch -JQL $jql -Verbose -Debug VERBOSE: More than 1000 results, getting next page VERBOSE: Getting page 2 VERBOSE: Getting page 3 VERBOSE: Getting page 4 VERBOSE: Getting page 5 VERBOSE: Getting page 6 VERBOSE: Getting page 7 VERBOSE: Getting page 8 VERBOSE: Getting page 9 VERBOSE: Getting page 10 VERBOSE: Getting page 11 VERBOSE: Getting page 12 VERBOSE: Getting page 13 VERBOSE: Getting page 14 VERBOSE: Getting page 15 VERBOSE: Getting page 16 VERBOSE: Getting page 17 VERBOSE: Getting page 18 Invoke-JiraMethod: Line | 49 | … tresponse = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/ … | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | The provided next page token is invalid or expired. Invoke-JiraMethod: Line | 49 | … tresponse = Invoke-JiraMethod -URI "$(Get-JiraConfigServer)/rest/api/ … | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | VERBOSE: Search for issue keys complete, found 17001 issues in 18 pages, getting full issue objects VERBOSE: pwsh core detected using ForEach-Object -Parallel to speed up getting full issue objects VERBOSE: No thread count specified, defaulting to half of the average results per page - 473 threads Also, I am getting error I don't have permission Invoke-JiraMethod: Issue does not exist, or you do not have permission to see it. Invoke-JiraMethod: Invoke-JiraMethod: Issue does not exist or you do not have permission to see it. Invoke-JiraMethod: Issue does not exist or you do not have permission to see it. Invoke-JiraMethod: Invoke-JiraMethod: Issue does not exist, or you do not have permission to see it. I was trying to fix this will keep you posted if I found anything and also, please let me know if you find something. Thanks — Reply to this email directly, view it on GitHub<#535 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AB3CO3CJRIJLBSTO5ZKOQDL3WTAM7AVCNFSM6AAAAACEZGYMB2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGOBQGIZDEMBSGY>. You are receiving this because you were mentioned.Message ID: ***@***.***>