Release pipelines (beta)

Get release progressions for release pipeline

GET
/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases

Get details on the progression of all releases, across all flags, for a release pipeline

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
pipelineKey*string

The pipeline key

Formatstring

Query Parameters

filter?string

Accepts filter by status and activePhaseId. status can take a value of completed or active. activePhaseId takes a UUID and will filter results down to releases active on the specified phase. Providing status equals completed along with an activePhaseId filter will return an error as they are disjoint sets of data. The combination of status equals active and activePhaseId will return the same results as activePhaseId alone.

Formatstring
limit?integer

The maximum number of items to return. Defaults to 20.

Formatint64
offset?integer

Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Formatint64

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v2/projects/string/release-pipelines/string/releases"
{  "activeCount": 3,  "completedCount": 1,  "items": [    {      "_createdAt": "1684262711507",      "_completedAt": "1684262711509",      "flagKey": "flag-key-123abc",      "activePhaseId": "1234a56b7c89d012345e678f",      "activePhaseStatus": "active",      "_links": {        "property1": {          "href": "string",          "type": "string"        },        "property2": {          "href": "string",          "type": "string"        }      }    }  ],  "phases": [    {      "_id": "1234a56b7c89d012345e678f",      "name": "Phase 1 - Testing",      "releaseCount": 2    }  ],  "totalCount": 8,  "_links": {    "property1": {      "href": "string",      "type": "string"    },    "property2": {      "href": "string",      "type": "string"    }  }}