OverviewReleases (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
    }
  ]

Path parameters

projectKeystringRequired
The project key
flagKeystringRequired
The flag key

Headers

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
opstringRequired
The type of operation to perform
pathstringRequired
A JSON Pointer string specifying the part of the document to operate on
valueanyOptional

Response

Release response
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
_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

Errors