`releases`

Open an operation to see its authentication, its parameters and the fields of its request and response.

5 operations

GET`/v1/releases`

Release history with CI status, newest first, plus the open batched proposals.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/releases
Name	Type	Description
`cursor`query	`string`
`limit`query	`integer`
`workspace_id`query	`string`
`repository_id`query	`string`
`status`query	`array of enum`

Response `200`

Response, GET /v1/releases
Name	Type	Description
`items`required	`array of object`
`items[].id`required	`string`
`items[].org_id`required	`string`
`items[].workspace_id`required	`string`
`items[].repository_id`required	`string`
`items[].tag`required	`string`
`items[].version`required	`string`
`items[].sha`required	`string`
`items[].merged_sha`required	`string`
`items[].status`required	`enum`	Values `proposed \| approved \| merging \| tagged \| ci_running \| succeeded \| failed`
`items[].ci_status`required	`enum`	Values `pending \| running \| success \| failure \| none`
`items[].changelog_md`required	`string`
`items[].public_notes_md`required	`string`
`items[].ticket_ids`required	`array of string`
`items[].github_release_id`required	`integer`
`items[].ci_run_ids`required	`array of integer`
`items[].approval_id`required	`string`
`items[].approved_by_user_id`required	`string`
`items[].released_at`required	`string (date-time)`
`items[].notified_at`required	`string (date-time)`
`items[].created_at`required	`string (date-time)`
`items[].updated_at`required	`string (date-time)`
`items[].repository_full_name`required	`string`
`items[].workspace_name`required	`string`
`items[].client_name`required	`string`
`items[].tag_url`required	`string (uri)`
`items[].github_release_url`required	`string (uri)`
`items[].ci_runs`required	`array of object`
`items[].ci_runs[].id`required	`integer`
`items[].ci_runs[].name`required	`string`
`items[].ci_runs[].status`required	`string`
`items[].ci_runs[].conclusion`required	`string`
`items[].ci_runs[].url`required	`string (uri)`
`items[].batched`required	`boolean`
`items[].waiting_for`required	`enum`	Values `checks \| human_merge \| merge_queue \| version \| ci \| approval`
`items[].failure_reason`required	`string`
`next_cursor`required	`string`
`proposals`required	`array of object`
`proposals[].id`required	`string`
`proposals[].org_id`required	`string`
`proposals[].workspace_id`required	`string`
`proposals[].repository_id`required	`string`
`proposals[].tag`required	`string`
`proposals[].version`required	`string`
`proposals[].sha`required	`string`
`proposals[].merged_sha`required	`string`
`proposals[].status`required	`enum`	Values `proposed \| approved \| merging \| tagged \| ci_running \| succeeded \| failed`
`proposals[].ci_status`required	`enum`	Values `pending \| running \| success \| failure \| none`
`proposals[].changelog_md`required	`string`
`proposals[].public_notes_md`required	`string`
`proposals[].ticket_ids`required	`array of string`
`proposals[].github_release_id`required	`integer`
`proposals[].ci_run_ids`required	`array of integer`
`proposals[].approval_id`required	`string`
`proposals[].approved_by_user_id`required	`string`
`proposals[].released_at`required	`string (date-time)`
`proposals[].notified_at`required	`string (date-time)`
`proposals[].created_at`required	`string (date-time)`
`proposals[].updated_at`required	`string (date-time)`
`proposals[].repository_full_name`required	`string`
`proposals[].workspace_name`required	`string`
`proposals[].client_name`required	`string`
`proposals[].tag_url`required	`string (uri)`
`proposals[].github_release_url`required	`string (uri)`
`proposals[].ci_runs`required	`array of object`
`proposals[].ci_runs[].id`required	`integer`
`proposals[].ci_runs[].name`required	`string`
`proposals[].ci_runs[].status`required	`string`
`proposals[].ci_runs[].conclusion`required	`string`
`proposals[].ci_runs[].url`required	`string (uri)`
`proposals[].batched`required	`boolean`
`proposals[].waiting_for`required	`enum`	Values `checks \| human_merge \| merge_queue \| version \| ci \| approval`
`proposals[].failure_reason`required	`string`

GET`/v1/releases/{id}`

A release with its tickets, approvals, CI runs and pipeline log.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/releases/{id}
Name	Type	Description
`id`pathrequired	`string`

Response `200`

Response, GET /v1/releases/{id}
Name	Type	Description
`id`required	`string`
`org_id`required	`string`
`workspace_id`required	`string`
`repository_id`required	`string`
`tag`required	`string`
`version`required	`string`
`sha`required	`string`
`merged_sha`required	`string`
`status`required	`enum`	Values `proposed \| approved \| merging \| tagged \| ci_running \| succeeded \| failed`
`ci_status`required	`enum`	Values `pending \| running \| success \| failure \| none`
`changelog_md`required	`string`
`public_notes_md`required	`string`
`ticket_ids`required	`array of string`
`github_release_id`required	`integer`
`ci_run_ids`required	`array of integer`
`approval_id`required	`string`
`approved_by_user_id`required	`string`
`released_at`required	`string (date-time)`
`notified_at`required	`string (date-time)`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`repository_full_name`required	`string`
`workspace_name`required	`string`
`client_name`required	`string`
`tag_url`required	`string (uri)`
`github_release_url`required	`string (uri)`
`ci_runs`required	`array of object`
`ci_runs[].id`required	`integer`
`ci_runs[].name`required	`string`
`ci_runs[].status`required	`string`
`ci_runs[].conclusion`required	`string`
`ci_runs[].url`required	`string (uri)`
`batched`required	`boolean`
`waiting_for`required	`enum`	Values `checks \| human_merge \| merge_queue \| version \| ci \| approval`
`failure_reason`required	`string`
`tickets`required	`array of object`
`tickets[].id`required	`string`
`tickets[].subject`required	`string`
`tickets[].state`required	`enum`	Values `received \| triage \| needs_info \| draft_ready \| answered \| fixing \| awaiting_approval \| releasing \| customer_notified \| closed \| escalated`
`tickets[].public_state`required	`enum`	Values `in_analysis \| needs_reply \| answered \| fix_in_progress \| releasing \| resolved \| team_review`
`tickets[].public_summary`required	`string`
`tickets[].pr_number`required	`integer`
`tickets[].pr_url`required	`string (uri)`
`approvals`required	`array of object`
`approvals[].id`required	`string`
`approvals[].org_id`required	`string`
`approvals[].kind`required	`enum`	Values `fix \| release`
`approvals[].ticket_id`required	`string`
`approvals[].fix_attempt_id`required	`string`
`approvals[].release_id`required	`string`
`approvals[].user_id`required	`string`
`approvals[].decision`required	`enum`	Values `approved \| rejected \| changes_requested`
`approvals[].approved_sha`required	`string`
`approvals[].comment`required	`string`
`approvals[].github_review_id`required	`integer`
`approvals[].created_at`required	`string (date-time)`
`people`required	`array of object`
`people[].id`required	`string`
`people[].name`required	`string`
`events`required	`array of object`
`events[].id`required	`string`
`events[].job_id`required	`string`
`events[].level`required	`enum`	Values `info \| warn \| error`
`events[].type`required	`string`
`events[].message`required	`string`
`events[].created_at`required	`string (date-time)`
`proposal`required	`object`
`proposal.approved_sha`required	`string`
`proposal.proposed_version`required	`string`
`proposal.strategy`required	`enum`	Values `semver \| calver \| manual`
`proposal.version_required`required	`boolean`
`proposal.approvers`required	`integer`
`proposal.required`required	`integer`
`proposal.approved_by_viewer`required	`boolean`
`can_approve`required	`boolean`
`retry`required	`object`
`retry.version_allowed`required	`boolean`

POST`/v1/releases/{id}/approve`

Approves a batched release proposal at the given SHA: tag, release and CI follow.

Authentication: Dashboard session

Parameters

Parameters, POST /v1/releases/{id}/approve
Name	Type	Description
`id`pathrequired	`string`

Request body

Request body, POST /v1/releases/{id}/approve
Name	Type	Description
`approved_sha`required	`string`
`version`	`string`
`comment`	`string`

Response `200`

The same fields as GET /v1/releases/{id}.

POST`/v1/releases/{id}/retry`

Resumes a release that stopped after the merge: tag, GitHub Release, CI, notice.

Authentication: Dashboard session

Parameters

Parameters, POST /v1/releases/{id}/retry
Name	Type	Description
`id`pathrequired	`string`

Request body

Request body, POST /v1/releases/{id}/retry
Name	Type	Description
`version`	`string`

Response `200`

The same fields as GET /v1/releases/{id}.

POST`/v1/releases/{id}/version`

Sets the version of a release that waits for one (manual strategy).

Authentication: Dashboard session

Parameters

Parameters, POST /v1/releases/{id}/version
Name	Type	Description
`id`pathrequired	`string`

Request body

Request body, POST /v1/releases/{id}/version
Name	Type	Description
`version`required	`string`

Response `200`

The same fields as GET /v1/releases/{id}.

Name

Type

Description

cursorquery

string

limitquery

integer

workspace_idquery

string

repository_idquery

string

statusquery

array of enum

Name

Type

Description

itemsrequired

array of object

items[].idrequired

string

items[].org_idrequired

string

items[].workspace_idrequired

string

items[].repository_idrequired

string

items[].tagrequired

string

items[].versionrequired

string

items[].sharequired

string

items[].merged_sharequired

string

items[].statusrequired

enum

items[].ci_statusrequired

enum

Values pending | running | success | failure | none

items[].changelog_mdrequired

string

items[].public_notes_mdrequired

string

items[].ticket_idsrequired

array of string

items[].github_release_idrequired

integer

items[].ci_run_idsrequired

array of integer

items[].approval_idrequired

string

items[].approved_by_user_idrequired

string

items[].released_atrequired

string (date-time)

items[].notified_atrequired

string (date-time)

items[].created_atrequired

string (date-time)

items[].updated_atrequired

string (date-time)

items[].repository_full_namerequired

string

items[].workspace_namerequired

string

items[].client_namerequired

string

items[].tag_urlrequired

string (uri)

items[].github_release_urlrequired

string (uri)

items[].ci_runsrequired

array of object

items[].ci_runs[].idrequired

integer

items[].ci_runs[].namerequired

string

items[].ci_runs[].statusrequired

string

items[].ci_runs[].conclusionrequired

string

items[].ci_runs[].urlrequired

string (uri)

items[].batchedrequired

boolean

items[].waiting_forrequired

enum

items[].failure_reasonrequired

string

next_cursorrequired

string

proposalsrequired

array of object

proposals[].idrequired

string

proposals[].org_idrequired

string

proposals[].workspace_idrequired

string

proposals[].repository_idrequired

string

proposals[].tagrequired

string

proposals[].versionrequired

string

proposals[].sharequired

string

proposals[].merged_sharequired

string

proposals[].statusrequired

enum

proposals[].ci_statusrequired

enum

Values pending | running | success | failure | none

proposals[].changelog_mdrequired

string

proposals[].public_notes_mdrequired

string

proposals[].ticket_idsrequired

array of string

proposals[].github_release_idrequired

integer

proposals[].ci_run_idsrequired

array of integer

proposals[].approval_idrequired

string

proposals[].approved_by_user_idrequired

string

proposals[].released_atrequired

string (date-time)

proposals[].notified_atrequired

string (date-time)

proposals[].created_atrequired

string (date-time)

proposals[].updated_atrequired

string (date-time)

proposals[].repository_full_namerequired

string

proposals[].workspace_namerequired

string

proposals[].client_namerequired

string

proposals[].tag_urlrequired

string (uri)

proposals[].github_release_urlrequired

string (uri)

proposals[].ci_runsrequired

array of object

proposals[].ci_runs[].idrequired

integer

proposals[].ci_runs[].namerequired

string

proposals[].ci_runs[].statusrequired

string

proposals[].ci_runs[].conclusionrequired

string

proposals[].ci_runs[].urlrequired

string (uri)

proposals[].batchedrequired

boolean

proposals[].waiting_forrequired

enum

proposals[].failure_reasonrequired

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

idrequired

string

org_idrequired

string

workspace_idrequired

string

repository_idrequired

string

tagrequired

string

versionrequired

string

sharequired

string

merged_sharequired

string

statusrequired

enum

ci_statusrequired

enum

Values pending | running | success | failure | none

changelog_mdrequired

string

public_notes_mdrequired

string

ticket_idsrequired

array of string

github_release_idrequired

integer

ci_run_idsrequired

array of integer

approval_idrequired

string

approved_by_user_idrequired

string

released_atrequired

string (date-time)

notified_atrequired

string (date-time)

created_atrequired

string (date-time)

updated_atrequired

string (date-time)

repository_full_namerequired

string

workspace_namerequired

string

client_namerequired

string

tag_urlrequired

string (uri)

github_release_urlrequired

string (uri)

ci_runsrequired

array of object

ci_runs[].idrequired

integer

ci_runs[].namerequired

string

ci_runs[].statusrequired

string

ci_runs[].conclusionrequired

string

ci_runs[].urlrequired

string (uri)

batchedrequired

boolean

waiting_forrequired

enum

failure_reasonrequired

string

ticketsrequired

array of object

tickets[].idrequired

string

tickets[].subjectrequired

string

tickets[].staterequired

enum

Values

received | triage | needs_info | draft_ready | answered | fixing | awaiting_approval | releasing | customer_notified | closed | escalated

tickets[].public_staterequired

enum

tickets[].public_summaryrequired

string

tickets[].pr_numberrequired

integer

tickets[].pr_urlrequired

string (uri)

approvalsrequired

array of object

approvals[].idrequired

string

approvals[].org_idrequired

string

approvals[].kindrequired

enum

Values fix | release

approvals[].ticket_idrequired

string

approvals[].fix_attempt_idrequired

string

approvals[].release_idrequired

string

approvals[].user_idrequired

string

approvals[].decisionrequired

enum

Values approved | rejected | changes_requested

approvals[].approved_sharequired

string

approvals[].commentrequired

string

approvals[].github_review_idrequired

integer

approvals[].created_atrequired

string (date-time)

peoplerequired

array of object

people[].idrequired

string

people[].namerequired

string

eventsrequired

array of object

events[].idrequired

string

events[].job_idrequired

string

events[].levelrequired

enum

Values info | warn | error

events[].typerequired

string

events[].messagerequired

string

events[].created_atrequired

string (date-time)

proposalrequired

object

proposal.approved_sharequired

string

proposal.proposed_versionrequired

string

proposal.strategyrequired

enum

Values semver | calver | manual

proposal.version_requiredrequired

boolean

proposal.approversrequired

integer

proposal.requiredrequired

integer

proposal.approved_by_viewerrequired

boolean

can_approverequired

boolean

retryrequired

object

retry.version_allowedrequired

boolean

Name

Type

Description

idpathrequired

string

Name

Type

Description

approved_sharequired

string

version

string

comment

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

version

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

versionrequired

string

GET/v1/releases

Parameters

Response 200

GET/v1/releases/{id}

Parameters

Response 200

POST/v1/releases/{id}/approve

Parameters

Request body

Response 200

POST/v1/releases/{id}/retry

Parameters

Request body

Response 200

POST/v1/releases/{id}/version

Parameters

Request body

Response 200

GET/v1/releases

Parameters

Response 200

GET/v1/releases/{id}

Parameters

Response 200

POST/v1/releases/{id}/approve

Parameters

Request body

Response 200

POST/v1/releases/{id}/retry

Parameters

Request body

Response 200

POST/v1/releases/{id}/version

Parameters

Request body

Response 200

GET`/v1/releases`

Response `200`

GET`/v1/releases/{id}`

Response `200`

POST`/v1/releases/{id}/approve`

Response `200`

POST`/v1/releases/{id}/retry`

Response `200`

POST`/v1/releases/{id}/version`

Response `200`

GET`/v1/releases`

Response `200`

GET`/v1/releases/{id}`

Response `200`

POST`/v1/releases/{id}/approve`

Response `200`

POST`/v1/releases/{id}/retry`

Response `200`

POST`/v1/releases/{id}/version`

Response `200`