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.
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 daysmigrationSettings
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.
The project key
The feature flag key
Filter configurations by environment
A comma-separated list of fields to expand in the response. Supported fields are explained above.
Global flag response
A human-friendly name for the feature flag
Kind of feature flag
A unique key used to reference the flag in your code
Version of the feature flag
Timestamp of flag creation date
An array of possible variations for the flag
Whether the flag is a temporary flag
The location and content type of related resources
Experimentation data for the feature flag
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.
Boolean indicating if the feature flag is archived
Description of the feature flag
Which type of client-side SDKs the feature flag is available to
Associated maintainerId for the feature flag
Associated maintainer member info for the feature flag
The key of the associated team that maintains this feature flag
Associated maintainer team info for the feature flag
If archived is true, date of archive
Boolean indicating if the feature flag is deprecated
If deprecated is true, date of deprecation
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.
Migration-related settings for the flag
Details on the environments for this flag. Only returned if the request is filtered by environment, using the filterEnv
query parameter.
Deprecated, use clientSideAvailability
. Whether this flag should be made available to the client-side JavaScript SDK
Deprecated, use experiments
instead