Get a release policy by key

GET

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

GET

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

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

Try it

1 {
2   "_id": "550e8400-e29b-41d4-a716-446655440000",
3   "rank": 1,
4   "releaseMethod": "guarded-release",
5   "name": "Production Release",
6   "key": "production-release",
7   "_access": {
8     "denied": [
9       {
10         "action": "action",
11         "reason": {
12           "effect": "allow",
13           "resources": [
14             "proj/*:env/*;qa_*:/flag/*"
15           ],
16           "notResources": [
17             "notResources",
18             "notResources"
19           ],
20           "actions": [
21             "*"
22           ],
23           "notActions": [
24             "notActions",
25             "notActions"
26           ],
27           "role_name": "role_name"
28         }
29       },
30       {
31         "action": "action",
32         "reason": {
33           "effect": "allow",
34           "resources": [
35             "proj/*:env/*;qa_*:/flag/*"
36           ],
37           "notResources": [
38             "notResources",
39             "notResources"
40           ],
41           "actions": [
42             "*"
43           ],
44           "notActions": [
45             "notActions",
46             "notActions"
47           ],
48           "role_name": "role_name"
49         }
50       }
51     ],
52     "allowed": [
53       {
54         "action": "action",
55         "reason": {
56           "effect": "allow",
57           "resources": [
58             "proj/*:env/*;qa_*:/flag/*"
59           ],
60           "notResources": [
61             "notResources",
62             "notResources"
63           ],
64           "actions": [
65             "*"
66           ],
67           "notActions": [
68             "notActions",
69             "notActions"
70           ],
71           "role_name": "role_name"
72         }
73       },
74       {
75         "action": "action",
76         "reason": {
77           "effect": "allow",
78           "resources": [
79             "proj/*:env/*;qa_*:/flag/*"
80           ],
81           "notResources": [
82             "notResources",
83             "notResources"
84           ],
85           "actions": [
86             "*"
87           ],
88           "notActions": [
89             "notActions",
90             "notActions"
91           ],
92           "role_name": "role_name"
93         }
94       }
95     ]
96   },
97   "scope": {
98     "environmentKeys": [
99       "production",
100       "staging"
101     ]
102   },
103   "guardedReleaseConfig": {
104     "rollbackOnRegression": true,
105     "minSampleSize": 100
106   },
107   "progressiveReleaseConfig": {
108     "key": "value"
109   }
110 }

Retrieve a single release policy by its key for the specified project.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

policyKeystringRequired

The release policy key

Response

Release policy found

_idstring

The unique identifier of the release policy

rankinteger

The rank/priority of the release policy

releaseMethodenum

The release method for this policy

Allowed values:

namestring<=256 characters

The name of the release policy

keystring

The human-readable key of the release policy

_accessobject or null

scopeobject or null

guardedReleaseConfigobject or null

Configuration for guarded releases

progressiveReleaseConfigmap from strings to any or null

Configuration for progressive releases

Get a release policy by key

Authentication

Path parameters

Headers

Response

Errors