Get release plans

GET

https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans

GET

/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans

$ curl https://app.unleash-instance.example.com/api/admin/projects/project/features/featureName/environments/environment/release-plans \
>      -H "Authorization: <apiKey>"

1 [
2   {
3     "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
4     "discriminator": "plan",
5     "name": "My release plan",
6     "featureName": "my-feature",
7     "environment": "production",
8     "createdByUserId": 53,
9     "createdAt": "2022-01-01T00:00:00Z",
10     "milestones": [
11       {
12         "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
13         "name": "My milestone",
14         "sortOrder": 1,
15         "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
16         "startedAt": "2024-01-01T00:00:00.000Z",
17         "transitionCondition": {
18           "intervalMinutes": 30
19         },
20         "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
21         "pausedAt": "2024-01-01T00:00:00.000Z",
22         "strategies": [
23           {
24             "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
25             "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
26             "sortOrder": 9999,
27             "name": "flexibleRollout",
28             "strategyName": "flexibleRollout",
29             "title": "Gradual Rollout 25-Prod",
30             "parameters": {
31               "groupId": "some_new",
32               "rollout": "25",
33               "stickiness": "sessionId"
34             },
35             "constraints": [
36               {
37                 "contextName": "appName",
38                 "operator": "IN",
39                 "caseInsensitive": false,
40                 "inverted": false,
41                 "values": [
42                   "1",
43                   "2"
44                 ]
45               }
46             ],
47             "variants": [
48               {
49                 "name": "blue_group",
50                 "weight": 1,
51                 "weightType": "fix",
52                 "stickiness": "custom.context.field",
53                 "payload": {
54                   "type": "json",
55                   "value": "{\"color\": \"red\"}"
56                 }
57               }
58             ],
59             "segments": [
60               1,
61               2
62             ],
63             "disabled": false
64           }
65         ]
66       }
67     ],
68     "releasePlanTemplateId": "01JB9GGTGQYEQ9D40R17T3YVW2",
69     "description": "This is my release plan",
70     "activeMilestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
71     "safeguards": [
72       {
73         "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
74         "action": {
75           "type": "pauseReleasePlanProgressions",
76           "id": "01JB9GGTGQYEQ9D40R17T3YVW2"
77         },
78         "triggerCondition": {
79           "operator": ">",
80           "threshold": 100
81         },
82         "impactMetric": {
83           "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
84           "metricName": "unleash_counter_feature_toggle_usage_total",
85           "timeRange": "day",
86           "aggregationMode": "rps",
87           "labelSelectors": {
88             "environment": [
89               "development"
90             ],
91             "project": [
92               "default"
93             ]
94           },
95           "source": "internal"
96         }
97       }
98     ]
99   }
100 ]

Enterprise feature

Returns a list of all release plans for a specific feature flag and environment.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectstringRequired

featureNamestringRequired

environmentstringRequired

Response

#/components/schemas/releasePlansSchema

Errors

401

Unauthorized Error