launchdarkly_api.ScheduledChangesApi

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

Method	HTTP request	Description
delete_flag_config_scheduled_changes	DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Delete scheduled changes workflow
get_feature_flag_scheduled_change	GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Get a scheduled change
get_flag_config_scheduled_changes	GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes	List scheduled changes
patch_flag_config_scheduled_change	PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Update scheduled changes workflow
post_flag_config_scheduled_changes	POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes	Create scheduled changes workflow

delete_flag_config_scheduled_changes

delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, id)

Delete scheduled changes workflow

Delete a scheduled changes workflow.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.ScheduledChangesApi(api_client)
    project_key = 'project_key_example' # str | The project key
    feature_flag_key = 'feature_flag_key_example' # str | The feature flag key
    environment_key = 'environment_key_example' # str | The environment key
    id = 'id_example' # str | The scheduled change id

    try:
        # Delete scheduled changes workflow
        api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, id)
    except Exception as e:
        print("Exception when calling ScheduledChangesApi->delete_flag_config_scheduled_changes: %s\n" % e)

Parameters

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

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	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
409	Status conflict	-
429	Rate limited	-

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

get_feature_flag_scheduled_change

FeatureFlagScheduledChange get_feature_flag_scheduled_change(project_key, feature_flag_key, environment_key, id)

Get a scheduled change

Get a scheduled change that will be applied to the feature flag by ID.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.feature_flag_scheduled_change import FeatureFlagScheduledChange
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.ScheduledChangesApi(api_client)
    project_key = 'project_key_example' # str | The project key
    feature_flag_key = 'feature_flag_key_example' # str | The feature flag key
    environment_key = 'environment_key_example' # str | The environment key
    id = 'id_example' # str | The scheduled change id

    try:
        # Get a scheduled change
        api_response = api_instance.get_feature_flag_scheduled_change(project_key, feature_flag_key, environment_key, id)
        print("The response of ScheduledChangesApi->get_feature_flag_scheduled_change:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledChangesApi->get_feature_flag_scheduled_change: %s\n" % e)

Parameters

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

Return type

FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Scheduled changes response	-
401	Invalid access token	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_flag_config_scheduled_changes

FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key)

List scheduled changes

Get a list of scheduled changes that will be applied to the feature flag.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.feature_flag_scheduled_changes import FeatureFlagScheduledChanges
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.ScheduledChangesApi(api_client)
    project_key = 'project_key_example' # str | The project key
    feature_flag_key = 'feature_flag_key_example' # str | The feature flag key
    environment_key = 'environment_key_example' # str | The environment key

    try:
        # List scheduled changes
        api_response = api_instance.get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key)
        print("The response of ScheduledChangesApi->get_flag_config_scheduled_changes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledChangesApi->get_flag_config_scheduled_changes: %s\n" % e)

Parameters

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

Return type

FeatureFlagScheduledChanges

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Scheduled changes collection response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-

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

patch_flag_config_scheduled_change

FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, ignore_conflicts=ignore_conflicts)

Update scheduled changes workflow

Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change 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 scheduled changes.

Click to expand instructions for updating scheduled changes

deleteScheduledChange

Removes the scheduled change.

Here's an example:

{
  "instructions": [{ "kind": "deleteScheduledChange" }]
}

replaceScheduledChangesInstructions

Removes the existing scheduled changes and replaces them with the new instructions.

Parameters

value: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are turnFlagOn and turnFlagOff.

Here's an example that replaces the scheduled changes with new instructions to turn flag targeting off:

{
  "instructions": [
    {
      "kind": "replaceScheduledChangesInstructions",
      "value": [ {"kind": "turnFlagOff"} ]
    }
  ]
}

updateScheduledChangesExecutionDate

Updates the execution date for the scheduled changes.

Parameters

value: the new execution date, in Unix milliseconds.

Here's an example:

{
  "instructions": [
    {
      "kind": "updateScheduledChangesExecutionDate",
      "value": 1754092860000
    }
  ]
}

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.feature_flag_scheduled_change import FeatureFlagScheduledChange
from launchdarkly_api.models.flag_scheduled_changes_input import FlagScheduledChangesInput
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.ScheduledChangesApi(api_client)
    project_key = 'project_key_example' # str | The project key
    feature_flag_key = 'feature_flag_key_example' # str | The feature flag key
    environment_key = 'environment_key_example' # str | The environment key
    id = 'id_example' # str | The scheduled change ID
    flag_scheduled_changes_input = {"comment":"Optional comment describing the update to the scheduled changes","instructions":[{"kind":"replaceScheduledChangesInstructions","value":[{"kind":"turnFlagOff"}]}]} # FlagScheduledChangesInput | 
    ignore_conflicts = True # bool | Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes (optional)

    try:
        # Update scheduled changes workflow
        api_response = api_instance.patch_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, ignore_conflicts=ignore_conflicts)
        print("The response of ScheduledChangesApi->patch_flag_config_scheduled_change:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledChangesApi->patch_flag_config_scheduled_change: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key
environment_key	str	The environment key
id	str	The scheduled change ID
flag_scheduled_changes_input	FlagScheduledChangesInput
ignore_conflicts	bool	Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes	[optional]

Return type

FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Scheduled changes response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
409	Status conflict	-
429	Rate limited	-

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

post_flag_config_scheduled_changes

FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, ignore_conflicts=ignore_conflicts)

Create scheduled changes workflow

Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when updating a feature flag. If the ignoreConflicts query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.

Example

Api Key Authentication (ApiKey):

import launchdarkly_api
from launchdarkly_api.models.feature_flag_scheduled_change import FeatureFlagScheduledChange
from launchdarkly_api.models.post_flag_scheduled_changes_input import PostFlagScheduledChangesInput
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.ScheduledChangesApi(api_client)
    project_key = 'project_key_example' # str | The project key
    feature_flag_key = 'feature_flag_key_example' # str | The feature flag key
    environment_key = 'environment_key_example' # str | The environment key
    post_flag_scheduled_changes_input = {"comment":"Optional comment describing the scheduled changes","executionDate":1718467200000,"instructions":[{"kind":"turnFlagOn"}]} # PostFlagScheduledChangesInput | 
    ignore_conflicts = True # bool | Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes (optional)

    try:
        # Create scheduled changes workflow
        api_response = api_instance.post_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, ignore_conflicts=ignore_conflicts)
        print("The response of ScheduledChangesApi->post_flag_config_scheduled_changes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScheduledChangesApi->post_flag_config_scheduled_changes: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
feature_flag_key	str	The feature flag key
environment_key	str	The environment key
post_flag_scheduled_changes_input	PostFlagScheduledChangesInput
ignore_conflicts	bool	Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes	[optional]

Return type

FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Scheduled changes response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
405	Method not allowed	-
409	Status conflict	-
429	Rate limited	-

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

FilesExpand file tree

ScheduledChangesApi.md

Latest commit

History

ScheduledChangesApi.md

File metadata and controls

launchdarkly_api.ScheduledChangesApi

delete_flag_config_scheduled_changes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_feature_flag_scheduled_change

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_flag_config_scheduled_changes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_flag_config_scheduled_change

Instructions

deleteScheduledChange

replaceScheduledChangesInstructions

Parameters

updateScheduledChangesExecutionDate

Parameters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_flag_config_scheduled_changes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details