LaunchDarklyApi\FlagTriggersApi

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

Method	HTTP request	Description
createTriggerWorkflow()	POST /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}	Create flag trigger
deleteTriggerWorkflow()	DELETE /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}	Delete flag trigger
getTriggerWorkflowById()	GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}	Get flag trigger by ID
getTriggerWorkflows()	GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}	List flag triggers
patchTriggerWorkflow()	PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}	Update flag trigger

`createTriggerWorkflow()`

createTriggerWorkflow($project_key, $environment_key, $feature_flag_key, $trigger_post): \LaunchDarklyApi\Model\TriggerWorkflowRep

Create flag trigger

Create a new flag trigger.

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\FlagTriggersApi(
    // 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
$environment_key = 'environment_key_example'; // string | The environment key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$trigger_post = new \LaunchDarklyApi\Model\TriggerPost(); // \LaunchDarklyApi\Model\TriggerPost

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

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
feature_flag_key	string	The feature flag key
trigger_post	\LaunchDarklyApi\Model\TriggerPost

Return type

\LaunchDarklyApi\Model\TriggerWorkflowRep

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]

`deleteTriggerWorkflow()`

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

Delete flag trigger

Delete a flag trigger 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\FlagTriggersApi(
    // 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
$environment_key = 'environment_key_example'; // string | The environment key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$id = 'id_example'; // string | The flag trigger ID

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

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
feature_flag_key	string	The feature flag key
id	string	The flag trigger 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]

`getTriggerWorkflowById()`

getTriggerWorkflowById($project_key, $feature_flag_key, $environment_key, $id): \LaunchDarklyApi\Model\TriggerWorkflowRep

Get flag trigger by ID

Get a flag trigger 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\FlagTriggersApi(
    // 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 flag trigger ID

try {
    $result = $apiInstance->getTriggerWorkflowById($project_key, $feature_flag_key, $environment_key, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlagTriggersApi->getTriggerWorkflowById: ', $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 flag trigger ID

Return type

\LaunchDarklyApi\Model\TriggerWorkflowRep

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]

`getTriggerWorkflows()`

getTriggerWorkflows($project_key, $environment_key, $feature_flag_key): \LaunchDarklyApi\Model\TriggerWorkflowCollectionRep

List flag triggers

Get a list of all flag triggers.

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\FlagTriggersApi(
    // 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
$environment_key = 'environment_key_example'; // string | The environment key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key

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

Parameters

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

Return type

\LaunchDarklyApi\Model\TriggerWorkflowCollectionRep

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]

`patchTriggerWorkflow()`

patchTriggerWorkflow($project_key, $environment_key, $feature_flag_key, $id, $flag_trigger_input): \LaunchDarklyApi\Model\TriggerWorkflowRep

Update flag trigger

Update a flag trigger. Updating a flag trigger 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 flag triggers.

Click to expand instructions for updating flag triggers

#### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - value: An array of the new kinds of actions to perform when triggering. Supported flag actions are turnFlagOn and turnFlagOff. Here's an example that replaces the existing action with new instructions to turn flag targeting off:

json {   \"instructions\": [     {       \"kind\": \"replaceTriggerActionInstructions\",       \"value\": [ {\"kind\": \"turnFlagOff\"} ]     }   ] }

#### cycleTriggerUrl Generates a new URL for this trigger. You must update any clients using the trigger to use this new URL. Here's an example: json { \"instructions\": [{ \"kind\": \"cycleTriggerUrl\" }] } #### disableTrigger Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use enableTrigger. Here's an example: json { \"instructions\": [{ \"kind\": \"disableTrigger\" }] } #### enableTrigger Enables the trigger. If you previously disabled the trigger, it begins running again. Here's an example: json { \"instructions\": [{ \"kind\": \"enableTrigger\" }] }

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\FlagTriggersApi(
    // 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
$environment_key = 'environment_key_example'; // string | The environment key
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
$id = 'id_example'; // string | The flag trigger ID
$flag_trigger_input = new \LaunchDarklyApi\Model\FlagTriggerInput(); // \LaunchDarklyApi\Model\FlagTriggerInput

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

Parameters

Name	Type	Description
project_key	string	The project key
environment_key	string	The environment key
feature_flag_key	string	The feature flag key
id	string	The flag trigger ID
flag_trigger_input	\LaunchDarklyApi\Model\FlagTriggerInput

Return type

\LaunchDarklyApi\Model\TriggerWorkflowRep

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

FlagTriggersApi.md

FlagTriggersApi.md

LaunchDarklyApi\FlagTriggersApi

`createTriggerWorkflow()`

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteTriggerWorkflow()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getTriggerWorkflowById()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getTriggerWorkflows()`

Example

Parameters

Return type

Authorization

HTTP request headers

`patchTriggerWorkflow()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

FlagTriggersApi.md

Latest commit

History

FlagTriggersApi.md

File metadata and controls

LaunchDarklyApi\FlagTriggersApi

createTriggerWorkflow()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTriggerWorkflow()

Example

Parameters

Return type

Authorization

HTTP request headers

getTriggerWorkflowById()

Example

Parameters

Return type

Authorization

HTTP request headers

getTriggerWorkflows()

Example

Parameters

Return type

Authorization

HTTP request headers

patchTriggerWorkflow()

Example

Parameters

Return type

Authorization

HTTP request headers

`createTriggerWorkflow()`

`deleteTriggerWorkflow()`

`getTriggerWorkflowById()`

`getTriggerWorkflows()`

`patchTriggerWorkflow()`