Update phase status for release

1 curl -X PUT https://app.launchdarkly.com/api/v2/projects/projectKey/flags/flagKey/release/phases/phaseId \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "name": "Example release pipeline", 3 "releasePipelineKey": "example-release-pipeline", 4 "releasePipelineDescription": "Our release pipeline for typical testing and deployment", 5 "phases": [ 6 { 7 "_id": "1234a56b7c89d012345e678f", 8 "_name": "Phase 1 - Testing", 9 "complete": true, 10 "_creationDate": 1000000, 11 "_audiences": [ 12 { 13 "_id": "1234a56b7c89d012345e678g", 14 "name": "Phase 1 - Testing", 15 "environment": { 16 "_links": { 17 "self": { 18 "href": "/api/v2/projects/my-project/environments/my-environment", 19 "type": "application/json" 20 } 21 }, 22 "key": "environment-key-123abc", 23 "name": "My Environment", 24 "color": "F5A623" 25 }, 26 "configuration": { 27 "releaseStrategy": "releaseStrategy", 28 "requireApproval": true, 29 "releaseGuardianConfiguration": { 30 "monitoringWindowMilliseconds": 60000, 31 "rolloutWeight": 50, 32 "rollbackOnRegression": true, 33 "randomizationUnit": "user" 34 } 35 } 36 } 37 ], 38 "_completionDate": 1000000, 39 "_completedBy": { 40 "member": { 41 "_links": { 42 "self": { 43 "href": "/api/v2/members/569f183514f4432160000007", 44 "type": "application/json" 45 } 46 }, 47 "_id": "569f183514f4432160000007", 48 "role": "admin", 49 "email": "ariel@acme.com", 50 "firstName": "Ariel", 51 "lastName": "Flores" 52 } 53 }, 54 "status": "status", 55 "started": true, 56 "_startedDate": 1000000 57 } 58 ], 59 "_version": 1, 60 "_links": { 61 "key": { 62 "href": "href", 63 "type": "type" 64 } 65 }, 66 "_releaseVariationId": "_releaseVariationId", 67 "_canceledAt": 1000000 68 }

Updates the execution status of a phase of a release

Path parameters

projectKeystringRequired

The project key

flagKeystringRequired

The flag key

phaseIdstringRequired

The phase ID

Request

This endpoint expects an object.

statusstringOptional

Status of the phase

audienceslist of objectsOptional

Extra configuration for audiences required upon phase initialization.

Response

Action succeeded

namestring

The release pipeline name

releasePipelineKeystring

The release pipeline key

releasePipelineDescriptionstring

The release pipeline description

phaseslist of objects

An ordered list of the release pipeline phases

_versioninteger

The release version

_linksmap from strings to objects or null

The location and content type of related resources

_releaseVariationIdstring or null

The chosen release variation ID to use across all phases of a release

_canceledAtlong or null

Timestamp of when the release was canceled

Path parameters

Headers

Request

Response

Errors