Skip to main content

Patch an action run

PATCH 
/v1/actions/runs/:run_id

This route allows you to patch 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).

To learn more about action runs, check out the documentation.

Request​

Path Parameters

    run_id stringrequired

    The identifier of the action run you want to patch.

Query Parameters

    version string

    Possible values: [v1, v2]

Body

    status string

    Possible values: [SUCCESS, FAILURE]

    statusLabel string

    A label to describe the status of the action run.

    link

    object

    One or more links to be displayed in the run's page in Port. For example, a link to the external logs of the job runner.

    oneOf

    string

    summary string

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

    externalRunId string

    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.

Responses​

Default Response

Loading...
Last updated on