Create approval request to copy flag configurations across environments | LaunchDarkly

curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/approval-requests-flag-copy \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "copy flag settings to another environment",
  "source": {
    "key": "environment-key-123abc"
  }
}'

{
  "_id": "12ab3c45de678910abc12345",
  "_version": 1,
  "creationDate": 1654104600000,
  "serviceKind": "launchdarkly",
  "reviewStatus": "pending",
  "allReviews": [
    {
      "_id": "12ab3c45de678910abc12345",
      "kind": "approve",
      "creationDate": 1653606981113,
      "comment": "Approved!",
      "memberId": "12ab3c45de678910abc12345",
      "serviceTokenId": "12ab3c45de678910abc12345"
    }
  ],
  "notifyMemberIds": [
    "1234a56b7c89d012345e678f"
  ],
  "status": "pending",
  "instructions": [
    "[{\"kind\": \"turnFlagOn\"}]"
  ],
  "conflicts": [
    {
      "instruction": {},
      "reason": "string"
    }
  ],
  "_links": {},
  "requestorId": "12ab3c45de678910abc12345",
  "description": "example: request approval from someone",
  "appliedDate": 1654104600000,
  "appliedByMemberId": "1234a56b7c89d012345e678f",
  "appliedByServiceTokenId": "1234a56b7c89d012345e678f",
  "executionDate": 1654104600000,
  "operatingOnId": "12ab3c45de678910abc12345",
  "integrationMetadata": {
    "externalId": "string",
    "externalStatus": {
      "display": "string",
      "value": "string"
    },
    "externalUrl": "string",
    "lastChecked": 1
  },
  "source": {
    "key": "source-flag-key-123abc",
    "version": 1
  },
  "customWorkflowMetadata": {
    "name": "Example workflow name",
    "stage": {
      "index": 0,
      "name": "Stage 1"
    }
  }
}

Create an approval request to copy a feature flag's configuration across environments.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

featureFlagKeystringRequiredformat: "string"

The feature flag key

environmentKeystringRequiredformat: "string"

The environment key for the target environment

Request

This endpoint expects an object.

descriptionstringRequired

A brief description of your changes

sourceobjectRequired

The flag to copy

commentstringOptional

Optional comment describing the approval request

notifyMemberIdslist of stringsOptional

An array of member IDs. These members are notified to review the approval request.

notifyTeamKeyslist of stringsOptional

An array of team keys. The members of these teams are notified to review the approval request.

includedActionslist of enumsOptional

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 neither are included, then all flag changes will be copied.

excludedActionslist of enumsOptional

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 neither are included, then all flag changes will be copied.

Response

Approval request response

_idstring

The ID of this approval request

_versioninteger

Version of the approval request

creationDatelong

Timestamp of when the approval request was created

serviceKindstring

The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA.

reviewStatusenum

Current status of the review of this approval request

Allowed values:

allReviewslist of objects

An array of individual reviews of this approval request

notifyMemberIdslist of strings

An array of member IDs. These members are notified to review the approval request.

statusenum

Current status of the approval request

Allowed values:

instructionslist of maps from strings to any

List of instructions in semantic patch format to be applied to the feature flag

conflictslist of objects

Details on any conflicting approval requests

_linksmap from strings to any

The location and content type of related resources

requestorIdstring

The ID of the member who requested the approval

descriptionstring

A human-friendly name for the approval request

appliedDatelong

Timestamp of when the approval request was applied

appliedByMemberIdstring

The member ID of the member who applied the approval request

appliedByServiceTokenIdstring

The service token ID of the service token which applied the approval request

executionDatelong

Timestamp for when instructions will be executed

operatingOnIdstring

ID of scheduled change to edit or delete

integrationMetadataobject

Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used

sourceobject

Details about the source feature flag, if copied

customWorkflowMetadataobject

Details about the custom workflow, if this approval request is part of a custom workflow

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error