Cloud

Jira Cloud platform / Reference / REST API v3

Project features

This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects.

Operations

GET/rest/api/3/project/{projectIdOrKey}/features PUT/rest/api/3/project/{projectIdOrKey}/features/{featureKey}

GET

Get project features

Returns the list of features for a project.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-work

Granular:read:project.feature:jira

Connect app scope required: READ

Request

Path parameters

projectIdOrKey

string

Required

Responses

Returned if the request is successful.

application/json

ContainerForProjectFeatures

The list of features on a project.

GET/rest/api/3/project/{projectIdOrKey}/features

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/features`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "features": [
    {
      "feature": "jsw.classic.roadmap",
      "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg",
      "localisedDescription": "Your roadmap is an optimized location to create and manage your epics.",
      "localisedName": "Roadmap",
      "prerequisites": [],
      "projectId": 10001,
      "state": "ENABLED",
      "toggleLocked": true
    },
    {
      "feature": "jsw.classic.backlog",
      "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg",
      "localisedDescription": "Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.",
      "localisedName": "Backlog",
      "prerequisites": [],
      "projectId": 10001,
      "state": "ENABLED",
      "toggleLocked": true
    }
  ]
}

PUT

Set project feature state

Sets the state of a project feature.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:manage:jira-project

Granular:write:project.feature:jira, read:project.feature:jira

Connect app scope required: PROJECT_ADMIN

Request

Path parameters

projectIdOrKey

string

Required

featureKey

string

Required

Request bodyapplication/json

Details of the feature state change.

state

string

Responses

Returned if the request is successful.

application/json

ContainerForProjectFeatures

The list of features on a project.

PUT/rest/api/3/project/{projectIdOrKey}/features/{featureKey}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "state": "ENABLED"
}`;

const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/features/{featureKey}`, {
  method: 'PUT',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "features": [
    {
      "feature": "jsw.classic.roadmap",
      "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg",
      "localisedDescription": "Your roadmap is an optimized location to create and manage your epics.",
      "localisedName": "Roadmap",
      "prerequisites": [],
      "projectId": 10001,
      "state": "ENABLED",
      "toggleLocked": true
    },
    {
      "feature": "jsw.classic.backlog",
      "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg",
      "localisedDescription": "Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.",
      "localisedName": "Backlog",
      "prerequisites": [],
      "projectId": 10001,
      "state": "ENABLED",
      "toggleLocked": true
    }
  ]
}