Release pipelines (beta)

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. Use this header with each call. To learn more, read Beta resources.

Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.

Release pipelines standardize the release process for feature flags across a series of phases, where each phase consists of one or more environments. When you add a flag to a release pipeline, you create a "release" to automate that flag's progress through the pipeline.

You can use release pipelines to ensure that you correctly roll out the flag in each environment before moving on to the next. A release can use an immediate or guarded rollout to a designated audience, and can require approvals for selected environments. You can also use release pipelines to view the status of ongoing releases across all flags within a project, enforcing a standardized process and ensuring they are following best practices. To learn more, read Release pipelines.

With the release pipelines API, you can view, create, update, and delete release pipelines.

With the related releases API, you can view and update the active releases for a given flag.

To add a feature flag to an existing release pipeline, use the Update feature flag endpoint.

Get all release pipelines

Get all release pipelines for a project.

Filtering release pipelines

LaunchDarkly supports the following fields for filters:

query is a string that matches against the release pipeline key, name, and description. It is not case sensitive. For example: ?filter=query:examplePipeline.
env is a string that matches an environment key. For example: ?filter=env:production.

Request

path Parameters

projectKey

required

string <string>

The project key

query Parameters

filter	string <string> 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 <int64> The maximum number of items to return. Defaults to 20.
offset	integer <int64> 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`.

Responses

200

Release pipeline collection

404

Invalid resource identifier

get/api/v2/projects/{projectKey}/release-pipelines

Request samples

curl
Node.js
Python

Response samples

application/json

{"items": [{"createdAt": "1684262711507",
"description": "Standard pipeline to roll out to production",
"key": "standard-pipeline",
"name": "Standard Pipeline",
"phases": [{"id": "1234a56b7c89d012345e678f",
"audiences": [{"environment": {"_links": { },
"key": null,
"name": null,
"color": null
},
"name": "Phase 1 - Testing",
"configuration": {"releaseStrategy": null,
"requireApproval": null,
"notifyMemberIds": [ ],
"notifyTeamKeys": [ ],
"releaseGuardianConfiguration": null
},
"segmentKeys": ["segment-key-123abc"
]
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
],
"_version": 1,
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": [null
],
"actions": ["*"
],
"notActions": [null
],
"effect": "allow",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": [null
],
"actions": ["*"
],
"notActions": [null
],
"effect": "allow",
"role_name": "string"
}
}
]
},
"isProjectDefault": true,
"_isLegacy": true
}
],
"totalCount": 1
}

Create a release pipeline

Creates a new release pipeline.

The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the Update project API to set the defaultReleasePipelineKey.

You can create up to 20 release pipelines per project.

Request

path Parameters

projectKey

required

string <string>

The project key

Request Body schema: application/json
required

description	string The release pipeline description
key required	string The unique identifier of this release pipeline
name required	string The name of the release pipeline
required	Array of objects (CreatePhaseInput) A logical grouping of one or more environments that share attributes for rolling out changes
tags	Array of strings A list of tags for this release pipeline
isProjectDefault	boolean Whether or not the newly created pipeline should be set as the default pipeline for this project
isLegacy	boolean Whether or not the pipeline is enabled for Release Automation.

Responses

201

Release pipeline response

400

Invalid request

403

Forbidden

404

Invalid resource identifier

409

Status conflict

post/api/v2/projects/{projectKey}/release-pipelines

Request samples

Payload
curl
Node.js
Python

application/json

{"description": "Standard pipeline to roll out to production",
"key": "standard-pipeline",
"name": "Standard Pipeline",
"phases": [{"audiences": [{"environmentKey": "string",
"name": "string",
"segmentKeys": ["string"
],
"configuration": {"releaseStrategy": "string",
"requireApproval": true,
"notifyMemberIds": ["1234a56b7c89d012345e678f"
],
"notifyTeamKeys": ["example-reviewer-team"
],
"releaseGuardianConfiguration": {"monitoringWindowMilliseconds": 60000,
"rolloutWeight": 50,
"rollbackOnRegression": true,
"randomizationUnit": "user"
}
}
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
],
"isProjectDefault": true,
"isLegacy": true
}

Response samples

application/json

{"createdAt": "1684262711507",
"description": "Standard pipeline to roll out to production",
"key": "standard-pipeline",
"name": "Standard Pipeline",
"phases": [{"id": "1234a56b7c89d012345e678f",
"audiences": [{"environment": {"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"key": "environment-key-123abc",
"name": "My Environment",
"color": "F5A623"
},
"name": "Phase 1 - Testing",
"configuration": {"releaseStrategy": "string",
"requireApproval": true,
"notifyMemberIds": ["1234a56b7c89d012345e678f"
],
"notifyTeamKeys": ["example-reviewer-team"
],
"releaseGuardianConfiguration": {"monitoringWindowMilliseconds": 60000,
"rolloutWeight": 50,
"rollbackOnRegression": true,
"randomizationUnit": "user"
}
},
"segmentKeys": ["segment-key-123abc"
]
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
],
"_version": 1,
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
]
},
"isProjectDefault": true,
"_isLegacy": true
}

Get release pipeline by key

Get a release pipeline by key

Request

path Parameters

projectKey required	string <string> The project key
pipelineKey required	string <string> The release pipeline key

Responses

200

Release pipeline response

404

Invalid resource identifier

get/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}

Request samples

curl
Node.js
Python

Response samples

application/json

{"createdAt": "1684262711507",
"description": "Standard pipeline to roll out to production",
"key": "standard-pipeline",
"name": "Standard Pipeline",
"phases": [{"id": "1234a56b7c89d012345e678f",
"audiences": [{"environment": {"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"key": "environment-key-123abc",
"name": "My Environment",
"color": "F5A623"
},
"name": "Phase 1 - Testing",
"configuration": {"releaseStrategy": "string",
"requireApproval": true,
"notifyMemberIds": ["1234a56b7c89d012345e678f"
],
"notifyTeamKeys": ["example-reviewer-team"
],
"releaseGuardianConfiguration": {"monitoringWindowMilliseconds": 60000,
"rolloutWeight": 50,
"rollbackOnRegression": true,
"randomizationUnit": "user"
}
},
"segmentKeys": ["segment-key-123abc"
]
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
],
"_version": 1,
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
]
},
"isProjectDefault": true,
"_isLegacy": true
}

Update a release pipeline

Updates a release pipeline.

Request

path Parameters

projectKey required	string <string> The project key
pipelineKey required	string <string> The release pipeline key

Request Body schema: application/json
required

description	string The release pipeline description
name required	string The name of the release pipeline
required	Array of objects (CreatePhaseInput) A logical grouping of one or more environments that share attributes for rolling out changes
tags	Array of strings A list of tags for this release pipeline

Responses

200

Release pipeline response

400

Invalid request

403

Forbidden

404

Invalid resource identifier

put/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}

Request samples

Payload
curl
Node.js
Python

application/json

{"description": "Standard pipeline to roll out to production",
"name": "Standard Pipeline",
"phases": [{"audiences": [{"environmentKey": "string",
"name": "string",
"segmentKeys": ["string"
],
"configuration": {"releaseStrategy": "string",
"requireApproval": true,
"notifyMemberIds": ["1234a56b7c89d012345e678f"
],
"notifyTeamKeys": ["example-reviewer-team"
],
"releaseGuardianConfiguration": {"monitoringWindowMilliseconds": 60000,
"rolloutWeight": 50,
"rollbackOnRegression": true,
"randomizationUnit": "user"
}
}
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
]
}

Response samples

application/json

{"createdAt": "1684262711507",
"description": "Standard pipeline to roll out to production",
"key": "standard-pipeline",
"name": "Standard Pipeline",
"phases": [{"id": "1234a56b7c89d012345e678f",
"audiences": [{"environment": {"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"key": "environment-key-123abc",
"name": "My Environment",
"color": "F5A623"
},
"name": "Phase 1 - Testing",
"configuration": {"releaseStrategy": "string",
"requireApproval": true,
"notifyMemberIds": ["1234a56b7c89d012345e678f"
],
"notifyTeamKeys": ["example-reviewer-team"
],
"releaseGuardianConfiguration": {"monitoringWindowMilliseconds": 60000,
"rolloutWeight": 50,
"rollbackOnRegression": true,
"randomizationUnit": "user"
}
},
"segmentKeys": ["segment-key-123abc"
]
}
],
"name": "Phase 1 - Testing",
"configuration": { }
}
],
"tags": ["example-tag"
],
"_version": 1,
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "allow",
"role_name": "string"
}
}
]
},
"isProjectDefault": true,
"_isLegacy": true
}

Delete release pipeline

Deletes a release pipeline.

You cannot delete the default release pipeline.

If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the Update project API to set the defaultReleasePipelineKey.

Request

path Parameters

projectKey required	string <string> The project key
pipelineKey required	string <string> The release pipeline key

Responses

204

Action succeeded

403

Forbidden

404

Invalid resource identifier

delete/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}

Request samples

curl
Node.js
Python

Response samples

application/json

{"code": "forbidden",
"message": "Forbidden. Access to the requested resource was denied."
}

Get release progressions for release pipeline

Get details on the progression of all releases, across all flags, for a release pipeline

Request

path Parameters

projectKey required	string <string> The project key
pipelineKey required	string <string> The pipeline key

query Parameters

filter	string <string> 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 <int64> The maximum number of items to return. Defaults to 20.
offset	integer <int64> 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`.

Responses

200

Release progression collection

404

Invalid resource identifier

get/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases

Request samples

curl
Node.js
Python

Response samples

application/json

{"activeCount": 3,
"completedCount": 1,
"items": [{"_createdAt": 0,
"_completedAt": 0,
"flagKey": "flag-key-123abc",
"activePhaseId": "1234a56b7c89d012345e678f",
"_links": {"property1": {"href": "string",
"type": "string"
},
"property2": {"href": "string",
"type": "string"
}
}
}
],
"phases": [{"_id": "1234a56b7c89d012345e678f",
"name": "Phase 1 - Testing",
"releaseCount": 2
}
],
"totalCount": 8,
"_links": {"property1": {"href": "string",
"type": "string"
},
"property2": {"href": "string",
"type": "string"
}
}
}

➔ Next to Releases (beta)

Release pipelines (beta)

This feature is in beta

Get all release pipelines

Filtering release pipelines

path Parameters

query Parameters

Create a release pipeline

path Parameters

Request Body schema: application/jsonrequired

Get release pipeline by key

path Parameters

Update a release pipeline

path Parameters

Request Body schema: application/jsonrequired

Delete release pipeline

path Parameters

Get release progressions for release pipeline

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required