Update deployment

PATCH

/api/v2/engineering-insights/deployments/:deploymentID

Update a deployment by ID. Updating a deployment uses a JSON patch representation of the desired changes. To learn more, read Updates.

The deployment ID is returned as part of the List deployments response. It is the id field of each element in the items array.

Path parameters

deploymentIDstringRequired

The deployment ID

Request

This endpoint expects a list of objects.

list of objects

Response

Deployment response

idstringformat: "uuid"

The deployment ID

applicationKeystring

The application key

applicationVersionstring

The application version

startedAtlong

The time the deployment started

statusstring

The status of the deployment

kindstring

The kind of deployment

activeboolean

Whether the deployment is active

archivedboolean

Whether the deployment is archived

environmentKeystring

The environment key

numberOfContributorsinteger

The number of contributors

numberOfPullRequestsinteger

The number of pull requests

linesAddedlong

The number of lines added

linesDeletedlong

The number of lines deleted

leadTimelong

The total lead time from first commit to deployment end in milliseconds

endedAtlongOptional

The time the deployment ended

durationMslongOptional

The duration of the deployment in milliseconds

metadatamap from strings to anyOptional

The metadata associated with the deployment

pullRequestsobjectOptional

The pull requests contained in the deployment

flagReferencesobjectOptional

The flag references contained in the deployment

leadTimeStagesobjectOptional

The lead time stages for the deployment

Errors

PATCH

1 curl -X PATCH https://app.launchdarkly.com/api/v2/engineering-insights/deployments/deploymentID \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   {
6     "op": "replace",
7     "path": "/status",
8     "value": "finished"
9   }
10 ]'

200Updated

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

Insights flag events (beta)

Up Next

Built with

1	curl -X PATCH https://app.launchdarkly.com/api/v2/engineering-insights/deployments/deploymentID \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"op": "replace",
7	"path": "/status",
8	"value": "finished"
9	}
10	]'

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