GET/actions/run

Get a workflow run associated with a token

The automatic actions token must be used as the authentication mechanism (Authorization: Bearer ${{ forgejo.token }}); other types of tokens cannot be used. The token is associated with the job, which must be still running for the request to this endpoint to succeed.

1 status code
200ActionRun
ScheduleIDintegeroptional

the cron id for the schedule trigger

approved_byintegeroptional

who approved this action run

commit_shastringoptional

the commit sha the action run ran on

createdstringoptional

when the action run was created

durationintegeroptional

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

eventstringoptional

the webhook event that causes the workflow to run

event_payloadstringoptional

the payload of the webhook event that causes the workflow to run

html_urlstringoptional

the url of this action run

idintegeroptional

the action run id

index_in_repointegeroptional

a unique number for each run of a repository

is_fork_pull_requestbooleanoptional

If this is triggered by a PR from a forked repository or an untrusted user, we need to check if it is approved and limit permissions when running the workflow.

is_ref_deletedbooleanoptional

has the commit/tag/… the action run ran on been deleted

need_approvalbooleanoptional

may need approval if it's a fork pull request

prettyrefstringoptional

the commit/tag/… the action run ran on

repositoryobjectoptional

Repository represents a repository

startedstringoptional

when the action run was started

statusstringoptional

the current status of this run

stoppedstringoptional

when the action run was stopped

titlestringoptional

the action run's title

trigger_eventstringoptional

the trigger event defined in the on configuration of the triggered workflow

trigger_userobjectoptional

User represents a user

updatedstringoptional

when the action run was last updated

workflow_idstringoptional

the name of workflow file