Get feature flag

GET

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

GET

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

1 curl https://app.launchdarkly.com/api/v2/flags/projectKey/featureFlagKey \
2      -H "Authorization: <apiKey>"

Try it

1 {
2   "name": "My Flag",
3   "kind": "boolean",
4   "key": "flag-key-123abc",
5   "_version": 1,
6   "creationDate": 1000000,
7   "variations": [
8     {
9       "value": true,
10       "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
11       "description": "description",
12       "name": "name"
13     },
14     {
15       "value": false,
16       "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
17       "description": "description",
18       "name": "name"
19     }
20   ],
21   "temporary": true,
22   "tags": [
23     "example-tag"
24   ],
25   "_links": {
26     "parent": {
27       "href": "/api/v2/flags/my-project",
28       "type": "application/json"
29     },
30     "self": {
31       "href": "/api/v2/flags/my-project/my-flag",
32       "type": "application/json"
33     }
34   },
35   "experiments": {
36     "baselineIdx": 1,
37     "items": [
38       {
39         "metricKey": "my-metric",
40         "_metric": {
41           "_id": "5902deadbeef667524a01290",
42           "_versionId": "version-id-123abc",
43           "key": "metric-key-123abc",
44           "name": "My metric",
45           "kind": "pageview",
46           "_links": {
47             "parent": {
48               "href": "/api/v2/metrics/my-project",
49               "type": "application/json"
50             },
51             "self": {
52               "href": "/api/v2/metrics/my-project/my-metric",
53               "type": "application/json"
54             }
55           },
56           "tags": [
57             "tags"
58           ],
59           "_creationDate": 1000000,
60           "experimentCount": 0,
61           "metricGroupCount": 0,
62           "activeExperimentCount": 2,
63           "activeGuardedRolloutCount": 1,
64           "_version": 1,
65           "_attachedFlagCount": 0,
66           "maintainerId": "569fdeadbeef1644facecafe",
67           "_maintainer": {
68             "_links": {
69               "self": {
70                 "href": "/api/v2/members/569f183514f4432160000007",
71                 "type": "application/json"
72               }
73             },
74             "_id": "569f183514f4432160000007",
75             "role": "admin",
76             "email": "ariel@acme.com",
77             "firstName": "Ariel",
78             "lastName": "Flores"
79           },
80           "category": "Error monitoring",
81           "isNumeric": true,
82           "eventKey": "Order placed",
83           "filters": {
84             "type": "group",
85             "op": "op",
86             "values": [
87               "JP"
88             ],
89             "negate": false,
90             "attribute": "country",
91             "contextKind": "user"
92           },
93           "percentileValue": 95
94         }
95       }
96     ]
97   },
98   "customProperties": {
99     "key": {
100       "name": "Jira issues",
101       "value": [
102         "is-123",
103         "is-456"
104       ]
105     }
106   },
107   "archived": false,
108   "description": "This flag controls the example widgets",
109   "clientSideAvailability": {
110     "usingMobileKey": true,
111     "usingEnvironmentId": true
112   },
113   "maintainerId": "569f183514f4432160000007",
114   "_maintainer": {
115     "_links": {
116       "self": {
117         "href": "/api/v2/members/569f183514f4432160000007",
118         "type": "application/json"
119       }
120     },
121     "_id": "569f183514f4432160000007",
122     "role": "admin",
123     "email": "ariel@acme.com",
124     "firstName": "Ariel",
125     "lastName": "Flores"
126   },
127   "maintainerTeamKey": "team-1",
128   "_maintainerTeam": {
129     "key": "team-key-123abc",
130     "name": "Example team",
131     "_links": {
132       "parent": {
133         "href": "/api/v2/teams",
134         "type": "application/json"
135       },
136       "roles": {
137         "href": "/api/v2/teams/example-team/roles",
138         "type": "application/json"
139       },
140       "self": {
141         "href": "/api/v2/teams/example-team",
142         "type": "application/json"
143       }
144     }
145   },
146   "archivedDate": 1000000,
147   "deprecated": false,
148   "deprecatedDate": 1000000,
149   "defaults": {
150     "onVariation": 0,
151     "offVariation": 1
152   },
153   "_purpose": "_purpose",
154   "migrationSettings": {
155     "contextKind": "device",
156     "stageCount": 6
157   },
158   "environments": {
159     "my-environment": {
160       "on": false,
161       "archived": false,
162       "salt": "61eddeadbeef4da1facecafe3a60a397",
163       "sel": "810edeadbeef4844facecafe438f2999492",
164       "lastModified": 1627071171347,
165       "version": 1,
166       "_site": {
167         "href": "/default/my-environment/features/client-side-flag",
168         "type": "text/html"
169       },
170       "_environmentName": "My Environment",
171       "trackEvents": false,
172       "trackEventsFallthrough": false,
173       "targets": [
174         {
175           "values": [
176             "user-key-123abc"
177           ],
178           "variation": 0,
179           "contextKind": "user"
180         }
181       ],
182       "contextTargets": [
183         {
184           "values": [
185             "device-key-123abc"
186           ],
187           "variation": 0,
188           "contextKind": "device"
189         }
190       ],
191       "rules": [
192         {
193           "clauses": [
194             {
195               "attribute": "attribute",
196               "op": "op",
197               "values": [],
198               "negate": true
199             }
200           ],
201           "trackEvents": true
202         }
203       ],
204       "fallthrough": {
205         "variation": 0
206       },
207       "offVariation": 1,
208       "prerequisites": [
209         {
210           "key": "key",
211           "variation": 1
212         }
213       ],
214       "_access": {
215         "denied": [
216           {
217             "action": "action",
218             "reason": {
219               "effect": "allow"
220             }
221           }
222         ],
223         "allowed": [
224           {
225             "action": "action",
226             "reason": {
227               "effect": "allow"
228             }
229           }
230         ]
231       },
232       "_debugEventsUntilDate": 1000000,
233       "_summary": {
234         "variations": {
235           "0": {
236             "rules": 0,
237             "nullRules": 0,
238             "targets": 1,
239             "contextTargets": 1,
240             "isFallthrough": true
241           },
242           "1": {
243             "rules": 0,
244             "nullRules": 0,
245             "targets": 0,
246             "contextTargets": 1,
247             "isOff": true
248           }
249         },
250         "prerequisites": 0
251       }
252     }
253   },
254   "includeInSnippet": true,
255   "goalIds": [
256     "goalIds"
257   ]
258 }

Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the env query parameter. For example, setting env=production restricts the returned configurations to just the production environment.

Recommended use

This endpoint can return a large amount of information. Specifying one or multiple environments with the env parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query.

Expanding response

LaunchDarkly supports the expand query param to include additional fields in the response, with the following fields:

evaluation includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days
migrationSettings includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where purpose is migration.

For example, expand=evaluation includes the evaluation field in the response.

Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment. > #### Recommended use > > This endpoint can return a large amount of information. Specifying one or multiple environments with the `env` parameter can decrease response time and overall payload size. We recommend using this parameter to return only the environments relevant to your query. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

featureFlagKeystringRequired

The feature flag key

Query parameters

envstringOptional

Filter configurations by environment

expandstringOptional

A comma-separated list of fields to expand in the response. Supported fields are explained above.

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 or null

Description of the feature flag

clientSideAvailabilityobject or null

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

maintainerIdstring or null

Associated maintainerId for the feature flag

_maintainerobject or null

Associated maintainer member info for the feature flag

maintainerTeamKeystring or null

The key of the associated team that maintains this feature flag

_maintainerTeamobject or null

Associated maintainer team info for the feature flag

archivedDatelong or null

If archived is true, date of archive

deprecatedboolean or null

Boolean indicating if the feature flag is deprecated

deprecatedDatelong or null

If deprecated is true, date of deprecation

defaultsobject or null

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 or null

migrationSettingsobject or null

Migration-related settings for the flag

environmentsmap from strings to objects or null

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

includeInSnippetboolean or nullDeprecated

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

goalIdslist of strings or nullDeprecated

Deprecated, use experiments instead

Recommended use

Expanding response

Authentication

Path parameters

Query parameters

Response

Errors

Recommended use

Expanding response