Skip to main content

workflow_run_approvals

Overview

Nameworkflow_run_approvals
TypeResource
Idgithub.actions.workflow_run_approvals

Fields

NameDatatypeDescription
commentstringThe comment submitted with the deployment review
environmentsarrayThe list of environments that were approved or rejected
statestringWhether deployment to the environment(s) was approved or rejected
userobjectSimple User

Methods

NameAccessible byRequired ParamsDescription
get_reviews_for_runSELECTowner, repo, run_idAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
approve_workflow_runEXECowner, repo, run_idApproves a workflow run for a pull request from a public fork of a first time contributor. For more information, see "Approving workflow runs from public forks."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.