Copy feature flag

POST

/api/v2/flags/:projectKey/:featureFlagKey/copy

POST

/api/v2/flags/:projectKey/:featureFlagKey/copy

$ curl -X POST https://app.launchdarkly.com/api/v2/flags/projectKey/featureFlagKey/copy \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "source": {
>     "key": "source-env-key-123abc",
>     "currentVersion": 1
>   },
>   "target": {
>     "key": "target-env-key-123abc",
>     "currentVersion": 1
>   },
>   "comment": "optional comment"
> }'

1 {
2   "name": "My Flag",
3   "kind": "boolean",
4   "key": "flag-key-123abc",
5   "_version": 1,
6   "creationDate": 1494437420312,
7   "variations": [
8     {
9       "value": null,
10       "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
11     },
12     {
13       "value": null,
14       "_id": "a00bf58d-d252-476c-b915-15a74becacb4"
15     }
16   ],
17   "temporary": true,
18   "tags": [
19     "example-tag"
20   ],
21   "_links": {
22     "parent": {
23       "href": "/api/v2/flags/my-project",
24       "type": "application/json"
25     },
26     "self": {
27       "href": "/api/v2/flags/my-project/my-flag",
28       "type": "application/json"
29     }
30   },
31   "experiments": {
32     "baselineIdx": 1,
33     "items": [
34       {
35         "metricKey": "my-metric",
36         "_metric": {
37           "_id": "5902deadbeef667524a01290",
38           "_versionId": "version-id-123abc",
39           "key": "metric-key-123abc",
40           "name": "My metric",
41           "kind": "custom",
42           "_links": {
43             "parent": {
44               "href": "/api/v2/metrics/my-project",
45               "type": "application/json"
46             },
47             "self": {
48               "href": "/api/v2/metrics/my-project/my-metric",
49               "type": "application/json"
50             }
51           },
52           "tags": [],
53           "_creationDate": 1628192791148,
54           "dataSource": {
55             "key": "string",
56             "environmentKey": "string",
57             "_name": "string",
58             "_integrationKey": "string"
59           },
60           "experimentCount": 0,
61           "metricGroupCount": 0,
62           "activeExperimentCount": 2,
63           "activeGuardedRolloutCount": 1,
64           "_version": 1,
65           "_attachedFlagCount": 0,
66           "_site": {},
67           "_access": {
68             "denied": [
69               {
70                 "action": "string",
71                 "reason": {
72                   "effect": "allow",
73                   "resources": [
74                     "proj/*:env/*;qa_*:/flag/*"
75                   ],
76                   "notResources": [
77                     "string"
78                   ],
79                   "actions": [
80                     "*"
81                   ],
82                   "notActions": [
83                     "string"
84                   ],
85                   "role_name": "string"
86                 }
87               }
88             ],
89             "allowed": [
90               {
91                 "action": "string",
92                 "reason": {
93                   "effect": "allow",
94                   "resources": [
95                     "proj/*:env/*;qa_*:/flag/*"
96                   ],
97                   "notResources": [
98                     "string"
99                   ],
100                   "actions": [
101                     "*"
102                   ],
103                   "notActions": [
104                     "string"
105                   ],
106                   "role_name": "string"
107                 }
108               }
109             ]
110           },
111           "lastModified": {
112             "date": "2021-08-05T19:46:31.148082Z"
113           },
114           "maintainerId": "569fdeadbeef1644facecafe",
115           "_maintainer": {
116             "_links": {
117               "self": {
118                 "href": "/api/v2/members/569f183514f4432160000007",
119                 "type": "application/json"
120               }
121             },
122             "_id": "569f183514f4432160000007",
123             "role": "admin",
124             "email": "ariel@acme.com"
125           },
126           "description": "string",
127           "category": "Error monitoring",
128           "isNumeric": true,
129           "successCriteria": "HigherThanBaseline",
130           "unit": "string",
131           "eventKey": "Order placed",
132           "analysisUnits": [
133             "user"
134           ],
135           "filters": {
136             "type": "contextAttribute",
137             "op": "in",
138             "values": [
139               "JP"
140             ],
141             "negate": false
142           },
143           "unitAggregationType": "average",
144           "analysisType": "mean",
145           "percentileValue": 95,
146           "eventDefault": {
147             "disabled": true,
148             "value": 0
149           },
150           "lastSeen": 1,
151           "archived": true,
152           "archivedAt": 1609459200000,
153           "selector": "string",
154           "urls": [
155             "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]"
156           ],
157           "windowStartOffset": 1,
158           "windowEndOffset": 1,
159           "winsorLowerPercentile": 1,
160           "winsorUpperPercentile": 99.5,
161           "winsorExcludeImputed": false,
162           "traceQuery": "service.name = \"checkout\"",
163           "traceValueLocation": "duration",
164           "denominator": {
165             "eventName": "string",
166             "isNumeric": true,
167             "unitAggregationType": "string",
168             "unitAggregationField": "string",
169             "dataSource": {
170               "key": "string",
171               "environmentKey": "string",
172               "_name": "string",
173               "_integrationKey": "string"
174             },
175             "filters": {
176               "type": "contextAttribute",
177               "op": "in",
178               "values": [
179                 "JP"
180               ],
181               "negate": false,
182               "attribute": "country",
183               "contextKind": "user"
184             },
185             "windowStartOffset": 1,
186             "windowEndOffset": 1,
187             "winsorLowerPercentile": 1.1,
188             "winsorUpperPercentile": 1.1,
189             "winsorExcludeImputed": true
190           },
191           "randomizationUnits": [
192             "user"
193           ]
194         },
195         "environments": [
196           "production",
197           "test",
198           "my-environment"
199         ],
200         "_environmentSettings": {}
201       }
202     ]
203   },
204   "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
205   "archived": false,
206   "description": "This flag controls the example widgets",
207   "clientSideAvailability": {},
208   "maintainerId": "569f183514f4432160000007",
209   "_maintainer": {
210     "_links": {
211       "self": {
212         "href": "/api/v2/members/569f183514f4432160000007",
213         "type": "application/json"
214       }
215     },
216     "_id": "569f183514f4432160000007",
217     "role": "admin",
218     "email": "ariel@acme.com",
219     "firstName": "Ariel",
220     "lastName": "Flores"
221   },
222   "maintainerTeamKey": "team-1",
223   "_maintainerTeam": {
224     "key": "team-key-123abc",
225     "name": "Example team",
226     "_links": {
227       "parent": {
228         "href": "/api/v2/teams",
229         "type": "application/json"
230       },
231       "roles": {
232         "href": "/api/v2/teams/example-team/roles",
233         "type": "application/json"
234       },
235       "self": {
236         "href": "/api/v2/teams/example-team",
237         "type": "application/json"
238       }
239     }
240   },
241   "archivedDate": 1494437420312,
242   "deprecated": false,
243   "deprecatedDate": 1494437420312,
244   "defaults": {
245     "onVariation": 0,
246     "offVariation": 1
247   },
248   "_purpose": "string",
249   "migrationSettings": {
250     "contextKind": "device",
251     "stageCount": 6
252   },
253   "environments": {
254     "my-environment": {
255       "on": false,
256       "archived": false,
257       "salt": "61eddeadbeef4da1facecafe3a60a397",
258       "sel": "810edeadbeef4844facecafe438f2999492",
259       "lastModified": 1627071171347,
260       "version": 1,
261       "_site": {
262         "href": "/default/my-environment/features/client-side-flag",
263         "type": "text/html"
264       },
265       "_environmentName": "My Environment",
266       "trackEvents": false,
267       "trackEventsFallthrough": false,
268       "targets": [
269         {
270           "values": [
271             "user-key-123abc"
272           ],
273           "variation": 0,
274           "contextKind": "user"
275         }
276       ],
277       "contextTargets": [
278         {
279           "values": [
280             "device-key-123abc"
281           ],
282           "variation": 0,
283           "contextKind": "device"
284         }
285       ],
286       "rules": [],
287       "fallthrough": {
288         "variation": 0
289       },
290       "offVariation": 1,
291       "prerequisites": [],
292       "_summary": {
293         "variations": {
294           "0": {
295             "rules": 0,
296             "nullRules": 0,
297             "targets": 1,
298             "contextTargets": 1,
299             "isFallthrough": true
300           },
301           "1": {
302             "rules": 0,
303             "nullRules": 0,
304             "targets": 0,
305             "isOff": true
306           }
307         },
308         "prerequisites": 0
309       }
310     }
311   },
312   "includeInSnippet": true,
313   "goalIds": []
314 }

Copying flag settings is an Enterprise feature

Copying flag settings is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Copy flag settings from a source environment to a target environment.

By default, this operation copies the entire flag configuration. You can use the includedActions or excludedActions to specify that only part of the flag configuration is copied.

If you provide the optional currentVersion of a flag, this operation tests to ensure that the current flag version in the environment matches the version you’ve specified. The operation rejects attempts to copy flag settings if the environment’s current version of the flag does not match the version you’ve specified. You can use this to enforce optimistic locking on copy attempts.

> ### Copying flag settings is an Enterprise feature > > Copying flag settings is available to customers on an Enterprise plan. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). Copy flag settings from a source environment to a target environment. By default, this operation copies the entire flag configuration. You can use the `includedActions` or `excludedActions` to specify that only part of the flag configuration is copied. If you provide the optional `currentVersion` of a flag, this operation tests to ensure that the current flag version in the environment matches the version you've specified. The operation rejects attempts to copy flag settings if the environment's current version of the flag does not match the version you've specified. You can use this to enforce optimistic locking on copy attempts.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

featureFlagKeystringRequiredformat: "string"

The feature flag key. The key identifies the flag in your code.

Request

This endpoint expects an object.

sourceobjectRequired

The source environment

targetobjectRequired

The target environment

commentstringOptional

Optional comment

includedActionslist of enumsOptional

Optional list of the flag changes to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

excludedActionslist of enumsOptional

Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

Response

Global flag response

namestring

A human-friendly name for the feature flag

kindenum

Kind of feature flag

Allowed values:

keystring

A unique key used to reference the flag in your code

_versioninteger

Version of the feature flag

creationDatelong

Timestamp of flag creation date

variationslist of objects

An array of possible variations for the flag

temporaryboolean

Whether the flag is a temporary flag

tagslist of strings

Tags for the feature flag

_linksmap from strings to objects

The location and content type of related resources

experimentsobject

Experimentation data for the feature flag

customPropertiesmap from strings to objects

Metadata attached to the feature flag, in the form of the property key associated with a name and array of values for the metadata to associate with this flag. Typically used to store data related to an integration.

archivedboolean

Boolean indicating if the feature flag is archived

descriptionstring

Description of the feature flag

clientSideAvailabilityobject

Which type of client-side SDKs the feature flag is available to

maintainerIdstring

Associated maintainerId for the feature flag

_maintainerobject

Associated maintainer member info for the feature flag

maintainerTeamKeystring

The key of the associated team that maintains this feature flag

_maintainerTeamobject

Associated maintainer team info for the feature flag

archivedDatelong

If archived is true, date of archive

deprecatedboolean

Boolean indicating if the feature flag is deprecated

deprecatedDatelong

If deprecated is true, date of deprecation

defaultsobject

The indices, from the array of variations, for the variations to serve by default when targeting is on and when targeting is off. These variations will be used for this flag in new environments. If omitted, the first and last variation will be used.

_purposestring

migrationSettingsobject

Migration-related settings for the flag

environmentsmap from strings to objects

Details on the environments for this flag. Only returned if the request is filtered by environment, using the filterEnv query parameter.

includeInSnippetbooleanDeprecated

Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK

goalIdslist of stringsDeprecated

Deprecated, use experiments instead

Errors

400

Bad Request Error

401

Unauthorized Error

405

Method Not Allowed Error

409

Conflict Error

429

Too Many Requests Error

Copying flag settings is an Enterprise feature

Copying flag settings is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Copy flag settings from a source environment to a target environment.

By default, this operation copies the entire flag configuration. You can use the includedActions or excludedActions to specify that only part of the flag configuration is copied.