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.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Path Parameters
The project key
stringRequest Body
application/json
The release pipeline description
The unique identifier of this release pipeline
The name of the release pipeline
A logical grouping of one or more environments that share attributes for rolling out changes
A list of tags for this release pipeline
Whether or not the newly created pipeline should be set as the default pipeline for this project
Whether or not the pipeline is enabled for Release Automation.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/projects/string/release-pipelines" \ -H "Content-Type: application/json" \ -d '{ "key": "standard-pipeline", "name": "Standard Pipeline", "phases": [ { "audiences": [ { "environmentKey": "string", "name": "string" } ], "name": "Phase 1 - Testing" } ] }'{ "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": "monitoredRelease", "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 all release pipelines GET
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`.
Get release pipeline by key GET
Get a release pipeline by key