Update flag trigger | LaunchDarkly

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:

1 {
2   "instructions": [
3     {
4       "kind": "replaceTriggerActionInstructions",
5       "value": [ {"kind": "turnFlagOff"} ]
6     }
7   ]
8 }

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:

1 {
2   "instructions": [{ "kind": "cycleTriggerUrl" }]
3 }

disableTrigger

Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use enableTrigger.

Here’s an example:

1 {
2   "instructions": [{ "kind": "disableTrigger" }]
3 }

enableTrigger

Enables the trigger. If you previously disabled the trigger, it begins running again.

Here’s an example:

1 {
2   "instructions": [{ "kind": "enableTrigger" }]
3 }

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](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating flag triggers. <details> <summary>Click to expand instructions for <strong>updating flag triggers</strong></summary> #### replaceTriggerActionInstructions Removes the existing trigger action and replaces it with the new instructions. ##### Parameters - `value`: An array of the new `kind`s 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" }] } ``` </details>

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

featureFlagKeystringRequired

The feature flag key

idstringRequired

The flag trigger ID

Request

This endpoint expects an object.

commentstringOptional

Optional comment describing the update

instructionslist of maps from strings to anyOptional

The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “trigger_action”}</code>.

Response

Flag trigger response

_idstring or null

The ID of this flag trigger

_versioninteger or null

The flag trigger version

_creationDatelong or null

Timestamp of when the flag trigger was created

_maintainerIdstring or null

The ID of the flag trigger maintainer

_maintainerobject or null

Details on the member who maintains this flag trigger

enabledboolean or null

Whether the flag trigger is currently enabled

_integrationKeystring or null

The unique identifier of the integration for your trigger

instructionslist of maps from strings to any or null

Details on the action to perform when triggering

_lastTriggeredAtlong or null

Timestamp of when the trigger was most recently executed

_recentTriggerBodieslist of objects or null

Details on recent flag trigger requests.

_triggerCountinteger or null

Number of times the trigger has been executed

triggerURLstring or null

The unguessable URL for this flag trigger

_linksmap from strings to objects or null

The location and content type of related resources

Errors

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:

1 {
2   "instructions": [
3     {
4       "kind": "replaceTriggerActionInstructions",
5       "value": [ {"kind": "turnFlagOff"} ]
6     }
7   ]
8 }

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:

1 {
2   "instructions": [{ "kind": "cycleTriggerUrl" }]
3 }

disableTrigger

Disables the trigger. This saves the trigger configuration, but the trigger stops running. To re-enable, use enableTrigger.

Here’s an example:

1 {
2   "instructions": [{ "kind": "disableTrigger" }]
3 }

enableTrigger

Enables the trigger. If you previously disabled the trigger, it begins running again.

Here’s an example:

1 {
2   "instructions": [{ "kind": "enableTrigger" }]
3 }

1	import requests
2
3	url = "https://app.launchdarkly.com/api/v2/flags/projectKey/featureFlagKey/triggers/environmentKey/id"
4
5	payload = {}
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.patch(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"_id": "_id",
3	"_version": 1,
4	"_creationDate": 1000000,
5	"_maintainerId": "12ab3c45de678910abc12345",
6	"_maintainer": {
7	"_links": {
8	"self": {
9	"href": "/api/v2/members/569f183514f4432160000007",
10	"type": "application/json"
11	}
12	},
13	"_id": "569f183514f4432160000007",
14	"role": "admin",
15	"email": "ariel@acme.com",
16	"firstName": "Ariel",
17	"lastName": "Flores"
18	},
19	"enabled": true,
20	"_integrationKey": "generic-trigger",
21	"instructions": [
22	{
23	"key": "value"
24	}
25	],
26	"_lastTriggeredAt": 1000000,
27	"_recentTriggerBodies": [
28	{
29	"timestamp": 1000000,
30	"jsonBody": {
31	"key": "value"
32	}
33	}
34	],
35	"_triggerCount": 3,
36	"triggerURL": "triggerURL",
37	"_links": {
38	"key": {
39	"href": "href",
40	"type": "type"
41	}
42	}
43	}

1	{
2	"instructions": [
3	{
4	"kind": "replaceTriggerActionInstructions",
5	"value": [ {"kind": "turnFlagOff"} ]
6	}
7	]
8	}