Update phase status for release | LaunchDarkly

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

{
  "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,
      "_audiences": [
        {
          "_id": "1234a56b7c89d012345e678g",
          "name": "Phase 1 - Testing",
          "_links": {},
          "environment": {
            "_links": {
              "self": {
                "href": "/api/v2/projects/my-project/environments/my-environment",
                "type": "application/json"
              }
            },
            "key": "environment-key-123abc",
            "name": "My Environment",
            "color": "F5A623"
          },
          "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"
          ]
        }
      ],
      "_completionDate": 1684262711509,
      "_completedBy": {
        "member": {
          "_links": {
            "self": {
              "href": "/api/v2/members/569f183514f4432160000007",
              "type": "application/json"
            }
          },
          "_id": "569f183514f4432160000007",
          "role": "admin",
          "email": "ariel@acme.com",
          "firstName": "Ariel",
          "lastName": "Flores"
        },
        "token": {
          "_links": {},
          "_id": "string",
          "name": "DevOps token",
          "ending": "2345",
          "serviceToken": false
        }
      },
      "status": "Started",
      "started": true,
      "_startedDate": 1,
      "configuration": {}
    }
  ],
  "_version": 1,
  "_links": {},
  "_releaseVariationId": "string",
  "_canceledAt": 1684262711507
}

Updates the execution status of a phase of a release

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

flagKeystringRequiredformat: "string"

The flag key

phaseIdstringRequiredformat: "string"

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

The location and content type of related resources

_releaseVariationIdstring

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

_canceledAtlong

Timestamp of when the release was canceled

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error