List deployments — LaunchDarkly

Get a list of deployments

Expanding the deployment collection response

LaunchDarkly supports expanding the deployment collection response to include additional fields.

To expand the response, append the expand query parameter and include the following:

pullRequests includes details on all of the pull requests associated with each deployment
flagReferences includes details on all of the references to flags in each deployment

For example, use ?expand=pullRequests to include the pullRequests field in the response. By default, this field is not included in the response.

Query parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

applicationKeystringOptional

Comma separated list of application keys

limitlongOptional

The number of deployments to return. Default is 20. Maximum allowed is 100.

expandstringOptional

Expand properties in response. Options: pullRequests, flagReferences

fromlongOptional

Unix timestamp in milliseconds. Default value is 7 days ago.

tolongOptional

Unix timestamp in milliseconds. Default value is now.

afterstringOptional

Identifier used for pagination

beforestringOptional

Identifier used for pagination

kindstringOptional

The deployment kind

statusstringOptional

The deployment status

Response

Deployment collection response

totalCountinteger

The total number of deployments

itemslist of objects

A list of deployments

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

1 curl -G https://app.launchdarkly.com/api/v2/engineering-insights/deployments \ 2 -H "Authorization: <apiKey>" \ 3 -d projectKey=projectKey \ 4 -d environmentKey=environmentKey

1 { 2 "totalCount": 25, 3 "items": [ 4 { 5 "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", 6 "applicationKey": "billing-service", 7 "applicationVersion": "a90a8a2", 8 "startedAt": 1000000, 9 "status": "status", 10 "kind": "kind", 11 "active": true, 12 "archived": false, 13 "environmentKey": "production", 14 "numberOfContributors": 1, 15 "numberOfPullRequests": 2, 16 "linesAdded": 100, 17 "linesDeleted": 50, 18 "leadTime": 20237000, 19 "endedAt": 1000000, 20 "durationMs": 10996000, 21 "metadata": { 22 "buildNumber": "1234" 23 }, 24 "pullRequests": { 25 "totalCount": 25, 26 "items": [ 27 { 28 "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", 29 "externalId": "1234", 30 "title": "Enable new payment structure", 31 "status": "merged", 32 "author": "jane.doe", 33 "createTime": 1000000, 34 "baseCommitKey": "a90a8a2", 35 "headCommitKey": "a90a8a2", 36 "filesChanged": 2, 37 "linesAdded": 100, 38 "linesDeleted": 50, 39 "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406", 40 "mergeCommitKey": "a90a8a2", 41 "flagReferences": { 42 "totalCount": 25, 43 "items": [ 44 { 45 "projectKey": "default", 46 "flagKey": "enable-new-payment-structure", 47 "referencesAdded": 2, 48 "referencesRemoved": 5 49 } 50 ] 51 }, 52 "leadTime": { 53 "codingDurationMs": 1000000, 54 "reviewDurationMs": 500000, 55 "maxWaitDurationMs": 100000, 56 "avgWaitDurationMs": 100000, 57 "maxDeployDurationMs": 100000, 58 "avgDeployDurationMs": 100000, 59 "maxTotalLeadTimeMs": 1600000, 60 "avgTotalLeadTimeMs": 1600000 61 } 62 } 63 ], 64 "_links": { 65 "next": { 66 "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5", 67 "type": "application/json" 68 }, 69 "self": { 70 "href": "/api/v2/engineering-insights/pull-requests", 71 "type": "application/json" 72 } 73 } 74 }, 75 "flagReferences": { 76 "totalCount": 25, 77 "items": [ 78 { 79 "projectKey": "default", 80 "flagKey": "enable-new-payment-structure", 81 "referencesAdded": 2, 82 "referencesRemoved": 5 83 } 84 ] 85 }, 86 "leadTimeStages": { 87 "codingDurationMs": 1000000, 88 "reviewDurationMs": 500000, 89 "waitDurationMs": 100000, 90 "deployDurationMs": 100000, 91 "totalLeadTimeMs": 1600000 92 } 93 } 94 ], 95 "_links": { 96 "next": { 97 "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5", 98 "type": "application/json" 99 }, 100 "self": { 101 "href": "/api/v2/engineering-insights/deployments", 102 "type": "application/json" 103 } 104 } 105 }

1	curl -G https://app.launchdarkly.com/api/v2/engineering-insights/deployments \
2	-H "Authorization: <apiKey>" \
3	-d projectKey=projectKey \
4	-d environmentKey=environmentKey

1	{
2	"totalCount": 25,
3	"items": [
4	{
5	"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
6	"applicationKey": "billing-service",
7	"applicationVersion": "a90a8a2",
8	"startedAt": 1000000,
9	"status": "status",
10	"kind": "kind",
11	"active": true,
12	"archived": false,
13	"environmentKey": "production",
14	"numberOfContributors": 1,
15	"numberOfPullRequests": 2,
16	"linesAdded": 100,
17	"linesDeleted": 50,
18	"leadTime": 20237000,
19	"endedAt": 1000000,
20	"durationMs": 10996000,
21	"metadata": {
22	"buildNumber": "1234"
23	},
24	"pullRequests": {
25	"totalCount": 25,
26	"items": [
27	{
28	"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
29	"externalId": "1234",
30	"title": "Enable new payment structure",
31	"status": "merged",
32	"author": "jane.doe",
33	"createTime": 1000000,
34	"baseCommitKey": "a90a8a2",
35	"headCommitKey": "a90a8a2",
36	"filesChanged": 2,
37	"linesAdded": 100,
38	"linesDeleted": 50,
39	"url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
40	"mergeCommitKey": "a90a8a2",
41	"flagReferences": {
42	"totalCount": 25,
43	"items": [
44	{
45	"projectKey": "default",
46	"flagKey": "enable-new-payment-structure",
47	"referencesAdded": 2,
48	"referencesRemoved": 5
49	}
50	]
51	},
52	"leadTime": {
53	"codingDurationMs": 1000000,
54	"reviewDurationMs": 500000,
55	"maxWaitDurationMs": 100000,
56	"avgWaitDurationMs": 100000,
57	"maxDeployDurationMs": 100000,
58	"avgDeployDurationMs": 100000,
59	"maxTotalLeadTimeMs": 1600000,
60	"avgTotalLeadTimeMs": 1600000
61	}
62	}
63	],
64	"_links": {
65	"next": {
66	"href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
67	"type": "application/json"
68	},
69	"self": {
70	"href": "/api/v2/engineering-insights/pull-requests",
71	"type": "application/json"
72	}
73	}
74	},
75	"flagReferences": {
76	"totalCount": 25,
77	"items": [
78	{
79	"projectKey": "default",
80	"flagKey": "enable-new-payment-structure",
81	"referencesAdded": 2,
82	"referencesRemoved": 5
83	}
84	]
85	},
86	"leadTimeStages": {
87	"codingDurationMs": 1000000,
88	"reviewDurationMs": 500000,
89	"waitDurationMs": 100000,
90	"deployDurationMs": 100000,
91	"totalLeadTimeMs": 1600000
92	}
93	}
94	],
95	"_links": {
96	"next": {
97	"href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
98	"type": "application/json"
99	},
100	"self": {
101	"href": "/api/v2/engineering-insights/deployments",
102	"type": "application/json"
103	}
104	}
105	}