Getting the message "This API is experimental" when using the Jira Service Management Rest API

Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.

Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Problem

While performing the REST API using the new Jira Service Management API, the following is thrown:

1 This API is experimental. Experimental APIs are not guaranteed to be stable within the preview period. You must set the header 'X-ExperimentalApi: opt-in' to opt into using this API.

Cause

  1. The user you used for authentication does not have the necessary permission to view the ticket OR

  2. The request type for the issue that is being retrieved is not set accordingly

Resolution

Set the value above accordingly

Updated on April 11, 2025
Platform
Data Center only
Product
Jira Service Management Data Center
On this pageProblemCauseResolution

Still need help?

The Atlassian Community is here for you.
Ask the Community