Update flag trigger

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"
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}"

payload = {
    "comment": "optional comment",
    "instructions": [{ "kind": "disableTrigger" }]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({comment: 'optional comment', instructions: [{kind: 'disableTrigger'}]})
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'optional comment',
    'instructions' => [
        [
                'kind' => 'disableTrigger'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}"

	payload := strings.NewReader("{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "_creationDate": "1654104600000",
  "_maintainerId": "12ab3c45de678910abc12345",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "role": "admin",
    "email": "ariel@acme.com",
    "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": {}
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

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:

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

flags

{projectKey}

{featureFlagKey}

triggers

{environmentKey}

{id}

Update flag trigger

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"
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}"

payload = {
    "comment": "optional comment",
    "instructions": [{ "kind": "disableTrigger" }]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({comment: 'optional comment', instructions: [{kind: 'disableTrigger'}]})
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'optional comment',
    'instructions' => [
        [
                'kind' => 'disableTrigger'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}"

	payload := strings.NewReader("{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"optional comment\",\n  \"instructions\": [\n    {\n      \"kind\": \"disableTrigger\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "_creationDate": "1654104600000",
  "_maintainerId": "12ab3c45de678910abc12345",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "role": "admin",
    "email": "ariel@acme.com",
    "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": {}
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

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

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

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