v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Releases (beta)

Update phase status for release

Updates the execution status of a phase of a release

put/api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}

Path parameters

projectKeystring string required

The project key

flagKeystring string required

The flag key

phaseIdstring string required

The phase ID

Request body

statusstring

Example request

{
  "audiences": [
    {
      "releaseGuardianConfiguration": {
        "monitoringWindowMilliseconds": 60000,
        "rolloutWeight": 50,
        "rollbackOnRegression": true,
        "randomizationUnit": "user"
      },
      "notifyMemberIds": [
        "1234a56b7c89d012345e678f"
      ],
      "notifyTeamKeys": [
        "example-reviewer-team"
      ]
    }
  ]
}

Response

Action succeeded

_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
}