Create a feature flag

POST

/api/v2/flags/:projectKey

POST

/api/v2/flags/:projectKey

curl -X POST https://app.launchdarkly.com/api/v2/flags/projectKey \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "My Flag",
  "key": "flag-key-123abc",
  "clientSideAvailability": {
    "usingEnvironmentId": true,
    "usingMobileKey": true
  }
}'

{
  "name": "My Flag",
  "kind": "boolean",
  "key": "flag-key-123abc",
  "_version": 1,
  "creationDate": 1494437420312,
  "variations": [
    {
      "value": null,
      "_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
    },
    {
      "value": null,
      "_id": "a00bf58d-d252-476c-b915-15a74becacb4"
    }
  ],
  "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": 1,
    "items": [
      {
        "metricKey": "my-metric",
        "_metric": {
          "_id": "5902deadbeef667524a01290",
          "_versionId": "version-id-123abc",
          "key": "metric-key-123abc",
          "name": "My metric",
          "kind": "custom",
          "_links": {
            "parent": {
              "href": "/api/v2/metrics/my-project",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "tags": [],
          "_creationDate": 1628192791148,
          "dataSource": {
            "key": "string",
            "environmentKey": "string",
            "_name": "string",
            "_integrationKey": "string"
          },
          "experimentCount": 0,
          "metricGroupCount": 0,
          "activeExperimentCount": 2,
          "activeGuardedRolloutCount": 1,
          "_version": 1,
          "_attachedFlagCount": 0,
          "_site": {},
          "_access": {
            "denied": [
              {
                "action": "string",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "string"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "string"
                  ],
                  "role_name": "string"
                }
              }
            ],
            "allowed": [
              {
                "action": "string",
                "reason": {
                  "effect": "allow",
                  "resources": [
                    "proj/*:env/*;qa_*:/flag/*"
                  ],
                  "notResources": [
                    "string"
                  ],
                  "actions": [
                    "*"
                  ],
                  "notActions": [
                    "string"
                  ],
                  "role_name": "string"
                }
              }
            ]
          },
          "lastModified": {
            "date": "2021-08-05T19:46:31.148082Z"
          },
          "maintainerId": "569fdeadbeef1644facecafe",
          "_maintainer": {
            "_links": {
              "self": {
                "href": "/api/v2/members/569f183514f4432160000007",
                "type": "application/json"
              }
            },
            "_id": "569f183514f4432160000007",
            "role": "admin",
            "email": "ariel@acme.com"
          },
          "description": "string",
          "category": "Error monitoring",
          "isNumeric": true,
          "successCriteria": "HigherThanBaseline",
          "unit": "string",
          "eventKey": "Order placed",
          "analysisUnits": [
            "user"
          ],
          "filters": {
            "type": "contextAttribute",
            "op": "in",
            "values": [
              "JP"
            ],
            "negate": false
          },
          "unitAggregationType": "average",
          "analysisType": "mean",
          "percentileValue": 95,
          "eventDefault": {
            "disabled": true,
            "value": 0
          },
          "lastSeen": 1,
          "archived": true,
          "archivedAt": 1609459200000,
          "selector": "string",
          "urls": [
            "[{\"kind\":\"exact\",\"url\":\"https://www.example.com/page1\"}]"
          ],
          "windowStartOffset": 1,
          "windowEndOffset": 1,
          "winsorLowerPercentile": 1,
          "winsorUpperPercentile": 99.5,
          "winsorIncludeImputed": false,
          "traceQuery": "service.name = \"checkout\"",
          "traceValueLocation": "duration",
          "unitAggregationField": "string",
          "denominator": {
            "eventName": "string",
            "isNumeric": true,
            "unitAggregationType": "string",
            "unitAggregationField": "string",
            "valueColumn": "string",
            "dataSource": {
              "key": "string",
              "environmentKey": "string",
              "_name": "string",
              "_integrationKey": "string"
            },
            "filters": {
              "type": "contextAttribute",
              "op": "in",
              "values": [
                "JP"
              ],
              "negate": false,
              "attribute": "country",
              "contextKind": "user"
            },
            "windowStartOffset": 1,
            "windowEndOffset": 1,
            "winsorLowerPercentile": 1.1,
            "winsorUpperPercentile": 1.1,
            "winsorIncludeImputed": true
          },
          "randomizationUnits": [
            "user"
          ]
        },
        "environments": [
          "production",
          "test",
          "my-environment"
        ],
        "_environmentSettings": {}
      }
    ]
  },
  "customProperties": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
  "archived": false,
  "description": "This flag controls the example widgets",
  "clientSideAvailability": {},
  "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"
      }
    }
  },
  "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": {
      "on": false,
      "archived": false,
      "salt": "61eddeadbeef4da1facecafe3a60a397",
      "sel": "810edeadbeef4844facecafe438f2999492",
      "lastModified": 1627071171347,
      "version": 1,
      "_site": {
        "href": "/default/my-environment/features/client-side-flag",
        "type": "text/html"
      },
      "_environmentName": "My Environment",
      "trackEvents": false,
      "trackEventsFallthrough": false,
      "targets": [
        {
          "values": [
            "user-key-123abc"
          ],
          "variation": 0,
          "contextKind": "user"
        }
      ],
      "contextTargets": [
        {
          "values": [
            "device-key-123abc"
          ],
          "variation": 0,
          "contextKind": "device"
        }
      ],
      "rules": [],
      "fallthrough": {
        "variation": 0
      },
      "offVariation": 1,
      "prerequisites": [],
      "_summary": {
        "variations": {
          "0": {
            "rules": 0,
            "nullRules": 0,
            "targets": 1,
            "contextTargets": 1,
            "isFallthrough": true
          },
          "1": {
            "rules": 0,
            "nullRules": 0,
            "targets": 0,
            "isOff": true
          }
        },
        "prerequisites": 0
      }
    }
  },
  "includeInSnippet": true,
  "goalIds": []
}

Create a feature flag with the given name, key, and variations.

Click to expand instructions for creating a migration flag

Creating a migration flag

When you create a migration flag, the variations are pre-determined based on the number of stages in the migration.

To create a migration flag, omit the variations and defaults information. Instead, provide a purpose of migration, and migrationSettings. If you create a migration flag with six stages, contextKind is required. Otherwise, it should be omitted.

Here’s an example:

{
  "key": "flag-key-123",
  "purpose": "migration",
  "migrationSettings": {
    "stageCount": 6,
    "contextKind": "account"
  }
}

To learn more, read Migration Flags.

Create a feature flag with the given name, key, and variations. <details> <summary>Click to expand instructions for <strong>creating a migration flag</strong></summary> ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here's an example: ```json { "key": "flag-key-123", "purpose": "migration", "migrationSettings": { "stageCount": 6, "contextKind": "account" } } ``` To learn more, read [Migration Flags](https://launchdarkly.com/docs/home/flags/migration). </details>

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

Query parameters

clonestringOptionalformat: "string"

The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone=flagKey copies the full targeting configuration for all environments, including on/off state, from the original flag to the new flag.

Request

This endpoint expects an object.

namestringRequired

A human-friendly name for the feature flag

keystringRequired

A unique key used to reference the flag in your code

descriptionstringOptional

Description of the feature flag. Defaults to an empty string.

clientSideAvailabilityobjectOptional

Which type of client-side SDKs the feature flag is available to

variationslist of objectsOptional

An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of true and false will be used.

temporarybooleanOptional

Whether the flag is a temporary flag. Defaults to true.

tagslist of stringsOptional

Tags for the feature flag. Defaults to an empty array.

customPropertiesmap from strings to objectsOptional

Metadata attached to the feature flag, in the form of the property key associated with a name and array of values for the metadata to associate with this flag. Typically used to store data related to an integration.

defaultsobjectOptional

The indices, from the array of variations, for the variations to serve by default when targeting is on and when targeting is off. These variations will be used for this flag in new environments. If omitted, the first and last variation will be used.

purposeenumOptional

Purpose of the flag

migrationSettingsobjectOptional

Settings relevant to flags where purpose is migration

maintainerIdstringOptional

The ID of the member who maintains this feature flag

maintainerTeamKeystringOptional

The key of the team that maintains this feature flag

initialPrerequisiteslist of objectsOptional

Initial set of prerequisite flags for all environments

isFlagOnbooleanOptional

Whether to automatically turn the flag on across all environments at creation. Defaults to false.

includeInSnippetbooleanOptionalDeprecated

Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to false.

Response

Global flag response

namestring

A human-friendly name for the feature flag

kindenum

Kind of feature flag

keystring

A unique key used to reference the flag in your code

_versioninteger

Version of the feature flag

creationDatelong

Timestamp of flag creation date

variationslist of objects

An array of possible variations for the flag

temporaryboolean

Whether the flag is a temporary flag

tagslist of strings

Tags for the feature flag

_linksmap from strings to objects

The location and content type of related resources

experimentsobject

Experimentation data for the feature flag

customPropertiesmap from strings to objects

archivedboolean

Boolean indicating if the feature flag is archived

descriptionstringOptional

Description of the feature flag

clientSideAvailabilityobjectOptional

Which type of client-side SDKs the feature flag is available to

maintainerIdstringOptional

Associated maintainerId for the feature flag

_maintainerobjectOptional

Associated maintainer member info for the feature flag

maintainerTeamKeystringOptional

The key of the associated team that maintains this feature flag

_maintainerTeamobjectOptional

Associated maintainer team info for the feature flag

archivedDatelongOptional

If archived is true, date of archive

deprecatedbooleanOptional

Boolean indicating if the feature flag is deprecated

deprecatedDatelongOptional

If deprecated is true, date of deprecation

defaultsobjectOptional

_purposestringOptional

migrationSettingsobjectOptional

Migration-related settings for the flag

staleobjectOptional

Information about a flag's stale states

environmentsmap from strings to objectsOptional

Details on the environments for this flag. Only returned if the request is filtered by environment, using the filterEnv query parameter.

includeInSnippetbooleanOptionalDeprecated

Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK

goalIdslist of stringsOptionalDeprecated

Deprecated, use experiments instead

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

429

Too Many Requests Error