Get release pipeline by key — LaunchDarkly

Get a release pipeline by key

Path parameters

projectKeystringRequired

The project key

pipelineKeystringRequired

The release pipeline key

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

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines/pipelineKey \ 2 -H "Authorization: <apiKey>"

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 }

1	curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines/pipelineKey \
2	-H "Authorization: <apiKey>"

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	}