LaunchDarklyApi\ScheduledChangesApi

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

Method	HTTP request	Description
deleteFlagConfigScheduledChanges()	DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Delete scheduled changes workflow
getFeatureFlagScheduledChange()	GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Get a scheduled change
getFlagConfigScheduledChanges()	GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes	List scheduled changes
patchFlagConfigScheduledChange()	PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}	Update scheduled changes workflow
postFlagConfigScheduledChanges()	POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes	Create scheduled changes workflow

`deleteFlagConfigScheduledChanges()`

deleteFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key, $id)

Delete scheduled changes workflow

Delete a scheduled changes workflow.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ScheduledChangesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$environment_key = 'environment_key_example'; // string | The environment key
$id = 'id_example'; // string | The scheduled change id

try {
    $apiInstance->deleteFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key, $id);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledChangesApi->deleteFlagConfigScheduledChanges: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getFeatureFlagScheduledChange()`

getFeatureFlagScheduledChange($project_key, $feature_flag_key, $environment_key, $id): \LaunchDarklyApi\Model\FeatureFlagScheduledChange

Get a scheduled change

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ScheduledChangesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$environment_key = 'environment_key_example'; // string | The environment key
$id = 'id_example'; // string | The scheduled change id

try {
    $result = $apiInstance->getFeatureFlagScheduledChange($project_key, $feature_flag_key, $environment_key, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledChangesApi->getFeatureFlagScheduledChange: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\LaunchDarklyApi\Model\FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getFlagConfigScheduledChanges()`

getFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key): \LaunchDarklyApi\Model\FeatureFlagScheduledChanges

List scheduled changes

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ScheduledChangesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$environment_key = 'environment_key_example'; // string | The environment key

try {
    $result = $apiInstance->getFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledChangesApi->getFlagConfigScheduledChanges: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\LaunchDarklyApi\Model\FeatureFlagScheduledChanges

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`patchFlagConfigScheduledChange()`

patchFlagConfigScheduledChange($project_key, $feature_flag_key, $environment_key, $id, $flag_scheduled_changes_input, $ignore_conflicts): \LaunchDarklyApi\Model\FeatureFlagScheduledChange

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: json { \"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:

json {   \"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:

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ScheduledChangesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$environment_key = 'environment_key_example'; // string | The environment key
$id = 'id_example'; // string | The scheduled change ID
$flag_scheduled_changes_input = {"comment":"Optional comment describing the update to the scheduled changes","instructions":[{"kind":"replaceScheduledChangesInstructions","value":[{"kind":"turnFlagOff"}]}]}; // \LaunchDarklyApi\Model\FlagScheduledChangesInput
$ignore_conflicts = True; // bool | Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes

try {
    $result = $apiInstance->patchFlagConfigScheduledChange($project_key, $feature_flag_key, $environment_key, $id, $flag_scheduled_changes_input, $ignore_conflicts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledChangesApi->patchFlagConfigScheduledChange: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\LaunchDarklyApi\Model\FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

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

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

`postFlagConfigScheduledChanges()`

postFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key, $post_flag_scheduled_changes_input, $ignore_conflicts): \LaunchDarklyApi\Model\FeatureFlagScheduledChange

Create scheduled changes workflow

Create scheduled changes for a feature flag. If the ignoreConficts 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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\ScheduledChangesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$environment_key = 'environment_key_example'; // string | The environment key
$post_flag_scheduled_changes_input = {"comment":"Optional comment describing the scheduled changes","executionDate":1718467200000,"instructions":[{"kind":"turnFlagOn"}]}; // \LaunchDarklyApi\Model\PostFlagScheduledChangesInput
$ignore_conflicts = True; // bool | Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes

try {
    $result = $apiInstance->postFlagConfigScheduledChanges($project_key, $feature_flag_key, $environment_key, $post_flag_scheduled_changes_input, $ignore_conflicts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledChangesApi->postFlagConfigScheduledChanges: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\LaunchDarklyApi\Model\FeatureFlagScheduledChange

Authorization

ApiKey

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ScheduledChangesApi.md

ScheduledChangesApi.md

LaunchDarklyApi\ScheduledChangesApi

`deleteFlagConfigScheduledChanges()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getFeatureFlagScheduledChange()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getFlagConfigScheduledChanges()`

Example

Parameters

Return type

Authorization

HTTP request headers

`patchFlagConfigScheduledChange()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postFlagConfigScheduledChanges()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

ScheduledChangesApi.md

Latest commit

History

ScheduledChangesApi.md

File metadata and controls

LaunchDarklyApi\ScheduledChangesApi

deleteFlagConfigScheduledChanges()

Example

Parameters

Return type

Authorization

HTTP request headers

getFeatureFlagScheduledChange()

Example

Parameters

Return type

Authorization

HTTP request headers

getFlagConfigScheduledChanges()

Example

Parameters

Return type

Authorization

HTTP request headers

patchFlagConfigScheduledChange()

Example

Parameters

Return type

Authorization

HTTP request headers

postFlagConfigScheduledChanges()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteFlagConfigScheduledChanges()`

`getFeatureFlagScheduledChange()`

`getFlagConfigScheduledChanges()`

`patchFlagConfigScheduledChange()`

`postFlagConfigScheduledChanges()`