Action Runs

Update an action run

This route allows you to update an action run's details. This can be used to update the run's status & label, and add links to it (e.g. external logs of the job runner).<br/><br/>To learn more about action runs, check out the documentation.

patch/v1/actions/runs/{run_id}

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/actions/runs/{run_id}
  • Auth: API key in header Authorization

Path parameters

run_idstring required

The identifier of the action run.

Query parameters

version'v1' | 'v2'

Specifies the API version to use. Please use v2 for the latest version of the API.

Request body

status'SUCCESS' | 'FAILURE'
statusLabelstring

A label to describe the status of the action run.

messageobject
summarystring

A summary of the action run, which will be displayed in the run's page in Port.

externalRunIdstring

The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the run_id.

Response

OK

okunknown required

Changes

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