> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # launchdarkly-workflows > LaunchDarkly Workflows — approvals, workflows, releases, and pipelines **Server path:** `/launchdarkly-workflows` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [`launchdarkly_workflows_create_release_for_flag`](#launchdarkly_workflows_create_release_for_flag) | Create a new release for flag | | [`launchdarkly_workflows_create_workflow_template`](#launchdarkly_workflows_create_workflow_template) | Create workflow template | | [`launchdarkly_workflows_delete_approval_request`](#launchdarkly_workflows_delete_approval_request) | Delete approval request | | [`launchdarkly_workflows_delete_approval_request_for_flag`](#launchdarkly_workflows_delete_approval_request_for_flag) | Delete approval request for a flag | | [`launchdarkly_workflows_delete_release_by_flag_key`](#launchdarkly_workflows_delete_release_by_flag_key) | Delete a release for flag | | [`launchdarkly_workflows_delete_release_pipeline`](#launchdarkly_workflows_delete_release_pipeline) | Delete release pipeline | | [`launchdarkly_workflows_delete_release_policy`](#launchdarkly_workflows_delete_release_policy) | Delete a release policy | | [`launchdarkly_workflows_delete_workflow`](#launchdarkly_workflows_delete_workflow) | Delete workflow | | [`launchdarkly_workflows_delete_workflow_template`](#launchdarkly_workflows_delete_workflow_template) | Delete workflow template | | [`launchdarkly_workflows_get_all_release_pipelines`](#launchdarkly_workflows_get_all_release_pipelines) | Get all release pipelines | | [`launchdarkly_workflows_get_all_release_progressions_for_release_pipeline`](#launchdarkly_workflows_get_all_release_progressions_for_release_pipeline) | Get release progressions for release pipeline | | [`launchdarkly_workflows_get_approval_for_flag`](#launchdarkly_workflows_get_approval_for_flag) | Get approval request for a flag | | [`launchdarkly_workflows_get_approval_request`](#launchdarkly_workflows_get_approval_request) | Get approval request | | [`launchdarkly_workflows_get_approval_request_settings`](#launchdarkly_workflows_get_approval_request_settings) | Get approval request settings | | [`launchdarkly_workflows_get_approval_requests`](#launchdarkly_workflows_get_approval_requests) | List approval requests | | [`launchdarkly_workflows_get_approvals_for_flag`](#launchdarkly_workflows_get_approvals_for_flag) | List approval requests for a flag | | [`launchdarkly_workflows_get_custom_workflow`](#launchdarkly_workflows_get_custom_workflow) | Get custom workflow | | [`launchdarkly_workflows_get_release_by_flag_key`](#launchdarkly_workflows_get_release_by_flag_key) | Get release for flag | | [`launchdarkly_workflows_get_release_pipeline_by_key`](#launchdarkly_workflows_get_release_pipeline_by_key) | Get release pipeline by key | | [`launchdarkly_workflows_get_release_policies`](#launchdarkly_workflows_get_release_policies) | List release policies | | [`launchdarkly_workflows_get_release_policy`](#launchdarkly_workflows_get_release_policy) | Get a release policy by key | | [`launchdarkly_workflows_get_workflow_templates`](#launchdarkly_workflows_get_workflow_templates) | Get workflow templates | | [`launchdarkly_workflows_get_workflows`](#launchdarkly_workflows_get_workflows) | Get workflows | | [`launchdarkly_workflows_patch_approval_request`](#launchdarkly_workflows_patch_approval_request) | Update approval request | | [`launchdarkly_workflows_patch_approval_request_settings`](#launchdarkly_workflows_patch_approval_request_settings) | Update approval request settings | | [`launchdarkly_workflows_patch_flag_config_approval_request`](#launchdarkly_workflows_patch_flag_config_approval_request) | Update flag approval request | | [`launchdarkly_workflows_patch_release_by_flag_key`](#launchdarkly_workflows_patch_release_by_flag_key) | Patch release for flag | | [`launchdarkly_workflows_post_approval_request`](#launchdarkly_workflows_post_approval_request) | Create approval request | | [`launchdarkly_workflows_post_approval_request_apply`](#launchdarkly_workflows_post_approval_request_apply) | Apply approval request | | [`launchdarkly_workflows_post_approval_request_apply_for_flag`](#launchdarkly_workflows_post_approval_request_apply_for_flag) | Apply approval request for a flag | | [`launchdarkly_workflows_post_approval_request_for_flag`](#launchdarkly_workflows_post_approval_request_for_flag) | Create approval request for a flag | | [`launchdarkly_workflows_post_approval_request_review`](#launchdarkly_workflows_post_approval_request_review) | Review approval request | | [`launchdarkly_workflows_post_approval_request_review_for_flag`](#launchdarkly_workflows_post_approval_request_review_for_flag) | Review approval request for a flag | | [`launchdarkly_workflows_post_flag_copy_config_approval_request`](#launchdarkly_workflows_post_flag_copy_config_approval_request) | Create approval request to copy flag configurations across environments | | [`launchdarkly_workflows_post_release_pipeline`](#launchdarkly_workflows_post_release_pipeline) | Create a release pipeline | | [`launchdarkly_workflows_post_release_policies_order`](#launchdarkly_workflows_post_release_policies_order) | Update the order of existing release policies | | [`launchdarkly_workflows_post_release_policy`](#launchdarkly_workflows_post_release_policy) | Create a release policy | | [`launchdarkly_workflows_post_workflow`](#launchdarkly_workflows_post_workflow) | Create workflow | | [`launchdarkly_workflows_put_release_pipeline`](#launchdarkly_workflows_put_release_pipeline) | Update a release pipeline | | [`launchdarkly_workflows_put_release_policy`](#launchdarkly_workflows_put_release_policy) | Update a release policy | | [`launchdarkly_workflows_update_phase_status`](#launchdarkly_workflows_update_phase_status) | Update phase status for release | *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "flagKey": { "type": "string", "description": "The flag key" }, "releasePipelineKey": { "type": "string", "description": "The key of the release pipeline to attach the flag to" }, "releaseVariationId": { "type": "string", "description": "The variation id to release to across all phases" } }, "required": [ "PCID", "projectKey", "flagKey", "releasePipelineKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description value" }, "environmentKey": { "type": "string", "description": "Environment Key" }, "flagKey": { "type": "string", "description": "Flag Key" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "string", "description": "The name value" }, "projectKey": { "type": "string", "description": "Project Key" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The stage name" }, "executeConditionsInSequence": { "type": "boolean", "description": "Whether to execute the conditions in sequence for the given stage" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "scheduleKind": { "type": "string" }, "executionDate": { "type": "integer" }, "waitDuration": { "type": "integer", "description": "For workflow stages whose scheduled execution is relative, how far in the future the stage should start." }, "waitDurationUnit": { "type": "string" }, "executeNow": { "type": "boolean", "description": "Whether the workflow stage should be executed immediately" }, "description": { "type": "string", "description": "A description of the approval required for this stage" }, "notifyMemberIds": { "type": "array", "description": "A list of member IDs for the members to request approval from for this stage" }, "notifyTeamKeys": { "type": "array", "description": "A list of team keys for the teams to request approval from for this stage" }, "integrationConfig": { "type": "object" }, "kind": { "type": "string" } } }, "description": "An array of conditions for the stage" }, "action": { "type": "object", "description": "The action value" } } }, "description": "The stages value" }, "workflowId": { "type": "string", "description": "Workflow Id" } }, "required": [ "PCID", "key" ] } ``` *** ## launchdarkly\_workflows\_delete\_approval\_request Delete approval request **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------- | | `id` | string | Yes | — | The approval request ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The approval request ID" } }, "required": [ "PCID", "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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "id": { "type": "string", "description": "The feature flag approval request ID" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "flagKey": { "type": "string", "description": "The flag key" } }, "required": [ "PCID", "projectKey", "flagKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "pipelineKey": { "type": "string", "description": "The release pipeline key" } }, "required": [ "PCID", "projectKey", "pipelineKey" ] } ``` *** ## launchdarkly\_workflows\_delete\_release\_policy Delete a release policy **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `projectKey` | string | Yes | — | The project key | | `policyKey` | string | Yes | — | The human-readable key of the release policy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "policyKey": { "type": "string", "description": "The human-readable key of the release policy" } }, "required": [ "PCID", "LD-API-Version", "projectKey", "policyKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "workflowId": { "type": "string", "description": "The workflow id" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "workflowId" ] } ``` *** ## launchdarkly\_workflows\_delete\_workflow\_template Delete workflow template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ---------------- | | `templateKey` | string | Yes | — | The template key | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateKey": { "type": "string", "description": "The template key" } }, "required": [ "PCID", "templateKey" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "filter": { "type": "string", "description": "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": { "type": "integer", "description": "The maximum number of items to return. Defaults to 20." }, "offset": { "type": "integer", "description": "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`." } }, "required": [ "PCID", "projectKey" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "pipelineKey": { "type": "string", "description": "The pipeline key" }, "filter": { "type": "string", "description": "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": { "type": "integer", "description": "The maximum number of items to return. Defaults to 20." }, "offset": { "type": "integer", "description": "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`." } }, "required": [ "PCID", "projectKey", "pipelineKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "id": { "type": "string", "description": "The feature flag approval request ID" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The approval request ID" }, "expand": { "type": "string", "description": "A comma-separated list of fields to expand in the response. Supported fields are explained above." } }, "required": [ "PCID", "id" ] } ``` *** ## launchdarkly\_workflows\_get\_approval\_request\_settings Get approval request settings **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `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'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "Project Key" }, "environmentKey": { "type": "string", "description": "An environment key filter to apply to the approval request settings." }, "resourceKind": { "type": "string", "description": "A resource kind filter to apply to the approval request settings." }, "expand": { "type": "string", "description": "A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'." } }, "required": [ "PCID", "LD-API-Version", "projectKey" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "string", "description": "A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above." }, "expand": { "type": "string", "description": "A comma-separated list of fields to expand in the response. Supported fields are explained above." }, "limit": { "type": "integer", "description": "The number of approvals to return. Defaults to 20. Maximum limit is 200." }, "offset": { "type": "integer", "description": "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`." } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "workflowId": { "type": "string", "description": "The workflow ID" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "workflowId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "flagKey": { "type": "string", "description": "The flag key" } }, "required": [ "PCID", "projectKey", "flagKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "pipelineKey": { "type": "string", "description": "The release pipeline key" } }, "required": [ "PCID", "projectKey", "pipelineKey" ] } ``` *** ## launchdarkly\_workflows\_get\_release\_policies List release policies **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "excludeDefault": { "type": "boolean", "description": "When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present." } }, "required": [ "PCID", "LD-API-Version", "projectKey" ] } ``` *** ## launchdarkly\_workflows\_get\_release\_policy Get a release policy by key **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------ | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `projectKey` | string | Yes | — | The project key | | `policyKey` | string | Yes | — | The release policy key | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "policyKey": { "type": "string", "description": "The release policy key" } }, "required": [ "PCID", "LD-API-Version", "projectKey", "policyKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "summary": { "type": "boolean", "description": "Whether the entire template object or just a summary should be returned" }, "search": { "type": "string", "description": "The substring in either the name or description of a template" } }, "required": [ "PCID" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "status": { "type": "string", "description": "Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`." }, "sort": { "type": "string", "description": "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": { "type": "integer", "description": "The maximum number of workflows to return. Defaults to 20." }, "offset": { "type": "integer", "description": "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`." } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The approval ID" }, "comment": { "type": "string", "description": "Optional comment describing the update" }, "instructions": { "type": "array", "items": { "type": "object" }, "description": "The instructions value" } }, "required": [ "PCID", "id", "instructions" ] } ``` *** ## launchdarkly\_workflows\_patch\_approval\_request\_settings Update approval request settings **Parameters:** | Parameter | Type | Required | Default | Description | | | ---------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | | `projectKey` | string | Yes | — | Project Key | | | `autoApplyApprovedChanges` | boolean | null | 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 | null | No | — | Optional integration configuration ID of a custom approval integration. This is an Enterprise-only feature. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "Project Key" }, "autoApplyApprovedChanges": { "type": [ "boolean", "null" ], "description": "Automatically apply changes that have been approved by all reviewers. This field is only applicable for approval services other than LaunchDarkly." }, "bypassApprovalsForPendingChanges": { "type": "boolean", "description": "Whether to skip approvals for pending changes" }, "canApplyDeclinedChanges": { "type": "boolean", "description": "Allow applying the change as long as at least one person has approved" }, "canReviewOwnRequest": { "type": "boolean", "description": "Allow someone who makes an approval request to apply their own change" }, "environmentKey": { "type": "string", "description": "Environment Key" }, "minNumApprovals": { "type": "integer", "description": "Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five." }, "required": { "type": "boolean", "description": "If approvals are required for this environment" }, "requiredApprovalTags": { "type": "array", "items": { "type": "string" }, "description": "Require approval only on flags with the provided tags. Otherwise all flags will require approval." }, "resourceKind": { "type": "string", "description": "Resource Kind" }, "serviceConfig": { "type": "object", "description": "Arbitrary service-specific configuration" }, "serviceKind": { "type": "string", "description": "Which service to use for managing approvals" }, "serviceKindConfigurationId": { "type": [ "string", "null" ], "description": "Optional integration configuration ID of a custom approval integration. This is an Enterprise-only feature." } }, "required": [ "PCID", "LD-API-Version", "projectKey", "environmentKey", "resourceKind" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "id": { "type": "string", "description": "The approval ID" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "flagKey": { "type": "string", "description": "The flag key" }, "body": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "description": "The type of operation to perform" }, "path": { "type": "string", "description": "A JSON Pointer string specifying the part of the document to operate on" }, "value": { "description": "A JSON value used in \"add\", \"replace\", and \"test\" operations" } }, "required": [ "op", "path" ] }, "description": "Request body" } }, "required": [ "PCID", "projectKey", "flagKey", "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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment": { "type": "string", "description": "Optional comment describing the approval request" }, "description": { "type": "string", "description": "A brief description of the changes you're requesting" }, "instructions": { "type": "array", "items": { "type": "object" }, "description": "The instructions value" }, "integrationConfig": { "type": "object", "description": "Integration Config" }, "notifyMemberIds": { "type": "array", "items": { "type": "string" }, "description": "An array of member IDs. These members are notified to review the approval request." }, "notifyTeamKeys": { "type": "array", "items": { "type": "string" }, "description": "An array of team keys. The members of these teams are notified to review the approval request." }, "resourceId": { "type": "string", "description": "String representation of the resource specifier" } }, "required": [ "PCID", "description", "instructions", "resourceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The approval request ID" }, "comment": { "type": "string", "description": "Optional comment about the approval request" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "id": { "type": "string", "description": "The feature flag approval request ID" }, "comment": { "type": "string", "description": "Optional comment about the approval request" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "id" ] } ``` *** ## 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 \instructions\ include editing or deleting a scheduled change. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "comment": { "type": "string", "description": "Optional comment describing the approval request" }, "description": { "type": "string", "description": "A brief description of the changes you're requesting" }, "executionDate": { "type": "integer", "description": "Execution Date" }, "instructions": { "type": "array", "items": { "type": "object" }, "description": "The instructions value" }, "integrationConfig": { "type": "object", "description": "Integration Config" }, "notifyMemberIds": { "type": "array", "items": { "type": "string" }, "description": "An array of member IDs. These members are notified to review the approval request." }, "notifyTeamKeys": { "type": "array", "items": { "type": "string" }, "description": "An array of team keys. The members of these teams are notified to review the approval request." }, "operatingOnId": { "type": "string", "description": "The ID of a scheduled change. Include this if your instructions include editing or deleting a scheduled change." } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "description", "instructions" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The approval request ID" }, "comment": { "type": "string", "description": "Optional comment about the approval request" }, "kind": { "type": "string", "description": "The type of review for this approval request", "enum": [ "approve", "comment", "decline" ] } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "id": { "type": "string", "description": "The feature flag approval request ID" }, "comment": { "type": "string", "description": "Optional comment about the approval request" }, "kind": { "type": "string", "description": "The type of review for this approval request", "enum": [ "approve", "comment", "decline" ] } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "id" ] } ``` *** ## 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 \includedActions\ or \excludedActions\, 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 \includedActions\ or \excludedActions\, 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key for the target environment" }, "comment": { "type": "string", "description": "Optional comment describing the approval request" }, "description": { "type": "string", "description": "A brief description of your changes" }, "excludedActions": { "type": "array", "items": { "type": "string", "enum": [ "updateOn", "updateFallthrough", "updateOffVariation", "updateRules", "updateTargets", "updatePrerequisites" ] }, "description": "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." }, "includedActions": { "type": "array", "items": { "type": "string", "enum": [ "updateOn", "updateFallthrough", "updateOffVariation", "updateRules", "updateTargets", "updatePrerequisites" ] }, "description": "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." }, "notifyMemberIds": { "type": "array", "items": { "type": "string" }, "description": "An array of member IDs. These members are notified to review the approval request." }, "notifyTeamKeys": { "type": "array", "items": { "type": "string" }, "description": "An array of team keys. The members of these teams are notified to review the approval request." }, "source": { "type": "object", "description": "The source value", "properties": { "key": { "type": "string", "description": "The environment key for the source environment" }, "version": { "type": "integer", "description": "The version of the source flag from which to copy" } }, "required": [ "key" ] } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "description", "source" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "description": { "type": "string", "description": "The release pipeline description" }, "isLegacy": { "type": "boolean", "description": "Whether or not the pipeline is enabled for Release Automation." }, "isProjectDefault": { "type": "boolean", "description": "Whether or not the newly created pipeline should be set as the default pipeline for this project" }, "key": { "type": "string", "description": "The unique identifier of this release pipeline" }, "name": { "type": "string", "description": "The name of the release pipeline" }, "phases": { "type": "array", "items": { "type": "object", "properties": { "audiences": { "type": "array", "items": { "type": "object", "properties": { "environmentKey": { "type": "string", "description": "A project-unique key for the environment." }, "name": { "type": "string", "description": "The audience name" }, "segmentKeys": { "type": "array", "description": "Segments targeted by this audience." }, "configuration": { "type": "object" } } }, "description": "An ordered list of the audiences for this release phase. Each audience corresponds to a LaunchDarkly environment." }, "name": { "type": "string", "description": "The release phase name" }, "configuration": { "type": "object", "description": "The configuration value" } }, "required": [ "audiences", "name" ] }, "description": "A logical grouping of one or more environments that share attributes for rolling out changes" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "A list of tags for this release pipeline" } }, "required": [ "PCID", "projectKey", "key", "name", "phases" ] } ``` *** ## launchdarkly\_workflows\_post\_release\_policies\_order Update the order of existing release policies **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "body": { "type": "array", "items": { "type": "string" }, "description": "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." } }, "required": [ "PCID", "LD-API-Version", "projectKey", "body" ] } ``` *** ## launchdarkly\_workflows\_post\_release\_policy Create a release policy **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------ | -------- | ------- | -------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "guardedReleaseConfig": { "type": "object", "description": "Configuration for guarded releases", "properties": { "rolloutContextKindKey": { "type": "string", "description": "Context kind key to use as the randomization unit for the rollout" }, "minSampleSize": { "type": "integer", "description": "The minimum number of samples required to make a decision" }, "rollbackOnRegression": { "type": "boolean", "description": "Whether to roll back on regression" }, "metricKeys": { "type": "array", "items": { "type": "string" }, "description": "List of metric keys" }, "metricGroupKeys": { "type": "array", "items": { "type": "string" }, "description": "List of metric group keys" }, "stages": { "type": "array", "items": { "type": "object" }, "description": "List of stages" } } }, "key": { "type": "string", "description": "The human-readable key of the release policy" }, "name": { "type": "string", "description": "The name of the release policy" }, "progressiveReleaseConfig": { "type": "object", "description": "Configuration for progressive releases", "properties": { "rolloutContextKindKey": { "type": "string", "description": "Context kind key to use as the randomization unit for the rollout" }, "stages": { "type": "array", "items": { "type": "object" }, "description": "List of stages" } } }, "releaseMethod": { "type": "string", "description": "The release method for this policy", "enum": [ "guarded-release", "progressive-release" ] }, "scope": { "type": "object", "description": "The scope value", "properties": { "environmentKeys": { "type": "array", "items": { "type": "string" }, "description": "List of environment keys this policy applies to" }, "flagTagKeys": { "type": "array", "items": { "type": "string" }, "description": "List of flag tag keys this policy applies to" } } } }, "required": [ "PCID", "LD-API-Version", "projectKey", "key", "name", "releaseMethod" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateKey": { "type": "string", "description": "The template key to apply as a starting point for the new workflow" }, "dryRun": { "type": "boolean", "description": "Whether to call the endpoint in dry-run mode" }, "projectKey": { "type": "string", "description": "The project key" }, "featureFlagKey": { "type": "string", "description": "The feature flag key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "description": { "type": "string", "description": "The workflow description" }, "maintainerId": { "type": "string", "description": "Maintainer Id" }, "name": { "type": "string", "description": "The workflow name" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The stage name" }, "executeConditionsInSequence": { "type": "boolean", "description": "Whether to execute the conditions in sequence for the given stage" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "scheduleKind": { "type": "string" }, "executionDate": { "type": "integer" }, "waitDuration": { "type": "integer", "description": "For workflow stages whose scheduled execution is relative, how far in the future the stage should start." }, "waitDurationUnit": { "type": "string" }, "executeNow": { "type": "boolean", "description": "Whether the workflow stage should be executed immediately" }, "description": { "type": "string", "description": "A description of the approval required for this stage" }, "notifyMemberIds": { "type": "array", "description": "A list of member IDs for the members to request approval from for this stage" }, "notifyTeamKeys": { "type": "array", "description": "A list of team keys for the teams to request approval from for this stage" }, "integrationConfig": { "type": "object" }, "kind": { "type": "string" } } }, "description": "An array of conditions for the stage" }, "action": { "type": "object", "description": "The action value" } } }, "description": "A list of the workflow stages" } }, "required": [ "PCID", "projectKey", "featureFlagKey", "environmentKey", "name" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "pipelineKey": { "type": "string", "description": "The release pipeline key" }, "description": { "type": "string", "description": "The release pipeline description" }, "name": { "type": "string", "description": "The name of the release pipeline" }, "phases": { "type": "array", "items": { "type": "object", "properties": { "audiences": { "type": "array", "items": { "type": "object", "properties": { "environmentKey": { "type": "string", "description": "A project-unique key for the environment." }, "name": { "type": "string", "description": "The audience name" }, "segmentKeys": { "type": "array", "description": "Segments targeted by this audience." }, "configuration": { "type": "object" } } }, "description": "An ordered list of the audiences for this release phase. Each audience corresponds to a LaunchDarkly environment." }, "name": { "type": "string", "description": "The release phase name" }, "configuration": { "type": "object", "description": "The configuration value" } }, "required": [ "audiences", "name" ] }, "description": "A logical grouping of one or more environments that share attributes for rolling out changes" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "A list of tags for this release pipeline" } }, "required": [ "PCID", "projectKey", "pipelineKey", "name", "phases" ] } ``` *** ## launchdarkly\_workflows\_put\_release\_policy Update a release policy **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------ | -------- | ------- | -------------------------------------------- | | `LD-API-Version` | string | Yes | — | Version of the endpoint. | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "LD-API-Version": { "type": "string", "description": "Version of the endpoint.", "enum": [ "beta" ] }, "projectKey": { "type": "string", "description": "The project key" }, "policyKey": { "type": "string", "description": "The human-readable key of the release policy" }, "guardedReleaseConfig": { "type": "object", "description": "Configuration for guarded releases", "properties": { "rolloutContextKindKey": { "type": "string", "description": "Context kind key to use as the randomization unit for the rollout" }, "minSampleSize": { "type": "integer", "description": "The minimum number of samples required to make a decision" }, "rollbackOnRegression": { "type": "boolean", "description": "Whether to roll back on regression" }, "metricKeys": { "type": "array", "items": { "type": "string" }, "description": "List of metric keys" }, "metricGroupKeys": { "type": "array", "items": { "type": "string" }, "description": "List of metric group keys" }, "stages": { "type": "array", "items": { "type": "object" }, "description": "List of stages" } } }, "name": { "type": "string", "description": "The name of the release policy" }, "progressiveReleaseConfig": { "type": "object", "description": "Configuration for progressive releases", "properties": { "rolloutContextKindKey": { "type": "string", "description": "Context kind key to use as the randomization unit for the rollout" }, "stages": { "type": "array", "items": { "type": "object" }, "description": "List of stages" } } }, "releaseMethod": { "type": "string", "description": "The release method for this policy", "enum": [ "guarded-release", "progressive-release" ] }, "scope": { "type": "object", "description": "The scope value", "properties": { "environmentKeys": { "type": "array", "items": { "type": "string" }, "description": "List of environment keys this policy applies to" }, "flagTagKeys": { "type": "array", "items": { "type": "string" }, "description": "List of flag tag keys this policy applies to" } } } }, "required": [ "PCID", "LD-API-Version", "projectKey", "policyKey", "name", "releaseMethod" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "flagKey": { "type": "string", "description": "The flag key" }, "phaseId": { "type": "string", "description": "The phase ID" }, "audiences": { "type": "array", "items": { "type": "object", "properties": { "audienceId": { "type": "string", "description": "UUID of the audience." }, "releaseGuardianConfiguration": { "type": "object", "description": "Release Guardian Configuration" }, "notifyMemberIds": { "type": "array", "items": { "type": "string" }, "description": "An array of member IDs. These members are notified to review the approval request." }, "notifyTeamKeys": { "type": "array", "items": { "type": "string" }, "description": "An array of team keys. The members of these teams are notified to review the approval request." } } }, "description": "Extra configuration for audiences required upon phase initialization." }, "status": { "type": "string", "description": "The status value" } }, "required": [ "PCID", "projectKey", "flagKey", "phaseId" ] } ```