Releases (beta)
Patch release for flag
This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the Update phase status for release endpoint.
Update currently active release for a flag. Updating releases requires the JSON patch format. To learn more, read Updates.
You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the path. For example, to mark the first phase of a release as complete, use the following request body:
[ { "op": "replace", "path": "/phase/0/complete", "value": true } ]Authorization
ApiKey read, writeAuthorization<token>
In: header
Scope: read, write
Path Parameters
projectKey*string
The project key
Format
stringflagKey*string
The flag key
Format
stringRequest Body
application/json
[index: integer]?
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/flags/string/string/release" \ -H "Content-Type: application/json" \ -d '[ { "op": "replace", "path": "/phases/0/complete", "value": true } ]'{ "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }, "name": "Example release pipeline", "releasePipelineKey": "example-release-pipeline", "releasePipelineDescription": "Our release pipeline for typical testing and deployment", "phases": [ { "_id": "1234a56b7c89d012345e678f", "_name": "Phase 1 - Testing", "complete": true, "_creationDate": "1684262711507", "_completionDate": "1684262711509", "_completedBy": { "member": { "_links": { "self": { "href": "/api/v2/members/569f183514f4432160000007", "type": "application/json" } }, "_id": "569f183514f4432160000007", "firstName": "Ariel", "lastName": "Flores", "role": "admin", "email": "ariel@acme.com" }, "token": { "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }, "_id": "string", "name": "DevOps token", "ending": "2345", "serviceToken": false } }, "_audiences": [ { "_id": "1234a56b7c89d012345e678g", "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }, "environment": { "_links": { "self": { "href": "/api/v2/projects/my-project/environments/my-environment", "type": "application/json" } }, "key": "environment-key-123abc", "name": "My Environment", "color": "F5A623" }, "name": "Phase 1 - Testing", "configuration": { "releaseStrategy": "monitoredRelease", "requireApproval": true, "notifyMemberIds": [ "1234a56b7c89d012345e678f" ], "notifyTeamKeys": [ "example-reviewer-team" ], "releaseGuardianConfiguration": { "monitoringWindowMilliseconds": 60000, "rolloutWeight": 50, "rollbackOnRegression": true, "randomizationUnit": "user" } }, "segmentKeys": [ "segment-key-123abc" ], "status": "active", "_ruleIds": [ "string" ] } ], "status": "Started", "started": true, "_startedDate": 0, "configuration": {} } ], "_version": 1, "_releaseVariationId": "string", "_canceledAt": "1684262711507"}