Patch insight group

PATCH

/api/v2/engineering-insights/insights/groups/:insightGroupKey

Update an insight group. Updating an insight group uses a JSON patch representation of the desired changes. To learn more, read Updates.

Path parameters

insightGroupKeystringRequired

The insight group key

Request

This endpoint expects a list of objects.

list of objects

Response

Insight group response

keystring

The insight group key

namestring

The insight group name

projectKeystring

The project key

environmentKeystring

The environment key

createdAtlong

The time the insight group was created

environmentobjectOptional

Expanded details about the environment

scoresobjectOptional

The scores for the insight group

scoreMetadataobjectOptional

Metadata about the insight scores, when expanded

applicationKeyslist of stringsOptional

The application keys

Errors

PATCH

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

200Updated

1 {
2   "key": "default-production-all-apps",
3   "name": "Production - All Apps",
4   "projectKey": "default",
5   "environmentKey": "production",
6   "createdAt": 1000000,
7   "environment": {
8     "_links": {
9       "self": {
10         "href": "/api/v2/projects/my-project/environments/my-environment",
11         "type": "application/json"
12       }
13     },
14     "_id": "57be1db38b75bf0772d11384",
15     "key": "environment-key-123abc",
16     "name": "My Environment",
17     "apiKey": "sdk-xxx",
18     "mobileKey": "mob-xxx",
19     "color": "F5A623",
20     "defaultTtl": 5,
21     "secureMode": true,
22     "defaultTrackEvents": false,
23     "requireComments": true,
24     "confirmChanges": true,
25     "tags": [
26       "ops"
27     ],
28     "critical": true,
29     "approvalSettings": {
30       "required": true,
31       "bypassApprovalsForPendingChanges": false,
32       "minNumApprovals": 1,
33       "canReviewOwnRequest": false,
34       "canApplyDeclinedChanges": true,
35       "serviceKind": "launchdarkly",
36       "serviceConfig": {
37         "key": "value"
38       },
39       "requiredApprovalTags": [
40         "require-approval"
41       ],
42       "autoApplyApprovedChanges": true,
43       "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258",
44       "resourceKind": "resourceKind"
45     },
46     "resourceApprovalSettings": {
47       "key": {
48         "required": true,
49         "bypassApprovalsForPendingChanges": false,
50         "minNumApprovals": 1,
51         "canReviewOwnRequest": false,
52         "canApplyDeclinedChanges": true,
53         "serviceKind": "launchdarkly",
54         "serviceConfig": {
55           "key": "value"
56         },
57         "requiredApprovalTags": [
58           "require-approval"
59         ],
60         "autoApplyApprovedChanges": true,
61         "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
62       }
63     }
64   },
65   "scores": {
66     "overall": {
67       "score": 100,
68       "indicator": "indicator",
69       "indicatorRange": {
70         "min": 0,
71         "max": 100
72       },
73       "aggregateOf": [
74         "deploymentFrequency",
75         "leadTime"
76       ],
77       "diffVsLastPeriod": 1
78     },
79     "deploymentFrequency": {
80       "score": 100,
81       "indicator": "indicator",
82       "indicatorRange": {
83         "min": 0,
84         "max": 100
85       },
86       "aggregateOf": [
87         "deploymentFrequency",
88         "leadTime"
89       ],
90       "diffVsLastPeriod": 1
91     },
92     "deploymentFailureRate": {
93       "score": 100,
94       "indicator": "indicator",
95       "indicatorRange": {
96         "min": 0,
97         "max": 100
98       },
99       "aggregateOf": [
100         "deploymentFrequency",
101         "leadTime"
102       ],
103       "diffVsLastPeriod": 1
104     },
105     "leadTime": {
106       "score": 100,
107       "indicator": "indicator",
108       "indicatorRange": {
109         "min": 0,
110         "max": 100
111       },
112       "aggregateOf": [
113         "deploymentFrequency",
114         "leadTime"
115       ],
116       "diffVsLastPeriod": 1
117     },
118     "impactSize": {
119       "score": 100,
120       "indicator": "indicator",
121       "indicatorRange": {
122         "min": 0,
123         "max": 100
124       },
125       "aggregateOf": [
126         "deploymentFrequency",
127         "leadTime"
128       ],
129       "diffVsLastPeriod": 1
130     },
131     "experimentationCoverage": {
132       "score": 100,
133       "indicator": "indicator",
134       "indicatorRange": {
135         "min": 0,
136         "max": 100
137       },
138       "aggregateOf": [
139         "deploymentFrequency",
140         "leadTime"
141       ],
142       "diffVsLastPeriod": 1
143     },
144     "flagHealth": {
145       "score": 100,
146       "indicator": "indicator",
147       "indicatorRange": {
148         "min": 0,
149         "max": 100
150       },
151       "aggregateOf": [
152         "deploymentFrequency",
153         "leadTime"
154       ],
155       "diffVsLastPeriod": 1
156     },
157     "velocity": {
158       "score": 100,
159       "indicator": "indicator",
160       "indicatorRange": {
161         "min": 0,
162         "max": 100
163       },
164       "aggregateOf": [
165         "deploymentFrequency",
166         "leadTime"
167       ],
168       "diffVsLastPeriod": 1
169     },
170     "risk": {
171       "score": 100,
172       "indicator": "indicator",
173       "indicatorRange": {
174         "min": 0,
175         "max": 100
176       },
177       "aggregateOf": [
178         "deploymentFrequency",
179         "leadTime"
180       ],
181       "diffVsLastPeriod": 1
182     },
183     "efficiency": {
184       "score": 100,
185       "indicator": "indicator",
186       "indicatorRange": {
187         "min": 0,
188         "max": 100
189       },
190       "aggregateOf": [
191         "deploymentFrequency",
192         "leadTime"
193       ],
194       "diffVsLastPeriod": 1
195     },
196     "creationRatio": {
197       "score": 100,
198       "indicator": "indicator",
199       "indicatorRange": {
200         "min": 0,
201         "max": 100
202       },
203       "aggregateOf": [
204         "deploymentFrequency",
205         "leadTime"
206       ],
207       "diffVsLastPeriod": 1
208     }
209   },
210   "scoreMetadata": {
211     "period": {
212       "startTime": 1000000,
213       "endTime": 1000000
214     },
215     "lastPeriod": {
216       "startTime": 1000000,
217       "endTime": 1000000
218     }
219   },
220   "applicationKeys": [
221     "billing-service",
222     "inventory-service"
223   ]
224 }

Integration audit log subscriptions

Up Next

Built with

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

1	{
2	"key": "default-production-all-apps",
3	"name": "Production - All Apps",
4	"projectKey": "default",
5	"environmentKey": "production",
6	"createdAt": 1000000,
7	"environment": {
8	"_links": {
9	"self": {
10	"href": "/api/v2/projects/my-project/environments/my-environment",
11	"type": "application/json"
12	}
13	},
14	"_id": "57be1db38b75bf0772d11384",
15	"key": "environment-key-123abc",
16	"name": "My Environment",
17	"apiKey": "sdk-xxx",
18	"mobileKey": "mob-xxx",
19	"color": "F5A623",
20	"defaultTtl": 5,
21	"secureMode": true,
22	"defaultTrackEvents": false,
23	"requireComments": true,
24	"confirmChanges": true,
25	"tags": [
26	"ops"
27	],
28	"critical": true,
29	"approvalSettings": {
30	"required": true,
31	"bypassApprovalsForPendingChanges": false,
32	"minNumApprovals": 1,
33	"canReviewOwnRequest": false,
34	"canApplyDeclinedChanges": true,
35	"serviceKind": "launchdarkly",
36	"serviceConfig": {
37	"key": "value"
38	},
39	"requiredApprovalTags": [
40	"require-approval"
41	],
42	"autoApplyApprovedChanges": true,
43	"serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258",
44	"resourceKind": "resourceKind"
45	},
46	"resourceApprovalSettings": {
47	"key": {
48	"required": true,
49	"bypassApprovalsForPendingChanges": false,
50	"minNumApprovals": 1,
51	"canReviewOwnRequest": false,
52	"canApplyDeclinedChanges": true,
53	"serviceKind": "launchdarkly",
54	"serviceConfig": {
55	"key": "value"
56	},
57	"requiredApprovalTags": [
58	"require-approval"
59	],
60	"autoApplyApprovedChanges": true,
61	"serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
62	}
63	}
64	},
65	"scores": {
66	"overall": {
67	"score": 100,
68	"indicator": "indicator",
69	"indicatorRange": {
70	"min": 0,
71	"max": 100
72	},
73	"aggregateOf": [
74	"deploymentFrequency",
75	"leadTime"
76	],
77	"diffVsLastPeriod": 1
78	},
79	"deploymentFrequency": {
80	"score": 100,
81	"indicator": "indicator",
82	"indicatorRange": {
83	"min": 0,
84	"max": 100
85	},
86	"aggregateOf": [
87	"deploymentFrequency",
88	"leadTime"
89	],
90	"diffVsLastPeriod": 1
91	},
92	"deploymentFailureRate": {
93	"score": 100,
94	"indicator": "indicator",
95	"indicatorRange": {
96	"min": 0,
97	"max": 100
98	},
99	"aggregateOf": [
100	"deploymentFrequency",
101	"leadTime"
102	],
103	"diffVsLastPeriod": 1
104	},
105	"leadTime": {
106	"score": 100,
107	"indicator": "indicator",
108	"indicatorRange": {
109	"min": 0,
110	"max": 100
111	},
112	"aggregateOf": [
113	"deploymentFrequency",
114	"leadTime"
115	],
116	"diffVsLastPeriod": 1
117	},
118	"impactSize": {
119	"score": 100,
120	"indicator": "indicator",
121	"indicatorRange": {
122	"min": 0,
123	"max": 100
124	},
125	"aggregateOf": [
126	"deploymentFrequency",
127	"leadTime"
128	],
129	"diffVsLastPeriod": 1
130	},
131	"experimentationCoverage": {
132	"score": 100,
133	"indicator": "indicator",
134	"indicatorRange": {
135	"min": 0,
136	"max": 100
137	},
138	"aggregateOf": [
139	"deploymentFrequency",
140	"leadTime"
141	],
142	"diffVsLastPeriod": 1
143	},
144	"flagHealth": {
145	"score": 100,
146	"indicator": "indicator",
147	"indicatorRange": {
148	"min": 0,
149	"max": 100
150	},
151	"aggregateOf": [
152	"deploymentFrequency",
153	"leadTime"
154	],
155	"diffVsLastPeriod": 1
156	},
157	"velocity": {
158	"score": 100,
159	"indicator": "indicator",
160	"indicatorRange": {
161	"min": 0,
162	"max": 100
163	},
164	"aggregateOf": [
165	"deploymentFrequency",
166	"leadTime"
167	],
168	"diffVsLastPeriod": 1
169	},
170	"risk": {
171	"score": 100,
172	"indicator": "indicator",
173	"indicatorRange": {
174	"min": 0,
175	"max": 100
176	},
177	"aggregateOf": [
178	"deploymentFrequency",
179	"leadTime"
180	],
181	"diffVsLastPeriod": 1
182	},
183	"efficiency": {
184	"score": 100,
185	"indicator": "indicator",
186	"indicatorRange": {
187	"min": 0,
188	"max": 100
189	},
190	"aggregateOf": [
191	"deploymentFrequency",
192	"leadTime"
193	],
194	"diffVsLastPeriod": 1
195	},
196	"creationRatio": {
197	"score": 100,
198	"indicator": "indicator",
199	"indicatorRange": {
200	"min": 0,
201	"max": 100
202	},
203	"aggregateOf": [
204	"deploymentFrequency",
205	"leadTime"
206	],
207	"diffVsLastPeriod": 1
208	}
209	},
210	"scoreMetadata": {
211	"period": {
212	"startTime": 1000000,
213	"endTime": 1000000
214	},
215	"lastPeriod": {
216	"startTime": 1000000,
217	"endTime": 1000000
218	}
219	},
220	"applicationKeys": [
221	"billing-service",
222	"inventory-service"
223	]
224	}