Copy feature flag

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "optional comment",
  "source": {
    "currentVersion": 1,
    "key": "source-env-key-123abc"
  },
  "target": {
    "currentVersion": 1,
    "key": "target-env-key-123abc"
  }
}
'

import requests

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

payload = {
    "comment": "optional comment",
    "source": {
        "currentVersion": 1,
        "key": "source-env-key-123abc"
    },
    "target": {
        "currentVersion": 1,
        "key": "target-env-key-123abc"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'optional comment',
    source: {currentVersion: 1, key: 'source-env-key-123abc'},
    target: {currentVersion: 1, key: 'target-env-key-123abc'}
  })
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy', 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}/copy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'optional comment',
    'source' => [
        'currentVersion' => 1,
        'key' => 'source-env-key-123abc'
    ],
    'target' => [
        'currentVersion' => 1,
        'key' => 'target-env-key-123abc'
    ]
  ]),
  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}/copy"

	payload := strings.NewReader("{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}"

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

{
  "name": "My Flag",
  "kind": "boolean",
  "key": "flag-key-123abc",
  "_version": 1,
  "creationDate": "1494437420312",
  "variations": [
    {
      "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
      "value": true
    },
    {
      "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
      "value": false
    }
  ],
  "temporary": true,
  "tags": [
    "example-tag"
  ],
  "_links": {
    "parent": {
      "href": "/api/v2/flags/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/flags/my-project/my-flag",
      "type": "application/json"
    }
  },
  "experiments": "{\"baselineIdx\": 0,\"items\": []}",
  "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
  "archived": false,
  "description": "This flag controls the example widgets",
  "includeInSnippet": true,
  "clientSideAvailability": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
  "maintainerId": "569f183514f4432160000007",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "role": "admin",
    "email": "ariel@acme.com",
    "firstName": "Ariel",
    "lastName": "Flores"
  },
  "maintainerTeamKey": "team-1",
  "_maintainerTeam": {
    "key": "team-key-123abc",
    "name": "Example team",
    "_links": {
      "parent": {
        "href": "/api/v2/teams",
        "type": "application/json"
      },
      "roles": {
        "href": "/api/v2/teams/example-team/roles",
        "type": "application/json"
      },
      "self": {
        "href": "/api/v2/teams/example-team",
        "type": "application/json"
      }
    }
  },
  "goalIds": [],
  "archivedDate": "1494437420312",
  "deprecated": false,
  "deprecatedDate": "1494437420312",
  "defaults": "{\"onVariation\":0,\"offVariation\":1}",
  "_purpose": "<string>",
  "migrationSettings": {
    "contextKind": "device",
    "stageCount": 6
  },
  "stale": {
    "readyForCodeRemoval": true,
    "readyToArchive": true,
    "cleanupId": "<string>"
  },
  "environments": {
    "my-environment": {
      "_environmentName": "My Environment",
      "_site": {
        "href": "/default/my-environment/features/client-side-flag",
        "type": "text/html"
      },
      "_summary": {
        "prerequisites": 0,
        "variations": {
          "0": {
            "contextTargets": 1,
            "isFallthrough": true,
            "nullRules": 0,
            "rules": 0,
            "targets": 1
          },
          "1": {
            "isOff": true,
            "nullRules": 0,
            "rules": 0,
            "targets": 0
          }
        }
      },
      "archived": false,
      "contextTargets": [
        {
          "contextKind": "device",
          "values": [
            "device-key-123abc"
          ],
          "variation": 0
        }
      ],
      "fallthrough": {
        "variation": 0
      },
      "lastModified": 1627071171347,
      "offVariation": 1,
      "on": false,
      "prerequisites": [],
      "rules": [],
      "salt": "61eddeadbeef4da1facecafe3a60a397",
      "sel": "810edeadbeef4844facecafe438f2999492",
      "targets": [
        {
          "contextKind": "user",
          "values": [
            "user-key-123abc"
          ],
          "variation": 0
        }
      ],
      "trackEvents": false,
      "trackEventsFallthrough": false,
      "version": 1
    }
  }
}

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

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

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

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

Copy feature flag

Copying flag settings is an Enterprise feature

Copying flag settings is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Copy flag settings from a source environment to a target environment.

By default, this operation copies the entire flag configuration. You can use the includedActions or excludedActions to specify that only part of the flag configuration is copied.

If you provide the optional currentVersion of a flag, this operation tests to ensure that the current flag version in the environment matches the version you’ve specified. The operation rejects attempts to copy flag settings if the environment’s current version of the flag does not match the version you’ve specified. You can use this to enforce optimistic locking on copy attempts.

POST

api

flags

{projectKey}

{featureFlagKey}

copy

Copy feature flag

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "optional comment",
  "source": {
    "currentVersion": 1,
    "key": "source-env-key-123abc"
  },
  "target": {
    "currentVersion": 1,
    "key": "target-env-key-123abc"
  }
}
'

import requests

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

payload = {
    "comment": "optional comment",
    "source": {
        "currentVersion": 1,
        "key": "source-env-key-123abc"
    },
    "target": {
        "currentVersion": 1,
        "key": "target-env-key-123abc"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'optional comment',
    source: {currentVersion: 1, key: 'source-env-key-123abc'},
    target: {currentVersion: 1, key: 'target-env-key-123abc'}
  })
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy', 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}/copy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'optional comment',
    'source' => [
        'currentVersion' => 1,
        'key' => 'source-env-key-123abc'
    ],
    'target' => [
        'currentVersion' => 1,
        'key' => 'target-env-key-123abc'
    ]
  ]),
  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}/copy"

	payload := strings.NewReader("{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"optional comment\",\n  \"source\": {\n    \"currentVersion\": 1,\n    \"key\": \"source-env-key-123abc\"\n  },\n  \"target\": {\n    \"currentVersion\": 1,\n    \"key\": \"target-env-key-123abc\"\n  }\n}"

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

{
  "name": "My Flag",
  "kind": "boolean",
  "key": "flag-key-123abc",
  "_version": 1,
  "creationDate": "1494437420312",
  "variations": [
    {
      "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
      "value": true
    },
    {
      "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
      "value": false
    }
  ],
  "temporary": true,
  "tags": [
    "example-tag"
  ],
  "_links": {
    "parent": {
      "href": "/api/v2/flags/my-project",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/flags/my-project/my-flag",
      "type": "application/json"
    }
  },
  "experiments": "{\"baselineIdx\": 0,\"items\": []}",
  "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
  "archived": false,
  "description": "This flag controls the example widgets",
  "includeInSnippet": true,
  "clientSideAvailability": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
  "maintainerId": "569f183514f4432160000007",
  "_maintainer": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "role": "admin",
    "email": "ariel@acme.com",
    "firstName": "Ariel",
    "lastName": "Flores"
  },
  "maintainerTeamKey": "team-1",
  "_maintainerTeam": {
    "key": "team-key-123abc",
    "name": "Example team",
    "_links": {
      "parent": {
        "href": "/api/v2/teams",
        "type": "application/json"
      },
      "roles": {
        "href": "/api/v2/teams/example-team/roles",
        "type": "application/json"
      },
      "self": {
        "href": "/api/v2/teams/example-team",
        "type": "application/json"
      }
    }
  },
  "goalIds": [],
  "archivedDate": "1494437420312",
  "deprecated": false,
  "deprecatedDate": "1494437420312",
  "defaults": "{\"onVariation\":0,\"offVariation\":1}",
  "_purpose": "<string>",
  "migrationSettings": {
    "contextKind": "device",
    "stageCount": 6
  },
  "stale": {
    "readyForCodeRemoval": true,
    "readyToArchive": true,
    "cleanupId": "<string>"
  },
  "environments": {
    "my-environment": {
      "_environmentName": "My Environment",
      "_site": {
        "href": "/default/my-environment/features/client-side-flag",
        "type": "text/html"
      },
      "_summary": {
        "prerequisites": 0,
        "variations": {
          "0": {
            "contextTargets": 1,
            "isFallthrough": true,
            "nullRules": 0,
            "rules": 0,
            "targets": 1
          },
          "1": {
            "isOff": true,
            "nullRules": 0,
            "rules": 0,
            "targets": 0
          }
        }
      },
      "archived": false,
      "contextTargets": [
        {
          "contextKind": "device",
          "values": [
            "device-key-123abc"
          ],
          "variation": 0
        }
      ],
      "fallthrough": {
        "variation": 0
      },
      "lastModified": 1627071171347,
      "offVariation": 1,
      "on": false,
      "prerequisites": [],
      "rules": [],
      "salt": "61eddeadbeef4da1facecafe3a60a397",
      "sel": "810edeadbeef4844facecafe438f2999492",
      "targets": [
        {
          "contextKind": "user",
          "values": [
            "user-key-123abc"
          ],
          "variation": 0
        }
      ],
      "trackEvents": false,
      "trackEventsFallthrough": false,
      "version": 1
    }
  }
}

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

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

{
  "code": "method_not_allowed",
  "message": "Method not allowed"
}

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

featureFlagKey

string<string>

required

The feature flag key. The key identifies the flag in your code.

Body

application/json

source

object

required

The source environment

Show child attributes

Example:

"{\"key\": \"source-env-key-123abc\", \"currentVersion\": 1}"

target

object

required

The target environment

Show child attributes

Example:

"{\"key\": \"target-env-key-123abc\", \"currentVersion\": 1}"

comment

string

Optional comment

includedActions

enum<string>[]

Optional list of the flag changes to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

Available options:

updateOn,

updateRules,

updateFallthrough,

updateOffVariation,

updatePrerequisites,

updateTargets,

updateFlagConfigMigrationSettings

Example:

["updateOn"]

excludedActions

enum<string>[]

Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

Available options:

updateOn,

updateRules,

updateFallthrough,

updateOffVariation,

updatePrerequisites,

updateTargets,

updateFlagConfigMigrationSettings

Example:

["updateOn"]

Response

Global flag response

name

string

required

A human-friendly name for the feature flag

Example:

"My Flag"

kind

enum<string>

required

Kind of feature flag

Available options:

boolean,

multivariate

Example:

"boolean"

key

string

required

A unique key used to reference the flag in your code

Example:

"flag-key-123abc"

_version

integer

required

Version of the feature flag

Example:

1

creationDate

integer<int64>

required

Timestamp of flag creation date

Example:

"1494437420312"

variations

object[]

required

An array of possible variations for the flag

Show child attributes

Example:

[
  {
    "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
    "value": true
  },
  {
    "_id": "a00bf58d-d252-476c-b915-15a74becacb4",
    "value": false
  }
]

temporary

boolean

required

Whether the flag is a temporary flag

Example:

true