Create a release pipeline

POST

/api/v2/projects/:projectKey/release-pipelines

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.

Path parameters

projectKeystringRequired

The project key

Request

This endpoint expects an object.

keystringRequired

The unique identifier of this release pipeline

namestringRequired

The name of the release pipeline

phaseslist of objectsRequired

A logical grouping of one or more environments that share attributes for rolling out changes

descriptionstringOptional

The release pipeline description

tagslist of stringsOptional

A list of tags for this release pipeline

isProjectDefaultbooleanOptional

Whether or not the newly created pipeline should be set as the default pipeline for this project

isLegacybooleanOptional

Whether or not the pipeline is enabled for Release Automation.

Response

Release pipeline response

createdAtdatetime

Timestamp of when the release pipeline was created

keystring

The release pipeline key

namestring

The release pipeline name

phaseslist of objects

An ordered list of the release pipeline phases. Each phase is a logical grouping of one or more environments that share attributes for rolling out changes.

descriptionstringOptional

The release pipeline description

tagslist of stringsOptional

A list of the release pipeline’s tags

_versionintegerOptional

The release pipeline version

_accessobjectOptional

Details on the allowed and denied actions for this release pipeline

isProjectDefaultbooleanOptional

Whether this release pipeline is the default pipeline for the project

_isLegacybooleanOptional

Whether this release pipeline is a legacy pipeline

Errors

POST

1 curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "key": "standard-pipeline",
6   "name": "Standard Pipeline",
7   "phases": [
8     {
9       "audiences": [
10         {
11           "environmentKey": "environmentKey",
12           "name": "name"
13         }
14       ],
15       "name": "Phase 1 - Testing"
16     }
17   ]
18 }'

201Created

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "key": "standard-pipeline",
4   "name": "Standard Pipeline",
5   "phases": [
6     {
7       "id": "1234a56b7c89d012345e678f",
8       "audiences": [
9         {
10           "name": "Phase 1 - Testing",
11           "environment": {
12             "_links": {
13               "self": {
14                 "href": "/api/v2/projects/my-project/environments/my-environment",
15                 "type": "application/json"
16               }
17             },
18             "key": "environment-key-123abc",
19             "name": "My Environment",
20             "color": "F5A623"
21           },
22           "configuration": {
23             "releaseStrategy": "releaseStrategy",
24             "requireApproval": true,
25             "releaseGuardianConfiguration": {
26               "monitoringWindowMilliseconds": 60000,
27               "rolloutWeight": 50,
28               "rollbackOnRegression": true,
29               "randomizationUnit": "user"
30             }
31           }
32         }
33       ],
34       "name": "Phase 1 - Testing"
35     }
36   ],
37   "description": "Standard pipeline to roll out to production",
38   "tags": [
39     "example-tag"
40   ],
41   "_version": 1,
42   "_access": {
43     "denied": [
44       {
45         "action": "action",
46         "reason": {
47           "effect": "allow"
48         }
49       }
50     ],
51     "allowed": [
52       {
53         "action": "action",
54         "reason": {
55           "effect": "allow"
56         }
57       }
58     ]
59   },
60   "isProjectDefault": true,
61   "_isLegacy": true
62 }

Delete release pipeline

Up Next

Built with

1	curl -X POST https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"key": "standard-pipeline",
6	"name": "Standard Pipeline",
7	"phases": [
8	{
9	"audiences": [
10	{
11	"environmentKey": "environmentKey",
12	"name": "name"
13	}
14	],
15	"name": "Phase 1 - Testing"
16	}
17	]
18	}'

1	{
2	"createdAt": "2024-01-15T09:30:00Z",
3	"key": "standard-pipeline",
4	"name": "Standard Pipeline",
5	"phases": [
6	{
7	"id": "1234a56b7c89d012345e678f",
8	"audiences": [
9	{
10	"name": "Phase 1 - Testing",
11	"environment": {
12	"_links": {
13	"self": {
14	"href": "/api/v2/projects/my-project/environments/my-environment",
15	"type": "application/json"
16	}
17	},
18	"key": "environment-key-123abc",
19	"name": "My Environment",
20	"color": "F5A623"
21	},
22	"configuration": {
23	"releaseStrategy": "releaseStrategy",
24	"requireApproval": true,
25	"releaseGuardianConfiguration": {
26	"monitoringWindowMilliseconds": 60000,
27	"rolloutWeight": 50,
28	"rollbackOnRegression": true,
29	"randomizationUnit": "user"
30	}
31	}
32	}
33	],
34	"name": "Phase 1 - Testing"
35	}
36	],
37	"description": "Standard pipeline to roll out to production",
38	"tags": [
39	"example-tag"
40	],
41	"_version": 1,
42	"_access": {
43	"denied": [
44	{
45	"action": "action",
46	"reason": {
47	"effect": "allow"
48	}
49	}
50	],
51	"allowed": [
52	{
53	"action": "action",
54	"reason": {
55	"effect": "allow"
56	}
57	}
58	]
59	},
60	"isProjectDefault": true,
61	"_isLegacy": true
62	}