Sign in

v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
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
    }
  ]
patch/api/v2/flags/{projectKey}/{flagKey}/release

Path parameters

projectKeystring string required

The project key

The project key

flagKeystring string required

The flag key

The flag key

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Release response

_linksobject

The location and content type of related resources

namestring required

The release pipeline name

releasePipelineKeystring required

The release pipeline key

releasePipelineDescriptionstring required

The release pipeline description

_versioninteger required

The release version

_releaseVariationIdstring

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

_canceledAtinteger

Example response

{
  "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,
      "_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": {
          "name": "DevOps token",
          "ending": "2345"
        }
      },
      "_audiences": [
        {
          "_id": "1234a56b7c89d012345e678g",
          "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": {
            "requireApproval": true,
            "notifyMemberIds": [
              "1234a56b7c89d012345e678f"
            ],
            "notifyTeamKeys": [
              "example-reviewer-team"
            ],
            "releaseGuardianConfiguration": {
              "monitoringWindowMilliseconds": 60000,
              "rolloutWeight": 50,
              "rollbackOnRegression": true,
              "randomizationUnit": "user"
            }
          },
          "segmentKeys": [
            "segment-key-123abc"
          ]
        }
      ]
    }
  ],
  "_version": 1
}