launchdarkly_api.FeatureFlagsApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
copy_feature_flag	POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy	Copy feature flag
delete_feature_flag	DELETE /api/v2/flags/{projectKey}/{featureFlagKey}	Delete feature flag
get_expiring_context_targets	GET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}	Get expiring context targets for feature flag
get_expiring_user_targets	GET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}	Get expiring user targets for feature flag
get_feature_flag	GET /api/v2/flags/{projectKey}/{featureFlagKey}	Get feature flag
get_feature_flag_status	GET /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}	Get feature flag status
get_feature_flag_status_across_environments	GET /api/v2/flag-status/{projectKey}/{featureFlagKey}	Get flag status across environments
get_feature_flag_statuses	GET /api/v2/flag-statuses/{projectKey}/{environmentKey}	List feature flag statuses
get_feature_flags	GET /api/v2/flags/{projectKey}	List feature flags
patch_expiring_targets	PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}	Update expiring context targets on feature flag
patch_expiring_user_targets	PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}	Update expiring user targets on feature flag
patch_feature_flag	PATCH /api/v2/flags/{projectKey}/{featureFlagKey}	Update feature flag
post_feature_flag	POST /api/v2/flags/{projectKey}	Create a feature flag
post_migration_safety_issues	POST /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues	Get migration safety issues

copy_feature_flag

FeatureFlag copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)

Copy feature flag

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.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.flag_copy_config_post import FlagCopyConfigPost
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flag import FeatureFlag
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key. The key identifies the flag in your code.
    flag_copy_config_post = FlagCopyConfigPost(
        source=FlagCopyConfigEnvironment(
            key="key_example",
            current_version=1,
        ),
        target=FlagCopyConfigEnvironment(
            key="key_example",
            current_version=1,
        ),
        comment="comment_example",
        included_actions=["updateOn"],
        excluded_actions=["updateOn"],
    ) # FlagCopyConfigPost | 

    # example passing only required values which don't have defaults set
    try:
        # Copy feature flag
        api_response = api_instance.copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->copy_feature_flag: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
feature_flag_key	str	The feature flag key. The key identifies the flag in your code.
flag_copy_config_post	FlagCopyConfigPost

Return type

FeatureFlag

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Global flag response	-
400	Invalid request	-
401	Invalid access token	-
405	Method not allowed	-
409	Status conflict	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_feature_flag

delete_feature_flag(project_key, feature_flag_key)

Delete feature flag

Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key. The key identifies the flag in your code.

    # example passing only required values which don't have defaults set
    try:
        # Delete feature flag
        api_instance.delete_feature_flag(project_key, feature_flag_key)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->delete_feature_flag: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key. The key identifies the flag in your code.

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Action succeeded	-
401	Invalid access token	-
404	Invalid resource identifier	-
409	Status conflict	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_expiring_context_targets

ExpiringTargetGetResponse get_expiring_context_targets(project_key, environment_key, feature_flag_key)

Get expiring context targets for feature flag

Get a list of context targets on a feature flag that are scheduled for removal.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.expiring_target_get_response import ExpiringTargetGetResponse
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key

    # example passing only required values which don't have defaults set
    try:
        # Get expiring context targets for feature flag
        api_response = api_instance.get_expiring_context_targets(project_key, environment_key, feature_flag_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_expiring_context_targets: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
feature_flag_key	str	The feature flag key

Return type

ExpiringTargetGetResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expiring target response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_expiring_user_targets

ExpiringUserTargetGetResponse get_expiring_user_targets(project_key, environment_key, feature_flag_key)

Get expiring user targets for feature flag

Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get expiring context targets for feature flag instead of this endpoint. To learn more, read Contexts. Get a list of user targets on a feature flag that are scheduled for removal.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.expiring_user_target_get_response import ExpiringUserTargetGetResponse
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key

    # example passing only required values which don't have defaults set
    try:
        # Get expiring user targets for feature flag
        api_response = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_expiring_user_targets: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
feature_flag_key	str	The feature flag key

Return type

ExpiringUserTargetGetResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expiring user target response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_feature_flag

FeatureFlag get_feature_flag(project_key, feature_flag_key)

Get feature flag

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.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flag import FeatureFlag
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key
    env = "env_example" # str | Filter configurations by environment (optional)
    expand = "expand_example" # str | A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get feature flag
        api_response = api_instance.get_feature_flag(project_key, feature_flag_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get feature flag
        api_response = api_instance.get_feature_flag(project_key, feature_flag_key, env=env, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key
env	str	Filter configurations by environment	[optional]
expand	str	A comma-separated list of fields to expand in the response. Supported fields are explained above.	[optional]

Return type

FeatureFlag

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Global flag response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_feature_flag_status

FlagStatusRep get_feature_flag_status(project_key, environment_key, feature_flag_key)

Get feature flag status

Get the status for a particular feature flag.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.flag_status_rep import FlagStatusRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key

    # example passing only required values which don't have defaults set
    try:
        # Get feature flag status
        api_response = api_instance.get_feature_flag_status(project_key, environment_key, feature_flag_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag_status: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
feature_flag_key	str	The feature flag key

Return type

FlagStatusRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Flag status response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_feature_flag_status_across_environments

FeatureFlagStatusAcrossEnvironments get_feature_flag_status_across_environments(project_key, feature_flag_key)

Get flag status across environments

Get the status for a particular feature flag across environments.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flag_status_across_environments import FeatureFlagStatusAcrossEnvironments
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key
    env = "env_example" # str | Optional environment filter (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get flag status across environments
        api_response = api_instance.get_feature_flag_status_across_environments(project_key, feature_flag_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag_status_across_environments: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get flag status across environments
        api_response = api_instance.get_feature_flag_status_across_environments(project_key, feature_flag_key, env=env)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag_status_across_environments: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key
env	str	Optional environment filter	[optional]

Return type

FeatureFlagStatusAcrossEnvironments

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Flag status across environments response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_feature_flag_statuses

FeatureFlagStatuses get_feature_flag_statuses(project_key, environment_key)

List feature flag statuses

Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - new: You created the flag fewer than seven days ago and it has never been requested. - active: LaunchDarkly is receiving requests for this flag, but there are either multiple variations configured, or it is toggled off, or there have been changes to configuration in the past seven days. - inactive: You created the feature flag more than seven days ago, and hasn't been requested within the past seven days. - launched: LaunchDarkly is receiving requests for this flag, it is toggled on, there is only one variation configured, and there have been no changes to configuration in the past seven days. To learn more, read Flag statuses.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.feature_flag_statuses import FeatureFlagStatuses
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key

    # example passing only required values which don't have defaults set
    try:
        # List feature flag statuses
        api_response = api_instance.get_feature_flag_statuses(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flag_statuses: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key

Return type

FeatureFlagStatuses

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Flag Statuses collection response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_feature_flags

FeatureFlags get_feature_flags(project_key)

List feature flags

Get a list of all feature flags in the given project. You can include information specific to different environments by adding env query parameter. For example, setting env=production adds configuration details about your production environment to the response. You can also filter feature flags by tag with the tag query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: limit, env, query, and filter=creationDate. ### Filtering flags You can filter on certain fields using the filter query parameter. For example, setting filter=query:dark-mode,tags:beta+test matches flags with the string dark-mode in their key or name, ignoring case, which also have the tags beta and test. The filter query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | applicationEvaluated | A string. It filters the list to flags that are evaluated in the application with the given key. | filter=applicationEvaluated:com.launchdarkly.cafe | | archived | (deprecated) A boolean value. It filters the list to archived flags. | Use filter=state:archived instead | | contextKindsEvaluated | A +-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | filter=contextKindsEvaluated:user+application | | codeReferences.max | An integer value. Use 0 to return flags that do not have code references. | filter=codeReferences.max:0 | | codeReferences.min | An integer value. Use 1 to return flags that do have code references. | filter=codeReferences.min:1 | | creationDate | An object with an optional before field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | filter=creationDate:{\"before\":1690527600000} | | evaluated | An object that contains a key of after and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the filterEnv filter. | filter=evaluated:{\"after\":1690527600000},filterEnv:production | | filterEnv | A valid environment key. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | filter=evaluated:{\"after\": 1590768455282},filterEnv:production | | hasExperiment | A boolean value. It filters the list to flags that are used in an experiment. | filter=hasExperiment:true | | maintainerId | A valid member ID. It filters the list to flags that are maintained by this member. | filter=maintainerId:12ab3c45de678910abc12345 | | maintainerTeamKey | A string. It filters the list to flags that are maintained by the team with this key. | filter=maintainerTeamKey:example-team-key | | query | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | filter=query:example | | releasePipeline | A release pipeline key. It filters the list to flags that are either currently active in the release pipeline or have completed the release pipeline. | filter=releasePipeline:default-release-pipeline | | state | A string, either live, deprecated, or archived. It filters the list to flags in this state. | filter=state:archived | | sdkAvailability | A string, one of client, mobile, anyClient, server. Using client filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using mobile filters to flags set to use the mobile key. Using anyClient filters to flags set to use either the client-side ID or the mobile key. Using server filters to flags set to use neither, that is, to flags only available in server-side SDKs. | filter=sdkAvailability:client | | tags | A +-separated list of tags. It filters the list to flags that have all of the tags in the list. | filter=tags:beta+test | | type | A string, either temporary or permanent. It filters the list to flags with the specified type. | filter=type:permanent | The documented values for the filter query are prior to URL encoding. For example, the + in filter=tags:beta+test must be encoded to %2B. By default, this endpoint returns all flags. You can page through the list with the limit parameter and by following the first, prev, next, and last links in the returned _links field. These links will not be present if the pages they refer to don't exist. For example, the first and prev links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - creationDate sorts by the creation date of the flag. - key sorts by the key of the flag. - maintainerId sorts by the flag maintainer. - name sorts by flag name. - tags sorts by tags. - targetingModifiedDate sorts by the date that the flag's targeting rules were last modified in a given environment. It must be used with env parameter and it can not be combined with any other sort. If multiple env values are provided, it will perform sort using the first one. For example, sort=-targetingModifiedDate&env=production&env=staging returns results sorted by targetingModifiedDate for the production environment. - type sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, sort=-name sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the expand query param to include additional fields in the response, with the following fields: - codeReferences includes code references for the feature flag - 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. ### Migration flags For migration flags, the cohort information is included in the rules property of a flag's response, and default cohort information is included in the fallthrough property of a flag's response. To learn more, read Migration Flags.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flags import FeatureFlags
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    env = "env_example" # str | Filter configurations by environment (optional)
    tag = "tag_example" # str | Filter feature flags by tag (optional)
    limit = 1 # int | The number of feature flags to return. Defaults to 20. (optional)
    offset = 1 # int | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
    archived = True # bool | Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned (optional)
    summary = True # bool | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. (optional)
    filter = "filter_example" # str | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional)
    sort = "sort_example" # str | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
    compare = True # bool | Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. (optional)
    expand = "expand_example" # str | A comma-separated list of fields to expand in the response. Supported fields are explained above. (optional)

    # example passing only required values which don't have defaults set
    try:
        # List feature flags
        api_response = api_instance.get_feature_flags(project_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flags: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List feature flags
        api_response = api_instance.get_feature_flags(project_key, env=env, tag=tag, limit=limit, offset=offset, archived=archived, summary=summary, filter=filter, sort=sort, compare=compare, expand=expand)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->get_feature_flags: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
env	str	Filter configurations by environment	[optional]
tag	str	Filter feature flags by tag	[optional]
limit	int	The number of feature flags to return. Defaults to 20.	[optional]
offset	int	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
archived	bool	Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned	[optional]
summary	bool	By default, flags do not include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned.	[optional]
filter	str	A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.	[optional]
sort	str	A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.	[optional]
compare	bool	Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments.	[optional]
expand	str	A comma-separated list of fields to expand in the response. Supported fields are explained above.	[optional]

Return type

FeatureFlags

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Global flags collection response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_expiring_targets

ExpiringTargetPatchResponse patch_expiring_targets(project_key, environment_key, feature_flag_key, patch_flags_request)

Update expiring context targets on feature flag

Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context. You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. ### Instructions Semantic patch requests support the following kind instructions for updating expiring targets.

Click to expand instructions for updating expiring targets

#### addExpiringTarget Adds a date and time that LaunchDarkly will remove the context from the flag's individual targeting. ##### Parameters * value: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * variationId: ID of a variation on the flag * contextKey: The context key for the context to remove from individual targeting * contextKind: The kind of context represented by the contextKey Here's an example:

json {   \"instructions\": [{     \"kind\": \"addExpiringTarget\",     \"value\": 1754006460000,     \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\",     \"contextKey\": \"user-key-123abc\",     \"contextKind\": \"user\"   }] }

#### updateExpiringTarget Updates the date and time that LaunchDarkly will remove the context from the flag's individual targeting ##### Parameters * value: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag * variationId: ID of a variation on the flag * contextKey: The context key for the context to remove from individual targeting * contextKind: The kind of context represented by the contextKey * version: (Optional) The version of the expiring target to update. If included, update will fail if version doesn't match current version of the expiring target. Here's an example:

json {   \"instructions\": [{     \"kind\": \"updateExpiringTarget\",     \"value\": 1754006460000,     \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\",     \"contextKey\": \"user-key-123abc\",     \"contextKind\": \"user\"   }] }

#### removeExpiringTarget Removes the scheduled removal of the context from the flag's individual targeting. The context will remain part of the flag's individual targeting until you explicitly remove it, or until you schedule another removal. ##### Parameters * variationId: ID of a variation on the flag * contextKey: The context key for the context to remove from individual targeting * contextKind: The kind of context represented by the contextKey Here's an example:

json {   \"instructions\": [{     \"kind\": \"removeExpiringTarget\",     \"variationId\": \"4254742c-71ae-411f-a992-43b18a51afe0\",     \"contextKey\": \"user-key-123abc\",     \"contextKind\": \"user\"   }] }

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.expiring_target_patch_response import ExpiringTargetPatchResponse
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.patch_flags_request import PatchFlagsRequest
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key
    patch_flags_request = PatchFlagsRequest(
        comment="optional comment",
        instructions=[
            Instruction(
                key=None,
            ),
        ],
    ) # PatchFlagsRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Update expiring context targets on feature flag
        api_response = api_instance.patch_expiring_targets(project_key, environment_key, feature_flag_key, patch_flags_request)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->patch_expiring_targets: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
feature_flag_key	str	The feature flag key
patch_flags_request	PatchFlagsRequest

Return type

ExpiringTargetPatchResponse

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expiring target response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_expiring_user_targets

ExpiringUserTargetPatchResponse patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_flags_request)

Update expiring user targets on feature flag

Contexts are now available > > After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Update expiring context targets on feature flag instead of this endpoint. To learn more, read Contexts. Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key. You can add, update, or remove a scheduled removal date. You can only schedule a target for removal on a single variation per flag. Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. ### Instructions Semantic patch requests support the following kind instructions for updating expiring user targets.

Click to expand instructions for updating expiring user targets
#### addExpireUserTargetDate Adds a date and time that LaunchDarkly will remove the user from the flag's individual targeting. ##### Parameters * value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * variationId: ID of a variation on the flag * userKey: The user key for the user to remove from individual targeting #### updateExpireUserTargetDate Updates the date and time that LaunchDarkly will remove the user from the flag's individual targeting. ##### Parameters * value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag * variationId: ID of a variation on the flag * userKey: The user key for the user to remove from individual targeting * version: (Optional) The version of the expiring user target to update. If included, update will fail if version doesn't match current version of the expiring user target. #### removeExpireUserTargetDate Removes the scheduled removal of the user from the flag's individual targeting. The user will remain part of the flag's individual targeting until you explicitly remove them, or until you schedule another removal. ##### Parameters * variationId: ID of a variation on the flag * userKey: The user key for the user to remove from individual targeting

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.expiring_user_target_patch_response import ExpiringUserTargetPatchResponse
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.patch_flags_request import PatchFlagsRequest
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key
    patch_flags_request = PatchFlagsRequest(
        comment="optional comment",
        instructions=[
            Instruction(
                key=None,
            ),
        ],
    ) # PatchFlagsRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Update expiring user targets on feature flag
        api_response = api_instance.patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_flags_request)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->patch_expiring_user_targets: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
feature_flag_key	str	The feature flag key
patch_flags_request	PatchFlagsRequest

Return type

ExpiringUserTargetPatchResponse

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Expiring user target response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_feature_flag

FeatureFlag patch_feature_flag(project_key, feature_flag_key, patch_with_comment)

Update feature flag

Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read Updates. ### Using semantic patches on a feature flag To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch. The body of a semantic patch request for updating feature flags takes the following properties: * comment (string): (Optional) A description of the update. * environmentKey (string): (Required for some instructions only) The key of the LaunchDarkly environment. * instructions (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a kind property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following kind instructions for updating feature flags.

Click to expand instructions for turning flags on and off

These instructions require the environmentKey parameter. #### turnFlagOff Sets the flag's targeting state to Off. Here's an example: json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } #### turnFlagOn Sets the flag's targeting state to On. Here's an example: json { \"environmentKey\": \"environment-key-123abc\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] }

Click to expand instructions for working with targeting and variations

These instructions require the environmentKey parameter. Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the Get feature flag response. The flag rule ID is the _id field of each element in the rules array within each environment listed in the environments object. The variation ID is the _id field in each element of the variations array. The clause ID is the _id field of each element of the clauses array within the rules array within each environment listed in the environments object. #### addClauses Adds the given clauses to the rule indicated by ruleId. ##### Parameters - ruleId: ID of a rule in the flag. - clauses: Array of clause objects, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"addClauses\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"clauses\": [{    \"contextKind\": \"user\",    \"attribute\": \"country\",    \"op\": \"in\",    \"negate\": false,    \"values\": [\"USA\", \"Canada\"]   }]  }] }

#### addPrerequisite Adds the flag indicated by key with variation variationId as a prerequisite to the flag in the path parameter. ##### Parameters - key: Flag key of the prerequisite flag. - variationId: ID of a variation of the prerequisite flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"addPrerequisite\",   \"key\": \"example-prereq-flag-key\",   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### addRule Adds a new targeting rule to the flag. The rule may contain clauses and serve the variation that variationId indicates, or serve a percentage rollout that rolloutWeights, rolloutBucketBy, and rolloutContextKind indicate. If you set beforeRuleId, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - clauses: Array of clause objects, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case. - beforeRuleId: (Optional) ID of a flag rule. - Either - variationId: ID of a variation of the flag. or - rolloutWeights: (Optional) Map of variationId to weight, in thousandths of a percent (0-100000). - rolloutBucketBy: (Optional) Context attribute available in the specified rolloutContextKind. - rolloutContextKind: (Optional) Context kind, defaults to user Here's an example that uses a variationId:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [{     \"kind\": \"addRule\",     \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",     \"clauses\": [{       \"contextKind\": \"organization\",       \"attribute\": \"located_in\",       \"op\": \"in\",       \"negate\": false,       \"values\": [\"Sweden\", \"Norway\"]     }]   }] }

Here's an example that uses a percentage rollout:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [{     \"kind\": \"addRule\",     \"clauses\": [{       \"contextKind\": \"organization\",       \"attribute\": \"located_in\",       \"op\": \"in\",       \"negate\": false,       \"values\": [\"Sweden\", \"Norway\"]     }],     \"rolloutContextKind\": \"organization\",     \"rolloutWeights\": {       \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation       \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000  // serve 85% this variation     }   }] }

#### addTargets Adds context keys to the individual context targets for the context kind that contextKind specifies and the variation that variationId specifies. Returns an error if this causes the flag to target the same context key in multiple variations. ##### Parameters - values: List of context keys. - contextKind: (Optional) Context kind to target, defaults to user - variationId: ID of a variation on the flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"addTargets\",   \"values\": [\"context-key-123abc\", \"context-key-456def\"],   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### addUserTargets Adds user keys to the individual user targets for the variation that variationId specifies. Returns an error if this causes the flag to target the same user key in multiple variations. If you are working with contexts, use addTargets instead of this instruction. ##### Parameters - values: List of user keys. - variationId: ID of a variation on the flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"addUserTargets\",   \"values\": [\"user-key-123abc\", \"user-key-456def\"],   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### addValuesToClause Adds values to the values of the clause that ruleId and clauseId indicate. Does not update the context kind, attribute, or operator. ##### Parameters - ruleId: ID of a rule in the flag. - clauseId: ID of a clause in that rule. - values: Array of strings, case sensitive. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"addValuesToClause\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\",   \"values\": [\"beta_testers\"]  }] }

#### addVariation Adds a variation to the flag. ##### Parameters - value: The variation value. - name: (Optional) The variation name. - description: (Optional) A description for the variation. Here's an example: json { \"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ] } #### clearTargets Removes all individual targets from the variation that variationId specifies. This includes both user and non-user targets. ##### Parameters - variationId: ID of a variation on the flag. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] }

#### clearUserTargets Removes all individual user targets from the variation that variationId specifies. If you are working with contexts, use clearTargets instead of this instruction. ##### Parameters - variationId: ID of a variation on the flag. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] }

#### removeClauses Removes the clauses specified by clauseIds from the rule indicated by ruleId. ##### Parameters - ruleId: ID of a rule in the flag. - clauseIds: Array of IDs of clauses in the rule. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"removeClauses\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"]  }] }

#### removePrerequisite Removes the prerequisite flag indicated by key. Does nothing if this prerequisite does not exist. ##### Parameters - key: Flag key of an existing prerequisite flag. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ] }

#### removeRule Removes the targeting rule specified by ruleId. Does nothing if the rule does not exist. ##### Parameters - ruleId: ID of a rule in the flag. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ] }

#### removeTargets Removes context keys from the individual context targets for the context kind that contextKind specifies and the variation that variationId specifies. Does nothing if the flag does not target the context keys. ##### Parameters - values: List of context keys. - contextKind: (Optional) Context kind to target, defaults to user - variationId: ID of a flag variation. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"removeTargets\",   \"values\": [\"context-key-123abc\", \"context-key-456def\"],   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### removeUserTargets Removes user keys from the individual user targets for the variation that variationId specifies. Does nothing if the flag does not target the user keys. If you are working with contexts, use removeTargets instead of this instruction. ##### Parameters - values: List of user keys. - variationId: ID of a flag variation. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"removeUserTargets\",   \"values\": [\"user-key-123abc\", \"user-key-456def\"],   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### removeValuesFromClause Removes values from the values of the clause indicated by ruleId and clauseId. Does not update the context kind, attribute, or operator. ##### Parameters - ruleId: ID of a rule in the flag. - clauseId: ID of a clause in that rule. - values: Array of strings, case sensitive. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"removeValuesFromClause\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\",   \"values\": [\"beta_testers\"]  }] }

#### removeVariation Removes a variation from the flag. ##### Parameters - variationId: ID of a variation of the flag to remove. Here's an example:

json {  \"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] }

#### reorderRules Rearranges the rules to match the order given in ruleIds. Returns an error if ruleIds does not match the current set of rules on the flag. ##### Parameters - ruleIds: Array of IDs of all rules in the flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"reorderRules\",   \"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"]  }] }

#### replacePrerequisites Removes all existing prerequisites and replaces them with the list you provide. ##### Parameters - prerequisites: A list of prerequisites. Each item in the list must include a flag key and variationId. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [     {       \"kind\": \"replacePrerequisites\",       \"prerequisites\": [         {           \"key\": \"prereq-flag-key-123abc\",           \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\"         },         {           \"key\": \"another-prereq-flag-key-456def\",           \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\"         }       ]     }   ] }

#### replaceRules Removes all targeting rules for the flag and replaces them with the list you provide. ##### Parameters - rules: A list of rules. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [     {       \"kind\": \"replaceRules\",       \"rules\": [         {           \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",           \"description\": \"My new rule\",           \"clauses\": [             {               \"contextKind\": \"user\",               \"attribute\": \"segmentMatch\",               \"op\": \"segmentMatch\",               \"values\": [\"test\"]             }           ],           \"trackEvents\": true         }       ]     }   ] }

#### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - targets: A list of context targeting. Each item in the list includes an optional contextKind that defaults to user, a required variationId, and a required list of values. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [     {       \"kind\": \"replaceTargets\",       \"targets\": [         {           \"contextKind\": \"user\",           \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",           \"values\": [\"user-key-123abc\"]         },         {           \"contextKind\": \"device\",           \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\",           \"values\": [\"device-key-456def\"]         }       ]     }       ] }

#### replaceUserTargets Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag's variations. If you are working with contexts, use replaceTargets instead of this instruction. ##### Parameters - targets: A list of user targeting. Each item in the list must include a variationId and a list of values. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [     {       \"kind\": \"replaceUserTargets\",       \"targets\": [         {           \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",           \"values\": [\"user-key-123abc\", \"user-key-456def\"]         },         {           \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\",           \"values\": [\"user-key-789ghi\"]         }       ]     }   ] }

#### updateClause Replaces the clause indicated by ruleId and clauseId with clause. ##### Parameters - ruleId: ID of a rule in the flag. - clauseId: ID of a clause in that rule. - clause: New clause object, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [{     \"kind\": \"updateClause\",     \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",     \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\",     \"clause\": {       \"contextKind\": \"user\",       \"attribute\": \"country\",       \"op\": \"in\",       \"negate\": false,       \"values\": [\"Mexico\", \"Canada\"]     }   }] }

#### updateDefaultVariation Updates the default on or off variation of the flag. ##### Parameters - onVariationValue: (Optional) The value of the variation of the new on variation. - offVariationValue: (Optional) The value of the variation of the new off variation Here's an example:

json {  \"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ] }

#### updateFallthroughVariationOrRollout Updates the default or "fallthrough" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that variationId indicates, or a percentage rollout that rolloutWeights and rolloutBucketBy indicate. ##### Parameters - variationId: ID of a variation of the flag. or - rolloutWeights: Map of variationId to weight, in thousandths of a percent (0-100000). - rolloutBucketBy: (Optional) Context attribute available in the specified rolloutContextKind. - rolloutContextKind: (Optional) Context kind, defaults to user Here's an example that uses a variationId:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updateFallthroughVariationOrRollout\",   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

Here's an example that uses a percentage rollout:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updateFallthroughVariationOrRollout\",   \"rolloutContextKind\": \"user\",   \"rolloutWeights\": {    \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation    \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000  // serve 85% this variation   }  }] }

#### updateOffVariation Updates the default off variation to variationId. The flag serves the default off variation when the flag's targeting is Off. ##### Parameters - variationId: ID of a variation of the flag. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ] }

#### updatePrerequisite Changes the prerequisite flag that key indicates to use the variation that variationId indicates. Returns an error if this prerequisite does not exist. ##### Parameters - key: Flag key of an existing prerequisite flag. - variationId: ID of a variation of the prerequisite flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updatePrerequisite\",   \"key\": \"example-prereq-flag-key\",   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### updateRuleDescription Updates the description of the feature flag rule. ##### Parameters - description: The new human-readable description for this rule. - ruleId: The ID of the rule. You can retrieve this by making a GET request for the flag. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updateRuleDescription\",   \"description\": \"New rule description\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\"  }] }

#### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule. ##### Parameters - ruleId: The ID of the rule. You can retrieve this by making a GET request for the flag. - trackEvents: Whether or not events are tracked. Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updateRuleTrackEvents\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"trackEvents\": true  }] }

#### updateRuleVariationOrRollout Updates what ruleId serves when its clauses evaluate to true. The rule can serve either the variation that variationId indicates, or a percent rollout that rolloutWeights and rolloutBucketBy indicate. ##### Parameters - ruleId: ID of a rule in the flag. - variationId: ID of a variation of the flag. or - rolloutWeights: Map of variationId to weight, in thousandths of a percent (0-100000). - rolloutBucketBy: (Optional) Context attribute available in the specified rolloutContextKind. - rolloutContextKind: (Optional) Context kind, defaults to user Here's an example:

json {  \"environmentKey\": \"environment-key-123abc\",  \"instructions\": [{   \"kind\": \"updateRuleVariationOrRollout\",   \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",   \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"  }] }

#### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules. ##### Parameters - trackEvents: Whether or not events are tracked. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ] }

#### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule. ##### Parameters - trackEvents: Whether or not events are tracked. Here's an example:

json {   \"environmentKey\": \"environment-key-123abc\",   \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ] }

#### updateVariation Updates a variation of the flag. ##### Parameters - variationId: The ID of the variation to update. - name: (Optional) The updated variation name. - value: (Optional) The updated variation value. - description: (Optional) The updated variation description. Here's an example:

json {  \"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ] }

Click to expand instructions for updating flag settings

These instructions do not require the environmentKey parameter. They make changes that apply to the flag across all environments. #### addCustomProperties Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature's development. ##### Parameters - key: The custom property key. - name: The custom property name. - values: A list of the associated values for the custom property. Here's an example:

json {  \"instructions\": [{   \"kind\": \"addCustomProperties\",   \"key\": \"example-custom-property\",   \"name\": \"Example custom property\",   \"values\": [\"value1\", \"value2\"]  }] }

#### addTags Adds tags to the feature flag. ##### Parameters - values: A list of tags to add. Here's an example: json { \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ] } #### makeFlagPermanent Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your customers. Here's an example: json { \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ] } #### makeFlagTemporary Marks the feature flag as temporary. Here's an example: json { \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ] } #### removeCustomProperties Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property. ##### Parameters - key: The custom property key. - values: A list of the associated values to remove from the custom property.

json {  \"instructions\": [{   \"kind\": \"replaceCustomProperties\",   \"key\": \"example-custom-property\",   \"values\": [\"value1\", \"value2\"]  }] }

#### removeMaintainer Removes the flag's maintainer. To set a new maintainer, use the updateMaintainerMember or updateMaintainerTeam instructions. Here's an example: json { \"instructions\": [ { \"kind\": \"removeMaintainer\" } ] } #### removeTags Removes tags from the feature flag. ##### Parameters - values: A list of tags to remove. Here's an example: json { \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ] } #### replaceCustomProperties Replaces the existing associated values for a custom property with the new values. ##### Parameters - key: The custom property key. - name: The custom property name. - values: A list of the new associated values for the custom property. Here's an example:

json {  \"instructions\": [{    \"kind\": \"replaceCustomProperties\",    \"key\": \"example-custom-property\",    \"name\": \"Example custom property\",    \"values\": [\"value1\", \"value2\"]  }] }

#### turnOffClientSideAvailability Turns off client-side SDK availability for the flag. This is equivalent to unchecking the SDKs using Mobile key and/or SDKs using Client-side ID boxes for the flag. If you're using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - value: Use "usingMobileKey" to turn off availability for mobile SDKs. Use "usingEnvironmentId" to turn on availability for client-side SDKs. Here's an example: json { \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } #### turnOnClientSideAvailability Turns on client-side SDK availability for the flag. This is equivalent to checking the SDKs using Mobile key and/or SDKs using Client-side ID boxes for the flag. If you're using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them. ##### Parameters - value: Use "usingMobileKey" to turn on availability for mobile SDKs. Use "usingEnvironmentId" to turn on availability for client-side SDKs. Here's an example: json { \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ] } #### updateDescription Updates the feature flag description. ##### Parameters - value: The new description. Here's an example: json { \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ] } #### updateMaintainerMember Updates the maintainer of the flag to an existing member and removes the existing maintainer. ##### Parameters - value: The ID of the member. Here's an example: json { \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ] } #### updateMaintainerTeam Updates the maintainer of the flag to an existing team and removes the existing maintainer. ##### Parameters - value: The key of the team. Here's an example: json { \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ] } #### updateName Updates the feature flag name. ##### Parameters - value: The new name. Here's an example: json { \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ] }

Click to expand instructions for updating the flag lifecycle

These instructions do not require the environmentKey parameter. They make changes that apply to the flag across all environments. #### archiveFlag Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags. json { \"instructions\": [ { \"kind\": \"archiveFlag\" } ] } #### deleteFlag Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all contexts. Here's an example: json { \"instructions\": [ { \"kind\": \"deleteFlag\" } ] } #### deprecateFlag Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it. Here's an example: json { \"instructions\": [ { \"kind\": \"deprecateFlag\" } ] } #### restoreDeprecatedFlag Restores the feature flag if it was previously deprecated. Here's an example: json { \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ] } #### restoreFlag Restores the feature flag if it was previously archived. Here's an example: json { \"instructions\": [ { \"kind\": \"restoreFlag\" } ] }

### Using JSON patches on a feature flag If you do not include the semantic patch header described above, you can use a JSON patch or JSON merge patch representation of the desired changes. In the JSON patch representation, use a JSON pointer in the path element to describe what field to change. Use the Get feature flag endpoint to find the field you want to update. There are a few special cases to keep in mind when determining the value of the path element: * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is:

json   [     {       \"op\": \"add\",       \"path\": \"/environments/devint/targets/0/values/-\",       \"value\": \"TestClient10\"     }   ]

* To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is:

json   [     {       \"op\": \"add\",       \"path\": \"/environments/devint/targets/-\",       \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] }     }   ]

* To add a flag to a release pipeline, the path for the JSON patch operation is:

json   [     {       \"op\": \"add\",       \"path\": \"/releasePipelineKey\",       \"value\": \"example-release-pipeline-key\"     }   ]

### Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an approval request or a workflow. ### Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an ignoreConflicts query parameter set to true. ### Migration flags For migration flags, the cohort information is included in the rules property of a flag's response. You can update cohorts by updating rules. Default cohort information is included in the fallthrough property of a flag's response. You can update the default cohort by updating fallthrough. When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single variationId. To learn more, read Migration flags.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.method_not_allowed_error_rep import MethodNotAllowedErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.patch_with_comment import PatchWithComment
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flag import FeatureFlag
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_key = "featureFlagKey_example" # str | The feature flag key. The key identifies the flag in your code.
    patch_with_comment = PatchWithComment(
        patch=JSONPatch([
            PatchOperation(
                op="replace",
                path="/exampleField",
                value=None,
            ),
        ]),
        comment="comment_example",
    ) # PatchWithComment | 
    ignore_conflicts = True # bool | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update feature flag
        api_response = api_instance.patch_feature_flag(project_key, feature_flag_key, patch_with_comment)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->patch_feature_flag: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update feature flag
        api_response = api_instance.patch_feature_flag(project_key, feature_flag_key, patch_with_comment, ignore_conflicts=ignore_conflicts)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->patch_feature_flag: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key. The key identifies the flag in your code.
patch_with_comment	PatchWithComment
ignore_conflicts	bool	If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.	[optional]

Return type

FeatureFlag

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Global flag response	-
400	Invalid request	-
401	Invalid access token	-
404	Invalid resource identifier	-
405	Approval is required to make this request	-
409	Status conflict	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_feature_flag

FeatureFlag post_feature_flag(project_key, feature_flag_body)

Create a feature flag

Create a feature flag with the given name, key, and variations.

Click to expand instructions for creating a migration flag

### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the variations and defaults information. Instead, provide a purpose of migration, and migrationSettings. If you create a migration flag with six stages, contextKind is required. Otherwise, it should be omitted. Here's an example:

json {   \"key\": \"flag-key-123\",   \"purpose\": \"migration\",   \"migrationSettings\": {     \"stageCount\": 6,     \"contextKind\": \"account\"   } }

To learn more, read Migration Flags.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.feature_flag_body import FeatureFlagBody
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.feature_flag import FeatureFlag
from launchdarkly_api.model.status_conflict_error_rep import StatusConflictErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    feature_flag_body = FeatureFlagBody(
        name="My flag",
        key="flag-key-123abc",
        description="This flag controls the example widgets",
        include_in_snippet=True,
        client_side_availability=ClientSideAvailabilityPost(
            using_environment_id=True,
            using_mobile_key=True,
        ),
        variations=[
            Variation(
                id="id_example",
                value=None,
                description="description_example",
                name="name_example",
            ),
        ],
        temporary=False,
        tags=["example-tag"],
        custom_properties=CustomProperties(
            key=CustomProperty(
                name="Jira issues",
                value=["is-123","is-456"],
            ),
        ),
        defaults=Defaults(
            on_variation=0,
            off_variation=1,
        ),
        purpose="migration",
        migration_settings=MigrationSettingsPost(
            context_kind="context_kind_example",
            stage_count=1,
        ),
        maintainer_id="12ab3c45de678910fgh12345",
        maintainer_team_key="team-1",
        initial_prerequisites=[
            FlagPrerequisitePost(
                key="key_example",
                variation_id="variation_id_example",
            ),
        ],
    ) # FeatureFlagBody | 
    clone = "clone_example" # str | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create a feature flag
        api_response = api_instance.post_feature_flag(project_key, feature_flag_body)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->post_feature_flag: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a feature flag
        api_response = api_instance.post_feature_flag(project_key, feature_flag_body, clone=clone)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->post_feature_flag: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_body	FeatureFlagBody
clone	str	The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag.	[optional]

Return type

FeatureFlag

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Global flag response	-
400	Invalid request	-
401	Invalid access token	-
409	Status conflict	-
429	Rate limited	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_migration_safety_issues

[MigrationSafetyIssueRep] post_migration_safety_issues(project_key, flag_key, environment_key, flag_sempatch)

Get migration safety issues

Returns the migration safety issues that are associated with the POSTed flag patch. The patch must use the semantic patch format for updating feature flags.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import feature_flags_api
from launchdarkly_api.model.flag_sempatch import FlagSempatch
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.migration_safety_issue_rep import MigrationSafetyIssueRep
from launchdarkly_api.model.status_service_unavailable import StatusServiceUnavailable
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = feature_flags_api.FeatureFlagsApi(api_client)
    project_key = "projectKey_example" # str | The project key
    flag_key = "flagKey_example" # str | The migration flag key
    environment_key = "environmentKey_example" # str | The environment key
    flag_sempatch = FlagSempatch(
        instructions=Instructions([
            Instruction(
                key=None,
            ),
        ]),
        comment="comment_example",
    ) # FlagSempatch | 

    # example passing only required values which don't have defaults set
    try:
        # Get migration safety issues
        api_response = api_instance.post_migration_safety_issues(project_key, flag_key, environment_key, flag_sempatch)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling FeatureFlagsApi->post_migration_safety_issues: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
flag_key	str	The migration flag key
environment_key	str	The environment key
flag_sempatch	FlagSempatch

Return type

[MigrationSafetyIssueRep]

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Migration safety issues found	-
204	No safety issues found	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-
503	Service unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FeatureFlagsApi.md

Latest commit

History

FeatureFlagsApi.md

File metadata and controls

launchdarkly_api.FeatureFlagsApi

copy_feature_flag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_feature_flag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_expiring_context_targets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_expiring_user_targets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flag_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flag_status_across_environments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flag_statuses

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_expiring_targets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_expiring_user_targets

Example

Parameters