Enable a feature flag

POST

https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/on

POST

/api/admin/projects/:projectId/features/:featureName/environments/:environment/on

1 curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/features/featureName/environments/environment/on \
2      -H "Authorization: <apiKey>"

Try it

1 {
2   "name": "disable-comments",
3   "type": "kill-switch",
4   "description": "Controls disabling of the comments section in case of an incident",
5   "archived": true,
6   "project": "dx-squad",
7   "enabled": true,
8   "stale": false,
9   "favorite": true,
10   "impressionData": false,
11   "createdAt": "2023-01-28T15:21:39.975Z",
12   "createdBy": {
13     "id": 123,
14     "name": "User",
15     "imageUrl": "https://example.com/242x200.png"
16   },
17   "archivedAt": "2023-01-29T15:21:39.975Z",
18   "environments": [
19     {
20       "name": "my-dev-env",
21       "enabled": true,
22       "featureName": "disable-comments",
23       "environment": "development",
24       "type": "development",
25       "sortOrder": 3,
26       "variantCount": 1.1,
27       "strategies": [
28         {
29           "name": "flexibleRollout",
30           "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
31           "title": "Gradual Rollout 25-Prod",
32           "disabled": false,
33           "featureName": "myAwesomeFeature",
34           "sortOrder": 9999,
35           "segments": [
36             1,
37             2
38           ],
39           "constraints": [
40             {
41               "contextName": "appName",
42               "operator": "IN",
43               "caseInsensitive": false,
44               "inverted": false,
45               "values": [
46                 "my-app",
47                 "my-other-app"
48               ],
49               "value": "my-app"
50             }
51           ],
52           "variants": [
53             {
54               "name": "blue_group",
55               "weight": 1,
56               "weightType": "fix",
57               "stickiness": "custom.context.field",
58               "payload": {
59                 "type": "json",
60                 "value": "{\"color\": \"red\"}"
61               }
62             }
63           ],
64           "parameters": {}
65         }
66       ],
67       "variants": [
68         {
69           "name": "blue_group",
70           "weight": 1.1,
71           "weightType": "variable",
72           "stickiness": "custom.context.field",
73           "payload": {
74             "type": "json",
75             "value": "{\"color\": \"red\"}"
76           },
77           "overrides": [
78             {
79               "contextName": "userId",
80               "values": [
81                 "red",
82                 "blue"
83               ]
84             }
85           ]
86         }
87       ],
88       "changeRequestIds": [
89         1.1
90       ],
91       "milestoneName": "Phase One",
92       "milestoneOrder": 0,
93       "totalMilestones": 0,
94       "lastSeenAt": "2023-01-28T16:21:39.975Z",
95       "hasStrategies": true,
96       "hasEnabledStrategies": true,
97       "releasePlans": [
98         {
99           "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
100           "discriminator": "plan",
101           "name": "My release plan",
102           "featureName": "my-feature",
103           "environment": "production",
104           "createdByUserId": 53,
105           "createdAt": "2022-01-01T00:00:00Z",
106           "milestones": [
107             {
108               "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
109               "name": "My milestone",
110               "sortOrder": 1,
111               "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
112               "startedAt": "2024-01-01T00:00:00.000Z",
113               "transitionCondition": {
114                 "intervalMinutes": 30
115               },
116               "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
117               "pausedAt": "2024-01-01T00:00:00.000Z",
118               "strategies": [
119                 {
120                   "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
121                   "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
122                   "sortOrder": 9999,
123                   "strategyName": "flexibleRollout",
124                   "title": "Gradual Rollout 25-Prod",
125                   "parameters": {
126                     "groupId": "some_new",
127                     "rollout": "25",
128                     "stickiness": "sessionId"
129                   },
130                   "constraints": [
131                     {
132                       "contextName": "appName",
133                       "operator": "IN",
134                       "caseInsensitive": false,
135                       "inverted": false,
136                       "values": [
137                         "1",
138                         "2"
139                       ]
140                     }
141                   ],
142                   "variants": [
143                     {
144                       "name": "blue_group",
145                       "weight": 1,
146                       "weightType": "fix",
147                       "stickiness": "custom.context.field",
148                       "payload": {
149                         "type": "json",
150                         "value": "{\"color\": \"red\"}"
151                       }
152                     }
153                   ],
154                   "segments": [
155                     1,
156                     2
157                   ]
158                 }
159               ]
160             }
161           ],
162           "releasePlanTemplateId": "01JB9GGTGQYEQ9D40R17T3YVW2",
163           "description": "This is my release plan",
164           "activeMilestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
165           "safeguards": [
166             {
167               "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
168               "action": {
169                 "type": "pauseReleasePlanProgressions",
170                 "id": "01JB9GGTGQYEQ9D40R17T3YVW2"
171               },
172               "triggerCondition": {
173                 "operator": ">",
174                 "threshold": 100
175               },
176               "impactMetric": {
177                 "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
178                 "metricName": "unleash_counter_feature_toggle_usage_total",
179                 "timeRange": "day",
180                 "aggregationMode": "rps",
181                 "labelSelectors": {
182                   "environment": [
183                     "development"
184                   ],
185                   "project": [
186                     "default"
187                   ]
188                 }
189               }
190             }
191           ]
192         }
193       ],
194       "yes": 974,
195       "no": 50
196     }
197   ],
198   "tags": [
199     {
200       "value": "a-tag-value",
201       "type": "simple",
202       "color": "#FFFFFF"
203     }
204   ],
205   "children": [
206     "some-feature"
207   ],
208   "lifecycle": {
209     "stage": "initial",
210     "enteredStageAt": "2023-01-28T15:21:39.975Z",
211     "status": "kept"
212   },
213   "dependencies": [
214     {
215       "feature": "some-feature",
216       "enabled": true,
217       "variants": [
218         "some-feature-blue-variant"
219       ]
220     }
221   ],
222   "collaborators": {
223     "users": [
224       {
225         "id": 123,
226         "name": "User",
227         "imageUrl": "https://example.com/242x200.png"
228       }
229     ]
230   },
231   "links": [
232     {
233       "id": "01JTJNCJ5XVP2KPJFA03YRBZCA",
234       "url": "https://github.com/search?q=cleanupReminder&type=code",
235       "title": "Github cleanup",
236       "feature": "disable-comments"
237     }
238   ],
239   "lastSeenAt": "2023-01-28T16:21:39.975Z",
240   "variants": [
241     {
242       "name": "blue_group",
243       "weight": 1.1,
244       "weightType": "variable",
245       "stickiness": "custom.context.field",
246       "payload": {
247         "type": "json",
248         "value": "{\"color\": \"red\"}"
249       },
250       "overrides": [
251         {
252           "contextName": "userId",
253           "values": [
254             "red",
255             "blue"
256           ]
257         }
258       ]
259     }
260   ],
261   "strategies": [
262     {}
263   ]
264 }

Enable a feature flag in the specified environment.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

featureNamestringRequired

environmentstringRequired

Response

featureSchema

namestring

Unique feature name

typestring or null

Type of the flag e.g. experiment, kill-switch, release, operational, permission

descriptionstring or null

Detailed description of the feature

archivedboolean or null

true if the feature is archived

projectstring or null

Name of the project the feature belongs to

enabledboolean or null

true if the feature is enabled, otherwise false.

staleboolean or null

true if the feature is stale based on the age and feature type, otherwise false.

favoriteboolean or null

true if the feature was favorited, otherwise false.

impressionDataboolean or null

true if the impression data collection is enabled for the feature, otherwise false.

createdAtstring or nullformat: "date-time"

The date the feature was created

createdByobject or null

User who created the feature flag

archivedAtstring or nullformat: "date-time"

The date the feature was archived

environmentslist of objects or null

The list of environments where the feature can be used

tagslist of objects or null

The list of feature tags

childrenlist of strings or null

The list of child feature names. This is an experimental field and may change.

lifecycleobject or null

Current lifecycle stage of the feature

dependencieslist of objects or null

The list of parent dependencies. This is an experimental field and may change.

collaboratorsobject or null

Information related to users who have made changes to this feature flage.

linkslist of objects or null

The list of links. This is an experimental field and may change.

lastSeenAtstring or nullformat: "date-time"Deprecated

The date when metrics where last collected for the feature. This field was deprecated in v5, use the one in featureEnvironmentSchema

variantslist of objects or nullDeprecated

The list of feature variants

strategieslist of objects or nullDeprecated

This was deprecated in v5 and will be removed in a future major version

Authentication

Path parameters

Response

Errors