RUrunway
release

List releases

get/v2/app/{appId}/releases

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/v2/app/{appId}/releases
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

Query parameters

timelinePhase'upcoming' | 'current' | 'completed'

The timeline phase of the release

Filter releases by timeline phase

limitinteger

For pagination, the maximum number of releases to return

offsetinteger

For pagination, the number of releases to skip before returning the first release

Response

A list of releases

idstring required

The id of the release

versionstring required

The release version

displayableVersionstring

Human-readable version

status'active' | 'completed' | 'canceled' required

The status of a release

type'major' | 'minor' | 'point' | 'hotfix' | 'rollback' required

The type of release

timelinePhase'upcoming' | 'current' | 'completed' required

The timeline phase of the release

releaseBranchstring

The detected release branch for the release

createdAtstring date-time required

The date and time when the release was created in Runway

updatedAtstring date-time

The date and time when the release was last updated in Runway

completedAtstring date-time

The date and time when the release was marked as completed in Runway.

targetKickoffDatestring date-time

The target kickoff date and time for the release

targetSubmissionDatestring date-time

The target submission date and time for the release

targetReleaseDatestring date-time

The target release date and time for the release

releasePilotIdstring

The release pilot for the release

releaseSummarystring

The automatically generated summary of the release.

releaseDescriptionstring

Free-text description / planning summary for the release.

Example response

[
  {
    "id": "fake-app:1.0.0",
    "version": "1.0.0",
    "displayableVersion": "1.0.0",
    "releaseBranch": "release-1.0.0",
    "createdAt": "2022-03-02T01:15:00Z",
    "updatedAt": "2022-03-02T01:15:00Z",
    "completedAt": "2022-03-02T01:15:00Z",
    "targetKickoffDate": "2022-03-02T01:15:00Z",
    "targetSubmissionDate": "2022-03-02T01:15:00Z",
    "targetReleaseDate": "2022-03-02T01:15:00Z",
    "releasePilotId": "sully@example.com"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.