List release policies

GET

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

GET

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

1 curl https://app.launchdarkly.com/api/v2/projects/default/release-policies \
2      -H "LD-API-Version: beta" \
3      -H "Authorization: <apiKey>"

Try it

1 {
2   "items": [
3     {
4       "_id": "550e8400-e29b-41d4-a716-446655440000",
5       "rank": 1,
6       "releaseMethod": "guarded-release",
7       "name": "Production Release",
8       "key": "production-release",
9       "_access": {
10         "denied": [
11           {
12             "action": "action",
13             "reason": {
14               "effect": "allow",
15               "resources": [
16                 "proj/*:env/*;qa_*:/flag/*"
17               ],
18               "notResources": [
19                 "notResources",
20                 "notResources"
21               ],
22               "actions": [
23                 "*"
24               ],
25               "notActions": [
26                 "notActions",
27                 "notActions"
28               ],
29               "role_name": "role_name"
30             }
31           },
32           {
33             "action": "action",
34             "reason": {
35               "effect": "allow",
36               "resources": [
37                 "proj/*:env/*;qa_*:/flag/*"
38               ],
39               "notResources": [
40                 "notResources",
41                 "notResources"
42               ],
43               "actions": [
44                 "*"
45               ],
46               "notActions": [
47                 "notActions",
48                 "notActions"
49               ],
50               "role_name": "role_name"
51             }
52           }
53         ],
54         "allowed": [
55           {
56             "action": "action",
57             "reason": {
58               "effect": "allow",
59               "resources": [
60                 "proj/*:env/*;qa_*:/flag/*"
61               ],
62               "notResources": [
63                 "notResources",
64                 "notResources"
65               ],
66               "actions": [
67                 "*"
68               ],
69               "notActions": [
70                 "notActions",
71                 "notActions"
72               ],
73               "role_name": "role_name"
74             }
75           },
76           {
77             "action": "action",
78             "reason": {
79               "effect": "allow",
80               "resources": [
81                 "proj/*:env/*;qa_*:/flag/*"
82               ],
83               "notResources": [
84                 "notResources",
85                 "notResources"
86               ],
87               "actions": [
88                 "*"
89               ],
90               "notActions": [
91                 "notActions",
92                 "notActions"
93               ],
94               "role_name": "role_name"
95             }
96           }
97         ]
98       },
99       "scope": {
100         "environmentKeys": [
101           "production",
102           "staging"
103         ]
104       },
105       "guardedReleaseConfig": {
106         "rollbackOnRegression": true,
107         "minSampleSize": 100
108       },
109       "progressiveReleaseConfig": {
110         "key": "value"
111       }
112     },
113     {
114       "_id": "550e8400-e29b-41d4-a716-446655440000",
115       "rank": 1,
116       "releaseMethod": "guarded-release",
117       "name": "Production Release",
118       "key": "production-release",
119       "_access": {
120         "denied": [
121           {
122             "action": "action",
123             "reason": {
124               "effect": "allow",
125               "resources": [
126                 "proj/*:env/*;qa_*:/flag/*"
127               ],
128               "notResources": [
129                 "notResources",
130                 "notResources"
131               ],
132               "actions": [
133                 "*"
134               ],
135               "notActions": [
136                 "notActions",
137                 "notActions"
138               ],
139               "role_name": "role_name"
140             }
141           },
142           {
143             "action": "action",
144             "reason": {
145               "effect": "allow",
146               "resources": [
147                 "proj/*:env/*;qa_*:/flag/*"
148               ],
149               "notResources": [
150                 "notResources",
151                 "notResources"
152               ],
153               "actions": [
154                 "*"
155               ],
156               "notActions": [
157                 "notActions",
158                 "notActions"
159               ],
160               "role_name": "role_name"
161             }
162           }
163         ],
164         "allowed": [
165           {
166             "action": "action",
167             "reason": {
168               "effect": "allow",
169               "resources": [
170                 "proj/*:env/*;qa_*:/flag/*"
171               ],
172               "notResources": [
173                 "notResources",
174                 "notResources"
175               ],
176               "actions": [
177                 "*"
178               ],
179               "notActions": [
180                 "notActions",
181                 "notActions"
182               ],
183               "role_name": "role_name"
184             }
185           },
186           {
187             "action": "action",
188             "reason": {
189               "effect": "allow",
190               "resources": [
191                 "proj/*:env/*;qa_*:/flag/*"
192               ],
193               "notResources": [
194                 "notResources",
195                 "notResources"
196               ],
197               "actions": [
198                 "*"
199               ],
200               "notActions": [
201                 "notActions",
202                 "notActions"
203               ],
204               "role_name": "role_name"
205             }
206           }
207         ]
208       },
209       "scope": {
210         "environmentKeys": [
211           "production",
212           "staging"
213         ]
214       },
215       "guardedReleaseConfig": {
216         "rollbackOnRegression": true,
217         "minSampleSize": 100
218       },
219       "progressiveReleaseConfig": {
220         "key": "value"
221       }
222     }
223   ],
224   "totalCount": 42
225 }

Get a list of release policies for the specified project with optional filtering.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

Query parameters

excludeDefaultbooleanOptionalDefaults to false

When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present.

Response

List of release policies

itemslist of objects

List of release policies

totalCountinteger

Total number of release policies

List release policies

Authentication

Path parameters

Headers

Query parameters

Response

Errors