Rate this page:
Apis related to integrating Feature Flags with Jira Software. These apis are only available to Atlassian Connect apps. To use these apis you must have the Feature Flag module (see https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in your app's descriptor
Update / insert Feature Flag data.
Feature Flags are identified by their ID, and existing Feature Flag data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.
Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getFeatureFlagById operation can be used to confirm that data has been stored successfully (if needed).
In the case of multiple Feature Flags being submitted in one request, each is validated individually prior to submission. Details of which Feature Flags failed submission (if any) are available in the response object.
Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource.
This resource requires the 'WRITE' scope for Connect apps.
Connect app scope required: WRITE
string
RequiredFeature Flag data to submit.
Properties
array<FeatureFlagData>
RequiredProviderMetadata
Submission accepted. Each submitted Feature Flag that is of a valid format will be eventually available in Jira.
Details of which Feature Flags were submitted and which failed submission (due to data format problems etc.) are available in the response object.
The result of a successful submitFeatureFlags request.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
curl --request POST \
--url 'https://your-domain.atlassian.com/rest/featureflags/0.1/bulk' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"properties": {
"accountId": "account-234",
"projectId": "project-123"
},
"flags": [
{
"schemaVersion": "1.0",
"id": "111-222-333",
"key": "my-awesome-feature",
"updateSequenceId": 1523494301448,
"displayName": "Enable awesome feature",
"issueKeys": [
"ISSUE-123"
],
"summary": {
"url": "https://example.com/project/feature-123/summary",
"status": {
"enabled": true,
"defaultValue": "Disabled",
"rollout": {
"percentage": 80
}
},
"lastUpdated": "2018-01-20T23:27:25.000Z"
},
"details": [
{
"url": "https://example.com/project/feature-123/production",
"lastUpdated": "2018-01-20T23:27:25.000Z",
"environment": {
"name": "prod-us-west",
"type": "production"
},
"status": {
"enabled": true,
"defaultValue": "Disabled",
"rollout": {
"percentage": 80
}
}
}
]
}
],
"providerMetadata": {
"product": "Atlassian Release Platform 2.1.0"
}
}'1
2
3
4
5
6
7
8
9
10
{
"acceptedFeatureFlags": [
"111-222-333",
"444-555-666"
],
"failedFeatureFlags": {},
"unknownIssueKeys": [
"ISSUE-123"
]
}Bulk delete all Feature Flags that match the given request.
One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceId is no longer supported.
If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
See the documentation for the submitFeatureFlags operation for more details.
e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource.
This resource requires the 'DELETE' scope for Connect apps.
Connect app scope required: DELETE
integer
string
RequiredDelete accepted. Data will eventually be removed from Jira.
1
2
curl --request DELETE \
--url 'https://your-domain.atlassian.com/rest/featureflags/0.1/bulkByProperties'Retrieve the currently stored Feature Flag data for the given ID.
The result will be what is currently stored, ignoring any pending updates or deletes.
Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource.
This resource requires the 'READ' scope for Connect apps.
Connect app scope required: READ
string
Requiredstring
RequiredThe Feature Flag data currently stored for the given ID.
Data related to a single Feature Flag, across any Environment that the flag is present in.
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.com/rest/featureflags/0.1/flag/{featureFlagId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
"schemaVersion": "1.0",
"id": "111-222-333",
"key": "my-awesome-feature",
"updateSequenceId": 1523494301448,
"displayName": "Enable awesome feature",
"issueKeys": [
"ISSUE-123"
],
"summary": {
"url": "https://example.com/project/feature-123/summary",
"status": {
"enabled": true,
"defaultValue": "Disabled",
"rollout": {
"percentage": 80
}
},
"lastUpdated": "2018-01-20T23:27:25.000Z"
},
"details": [
{
"url": "https://example.com/project/feature-123/production",
"lastUpdated": "2018-01-20T23:27:25.000Z",
"environment": {
"name": "prod-us-west",
"type": "production"
},
"status": {
"enabled": true,
"defaultValue": "Disabled",
"rollout": {
"percentage": 80
}
}
}
]
}Delete the Feature Flag data currently stored for the given ID.
Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
Only Connect apps that define the jiraFeatureFlagInfoProvider module can access this resource.
This resource requires the 'DELETE' scope for Connect apps.
Connect app scope required: DELETE
string
Requiredinteger
string
RequiredDelete has been accepted. Data will eventually be removed from Jira if it exists.
1
2
curl --request DELETE \
--url 'https://your-domain.atlassian.com/rest/featureflags/0.1/flag/{featureFlagId}'