Update flag trigger

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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:

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

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

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

enableTrigger

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

Here’s an example:

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

PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}

Update flag trigger

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "optional comment",
  "instructions": [
    {
      "kind": "disableTrigger"
    }
  ]
}
'

200

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "_creationDate": "1654104600000",
  "_maintainerId": "12ab3c45de678910abc12345",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "role": "admin",
    "email": "[e-mail]",
    "firstName": "Ariel",
    "lastName": "Flores"
  },
  "enabled": true,
  "_status": "active",
  "_lastFailedAt": "1654114600000",
  "_integrationKey": "generic-trigger",
  "instructions": "[ { \"kind\": \"turnFlagOn\" }]",
  "_lastTriggeredAt": "1654114600000",
  "_recentTriggerBodies": [
    {
      "timestamp": "1654104600000",
      "jsonBody": {}
    }
  ],
  "_triggerCount": 3,
  "triggerURL": "<string>",
  "_links": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

featureFlagKey · string<string> · required

The feature flag key

id · string<string> · required

The flag trigger ID

Body

application/json

comment · string

Optional comment describing the update

Example:

"optional comment"

instructions · object[]

The instructions to perform when updating. This should be an array with objects that look like {"kind": "trigger_action"}.

Show child attributes

Example:

[{ "kind": "disableTrigger" }]

Response

200

application/json

Flag trigger response

_id · string

The ID of this flag trigger

Example:

"12ab3c45de678910abc12345"

_version · integer

The flag trigger version

Example:

1

_creationDate · integer<int64>

Timestamp of when the flag trigger was created

Example:

"1654104600000"

_maintainerId · string

The ID of the flag trigger maintainer

Example:

"12ab3c45de678910abc12345"

_maintainer · object

Details on the member who maintains this flag trigger

Show child attributes

enabled · boolean

Whether the flag trigger is currently enabled

Example:

true

_status · enum<string>

The trigger state: active, inactive, or failed

Available options: active, inactive, failed

Example:

"active"

_lastFailedAt · integer<int64>

Timestamp of when the trigger most recently entered failed state

Example:

"1654114600000"

_integrationKey · string

The unique identifier of the integration for your trigger

Example:

"generic-trigger"

instructions · object[]

Details on the action to perform when triggering

Show child attributes

Example:

"[ { \"kind\": \"turnFlagOn\" }]"

_lastTriggeredAt · integer<int64>

Timestamp of when the trigger was most recently executed

Example:

"1654114600000"

_recentTriggerBodies · object[]

Details on recent flag trigger requests.

Show child attributes

_triggerCount · integer

Number of times the trigger has been executed

Example:

3

triggerURL · string

The unguessable URL for this flag trigger

_links · object

The location and content type of related resources

Show child attributes