Create approval request | LaunchDarkly

curl -X POST https://app.launchdarkly.com/api/v2/approval-requests \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "resourceId": "proj/projKey:env/envKey:flag/flagKey",
  "description": "Requesting to update targeting",
  "instructions": [
    "[{\"kind\": \"addUserTargets\", \"values\": [ \"user-key-123abc\"], \"variationId\": \"ce67d625-a8b9-4fb5-a344-ab909d9d4f4d\" }]"
  ]
}'

{
  "_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"
    }
  },
  "resourceId": "string",
  "approvalSettings": {
    "required": true,
    "bypassApprovalsForPendingChanges": false,
    "minNumApprovals": 1,
    "canReviewOwnRequest": false,
    "canApplyDeclinedChanges": true,
    "serviceKind": "launchdarkly",
    "serviceConfig": {},
    "requiredApprovalTags": [
      "require-approval"
    ],
    "autoApplyApprovedChanges": true,
    "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
  }
}

Create an approval request.

This endpoint requires a list of instructions, in semantic patch format, that will be applied when the approval request is approved and applied.

Flags

If you are creating an approval request for a flag, you can use the following instructions:

addVariation
removeVariation
updateVariation
updateDefaultVariation

For details on using these instructions, read Update feature flag.

To create an approval for a flag specific to an environment, use Create approval request for a flag.

AgentControl

If you are creating an approval request for an AgentControl config, you can use the semantic patch instructions listed under Update config targeting.

Segments

If you are creating an approval request for a segment, you can use the semantic patch instructions listed under Patch segment.

Create an approval request. This endpoint requires a list of `instructions`, in semantic patch format, that will be applied when the approval request is approved and applied. ### Flags If you are creating an approval request for a flag, you can use the following `instructions`: - `addVariation` - `removeVariation` - `updateVariation` - `updateDefaultVariation` For details on using these instructions, read [Update feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag). To create an approval for a flag specific to an environment, use [Create approval request for a flag](https://launchdarkly.com/docs/api/approvals/post-approval-request-for-flag). ### AgentControl If you are creating an approval request for an AgentControl config, you can use the semantic patch instructions listed under [Update config targeting](https://launchdarkly.com/docs/api/ai-configs/patch-config-targeting). ### Segments If you are creating an approval request for a segment, you can use the semantic patch instructions listed under [Patch segment](https://launchdarkly.com/docs/api/segments/patch-segment).

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

resourceIdstringRequired

String representation of the resource specifier

descriptionstringRequired

A brief description of the changes you're requesting

instructionslist of maps from strings to anyRequired

List of instructions in semantic patch format to be applied to the feature flag. Review the Update feature flag documentation for details on available instructions.

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.

integrationConfigmap from strings to anyOptional

Additional approval request fields for third-party integration approval systems. If you are using a third-party integration to manage approval requests, these additional fields will be described in the manifest.json for that integration, at https://github.com/launchdarkly/integration-framework.

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

resourceIdstring

String representation of a resource

approvalSettingsobject

The settings for this approval

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error