Update a release policy

1 import requests 2 3 url = "https://app.launchdarkly.com/api/v2/projects/default/release-policies/production-release" 4 5 payload = { 6 "releaseMethod": "guarded-release", 7 "name": "Production Release", 8 "scope": { "environmentKeys": ["production", "staging"] }, 9 "guardedReleaseConfig": { 10 "rollbackOnRegression": True, 11 "minSampleSize": 100 12 }, 13 "progressiveReleaseConfig": "{}" 14 } 15 headers = { 16 "LD-API-Version": "beta", 17 "Authorization": "<apiKey>", 18 "Content-Type": "application/json" 19 } 20 21 response = requests.put(url, json=payload, headers=headers) 22 23 print(response.json())

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 "allowed": [ 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 "string", 25 "string" 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 "string", 46 "string" 47 ], 48 "role_name": "role_name" 49 } 50 } 51 ], 52 "denied": [ 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 "string", 69 "string" 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 "string", 90 "string" 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 }

Update an existing release policy for the specified project.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

policyKeystringRequired

The human-readable key of the release policy

Request

Release policy data to update

releaseMethodenumRequired

The release method for this policy

Allowed values:

namestringRequired<=256 characters

The name of the release policy

scopeobjectOptional

guardedReleaseConfigobjectOptional

Configuration for guarded releases

progressiveReleaseConfigobjectOptional

Configuration for progressive releases

Response

Release policy updated successfully

_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

progressiveReleaseConfigobject or null

Configuration for progressive releases

Authentication

Path parameters

Headers

Request

Response

Errors