/launchdarkly-workflows | Type: Application | PCID required: Yes
Tools
launchdarkly_workflows_create_release_for_flag
Create a new release for flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The flag key |
releasePipelineKey | string | Yes | — | The key of the release pipeline to attach the flag to |
releaseVariationId | string | No | — | The variation id to release to across all phases |
launchdarkly_workflows_create_workflow_template
Create workflow template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description value |
environmentKey | string | No | — | Environment Key |
flagKey | string | No | — | Flag Key |
key | string | Yes | — | The key value |
name | string | No | — | The name value |
projectKey | string | No | — | Project Key |
stages | object[] | No | — | The stages value |
workflowId | string | No | — | Workflow Id |
launchdarkly_workflows_delete_approval_request
Delete approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The approval request ID |
launchdarkly_workflows_delete_approval_request_for_flag
Delete approval request for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The feature flag approval request ID |
launchdarkly_workflows_delete_release_by_flag_key
Delete a release for flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The flag key |
launchdarkly_workflows_delete_release_pipeline
Delete release pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
pipelineKey | string | Yes | — | The release pipeline key |
launchdarkly_workflows_delete_release_policy
Delete a release policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
policyKey | string | Yes | — | The human-readable key of the release policy |
launchdarkly_workflows_delete_workflow
Delete workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
workflowId | string | Yes | — | The workflow id |
launchdarkly_workflows_delete_workflow_template
Delete workflow template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateKey | string | Yes | — | The template key |
launchdarkly_workflows_get_all_release_pipelines
Get all release pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. |
limit | integer | No | — | The maximum number of items to return. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_workflows_get_all_release_progressions_for_release_pipeline
Get release progressions for release pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
pipelineKey | string | Yes | — | The pipeline key |
filter | string | No | — | Accepts filter by status and activePhaseId. status can take a value of completed or active. activePhaseId takes a UUID and will filter results down to releases active on the specified phase. Providing status equals completed along with an activePhaseId filter will return an error as they are disjoint sets of data. The combination of status equals active and activePhaseId will return the same results as activePhaseId alone. |
limit | integer | No | — | The maximum number of items to return. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_workflows_get_approval_for_flag
Get approval request for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The feature flag approval request ID |
launchdarkly_workflows_get_approval_request
Get approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The approval request ID |
expand | string | No | — | A comma-separated list of fields to expand in the response. Supported fields are explained above. |
launchdarkly_workflows_get_approval_request_settings
Get approval request settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
environmentKey | string | No | — | An environment key filter to apply to the approval request settings. |
resourceKind | string | No | — | A resource kind filter to apply to the approval request settings. |
expand | string | No | — | A comma-separated list of fields to expand in the response. Options include ‘default’ and ‘strict’. |
launchdarkly_workflows_get_approval_requests
List approval requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field operator value. Supported fields are explained above. |
expand | string | No | — | A comma-separated list of fields to expand in the response. Supported fields are explained above. |
limit | integer | No | — | The number of approvals to return. Defaults to 20. Maximum limit is 200. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_workflows_get_approvals_for_flag
List approval requests for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_workflows_get_custom_workflow
Get custom workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
workflowId | string | Yes | — | The workflow ID |
launchdarkly_workflows_get_release_by_flag_key
Get release for flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The flag key |
launchdarkly_workflows_get_release_pipeline_by_key
Get release pipeline by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
pipelineKey | string | Yes | — | The release pipeline key |
launchdarkly_workflows_get_release_policies
List release policies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
excludeDefault | boolean | No | — | When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present. |
launchdarkly_workflows_get_release_policy
Get a release policy by key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
policyKey | string | Yes | — | The release policy key |
launchdarkly_workflows_get_workflow_templates
Get workflow templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
summary | boolean | No | — | Whether the entire template object or just a summary should be returned |
search | string | No | — | The substring in either the name or description of a template |
launchdarkly_workflows_get_workflows
Get workflows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
status | string | No | — | Filter results by workflow status. Valid status filters are active, completed, and failed. |
sort | string | No | — | A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by creationDate or stopDate. |
limit | integer | No | — | The maximum number of workflows to return. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
launchdarkly_workflows_patch_approval_request
Update approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The approval ID |
comment | string | No | — | Optional comment describing the update |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_workflows_patch_approval_request_settings
Update approval request settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | Project Key |
autoApplyApprovedChanges | boolean | No | — | Automatically apply changes that have been approved by all reviewers. This field is only applicable for approval services other than LaunchDarkly. |
bypassApprovalsForPendingChanges | boolean | No | — | Whether to skip approvals for pending changes |
canApplyDeclinedChanges | boolean | No | — | Allow applying the change as long as at least one person has approved |
canReviewOwnRequest | boolean | No | — | Allow someone who makes an approval request to apply their own change |
environmentKey | string | Yes | — | Environment Key |
minNumApprovals | integer | No | — | Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five. |
required | boolean | No | — | If approvals are required for this environment |
requiredApprovalTags | string[] | No | — | Require approval only on flags with the provided tags. Otherwise all flags will require approval. |
resourceKind | string | Yes | — | Resource Kind |
serviceConfig | object | No | — | Arbitrary service-specific configuration |
serviceKind | string | No | — | Which service to use for managing approvals |
serviceKindConfigurationId | string | No | — | Optional integration configuration ID of a custom approval integration. This is an Enterprise-only feature. |
launchdarkly_workflows_patch_flag_config_approval_request
Update flag approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The approval ID |
launchdarkly_workflows_patch_release_by_flag_key
Patch release for flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The flag key |
body | object[] | Yes | — | Request body |
launchdarkly_workflows_post_approval_request
Create approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment | string | No | — | Optional comment describing the approval request |
description | string | Yes | — | A brief description of the changes you’re requesting |
instructions | object[] | Yes | — | The instructions value |
integrationConfig | object | No | — | Integration Config |
notifyMemberIds | string[] | No | — | An array of member IDs. These members are notified to review the approval request. |
notifyTeamKeys | string[] | No | — | An array of team keys. The members of these teams are notified to review the approval request. |
resourceId | string | Yes | — | String representation of the resource specifier |
launchdarkly_workflows_post_approval_request_apply
Apply approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The approval request ID |
comment | string | No | — | Optional comment about the approval request |
launchdarkly_workflows_post_approval_request_apply_for_flag
Apply approval request for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The feature flag approval request ID |
comment | string | No | — | Optional comment about the approval request |
launchdarkly_workflows_post_approval_request_for_flag
Create approval request for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
comment | string | No | — | Optional comment describing the approval request |
description | string | Yes | — | A brief description of the changes you’re requesting |
executionDate | integer | No | — | Execution Date |
instructions | object[] | Yes | — | The instructions value |
integrationConfig | object | No | — | Integration Config |
notifyMemberIds | string[] | No | — | An array of member IDs. These members are notified to review the approval request. |
notifyTeamKeys | string[] | No | — | An array of team keys. The members of these teams are notified to review the approval request. |
operatingOnId | string | No | — | The ID of a scheduled change. Include this if your <code>instructions</code> include editing or deleting a scheduled change. |
launchdarkly_workflows_post_approval_request_review
Review approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The approval request ID |
comment | string | No | — | Optional comment about the approval request |
kind | string | No | — | The type of review for this approval request |
launchdarkly_workflows_post_approval_request_review_for_flag
Review approval request for a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The feature flag approval request ID |
comment | string | No | — | Optional comment about the approval request |
kind | string | No | — | The type of review for this approval request |
launchdarkly_workflows_post_flag_copy_config_approval_request
Create approval request to copy flag configurations across environments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key for the target environment |
comment | string | No | — | Optional comment describing the approval request |
description | string | Yes | — | A brief description of your changes |
excludedActions | string[] | No | — | Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If neither are included, then all flag changes will be copied. |
includedActions | string[] | No | — | Optional list of the flag changes to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If neither are included, then all flag changes will be copied. |
notifyMemberIds | string[] | No | — | An array of member IDs. These members are notified to review the approval request. |
notifyTeamKeys | string[] | No | — | An array of team keys. The members of these teams are notified to review the approval request. |
source | object | Yes | — | The source value |
launchdarkly_workflows_post_release_pipeline
Create a release pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
description | string | No | — | The release pipeline description |
isLegacy | boolean | No | — | Whether or not the pipeline is enabled for Release Automation. |
isProjectDefault | boolean | No | — | Whether or not the newly created pipeline should be set as the default pipeline for this project |
key | string | Yes | — | The unique identifier of this release pipeline |
name | string | Yes | — | The name of the release pipeline |
phases | object[] | Yes | — | A logical grouping of one or more environments that share attributes for rolling out changes |
tags | string[] | No | — | A list of tags for this release pipeline |
launchdarkly_workflows_post_release_policies_order
Update the order of existing release policies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
body | string[] | Yes | — | Array of release policy keys in the desired rank order (scoped policies only). These keys must include all of the scoped release policies for the project. |
launchdarkly_workflows_post_release_policy
Create a release policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
guardedReleaseConfig | object | No | — | Configuration for guarded releases |
key | string | Yes | — | The human-readable key of the release policy |
name | string | Yes | — | The name of the release policy |
progressiveReleaseConfig | object | No | — | Configuration for progressive releases |
releaseMethod | string | Yes | — | The release method for this policy |
scope | object | No | — | The scope value |
launchdarkly_workflows_post_workflow
Create workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateKey | string | No | — | The template key to apply as a starting point for the new workflow |
dryRun | boolean | No | — | Whether to call the endpoint in dry-run mode |
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
description | string | No | — | The workflow description |
maintainerId | string | No | — | Maintainer Id |
name | string | Yes | — | The workflow name |
stages | object[] | No | — | A list of the workflow stages |
launchdarkly_workflows_put_release_pipeline
Update a release pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
pipelineKey | string | Yes | — | The release pipeline key |
description | string | No | — | The release pipeline description |
name | string | Yes | — | The name of the release pipeline |
phases | object[] | Yes | — | A logical grouping of one or more environments that share attributes for rolling out changes |
tags | string[] | No | — | A list of tags for this release pipeline |
launchdarkly_workflows_put_release_policy
Update a release policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
policyKey | string | Yes | — | The human-readable key of the release policy |
guardedReleaseConfig | object | No | — | Configuration for guarded releases |
name | string | Yes | — | The name of the release policy |
progressiveReleaseConfig | object | No | — | Configuration for progressive releases |
releaseMethod | string | Yes | — | The release method for this policy |
scope | object | No | — | The scope value |
launchdarkly_workflows_update_phase_status
Update phase status for release Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The flag key |
phaseId | string | Yes | — | The phase ID |
audiences | object[] | No | — | Extra configuration for audiences required upon phase initialization. |
status | string | No | — | The status value |

