LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Approvals (beta)

Get approval request settings

GET
/api/v2/approval-requests/projects/{projectKey}/settings

Get the approval request settings for the given project, optionally filtered by environment and resource kind.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

Query Parameters

environmentKey?string

An environment key filter to apply to the approval request settings.

resourceKind?string

A resource kind filter to apply to the approval request settings.

expand?string

A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'.

Header Parameters

LD-API-Version*"beta"

Version of the endpoint.

Value in

  • "beta"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/approval-requests/projects/default/settings?expand=default%2Cstrict" \  -H "LD-API-Version: beta"
{  "property1": {    "environments": {      "property1": {        "required": true,        "bypassApprovalsForPendingChanges": false,        "minNumApprovals": 1,        "canReviewOwnRequest": false,        "canApplyDeclinedChanges": true,        "autoApplyApprovedChanges": true,        "serviceKind": "launchdarkly",        "serviceConfig": {},        "requiredApprovalTags": [          "require-approval"        ],        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"      },      "property2": {        "required": true,        "bypassApprovalsForPendingChanges": false,        "minNumApprovals": 1,        "canReviewOwnRequest": false,        "canApplyDeclinedChanges": true,        "autoApplyApprovedChanges": true,        "serviceKind": "launchdarkly",        "serviceConfig": {},        "requiredApprovalTags": [          "require-approval"        ],        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"      }    },    "_default": {      "required": true,      "bypassApprovalsForPendingChanges": false,      "minNumApprovals": 1,      "canReviewOwnRequest": false,      "canApplyDeclinedChanges": true,      "autoApplyApprovedChanges": true,      "serviceKind": "launchdarkly",      "serviceConfig": {},      "requiredApprovalTags": [        "require-approval"      ],      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"    },    "_strict": {      "required": true,      "bypassApprovalsForPendingChanges": false,      "minNumApprovals": 1,      "canReviewOwnRequest": false,      "canApplyDeclinedChanges": true,      "autoApplyApprovedChanges": true,      "serviceKind": "launchdarkly",      "serviceConfig": {},      "requiredApprovalTags": [        "require-approval"      ],      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"    }  },  "property2": {    "environments": {      "property1": {        "required": true,        "bypassApprovalsForPendingChanges": false,        "minNumApprovals": 1,        "canReviewOwnRequest": false,        "canApplyDeclinedChanges": true,        "autoApplyApprovedChanges": true,        "serviceKind": "launchdarkly",        "serviceConfig": {},        "requiredApprovalTags": [          "require-approval"        ],        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"      },      "property2": {        "required": true,        "bypassApprovalsForPendingChanges": false,        "minNumApprovals": 1,        "canReviewOwnRequest": false,        "canApplyDeclinedChanges": true,        "autoApplyApprovedChanges": true,        "serviceKind": "launchdarkly",        "serviceConfig": {},        "requiredApprovalTags": [          "require-approval"        ],        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"      }    },    "_default": {      "required": true,      "bypassApprovalsForPendingChanges": false,      "minNumApprovals": 1,      "canReviewOwnRequest": false,      "canApplyDeclinedChanges": true,      "autoApplyApprovedChanges": true,      "serviceKind": "launchdarkly",      "serviceConfig": {},      "requiredApprovalTags": [        "require-approval"      ],      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"    },    "_strict": {      "required": true,      "bypassApprovalsForPendingChanges": false,      "minNumApprovals": 1,      "canReviewOwnRequest": false,      "canApplyDeclinedChanges": true,      "autoApplyApprovedChanges": true,      "serviceKind": "launchdarkly",      "serviceConfig": {},      "requiredApprovalTags": [        "require-approval"      ],      "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"    }  }}

Update flag approval request PATCH

Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. 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](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.

Update approval request settings PATCH

Perform a partial update to approval request settings