Skip to main content

pending_deployments_for_run

Overview

Namepending_deployments_for_run
TypeResource
Idgithub.actions.pending_deployments_for_run

Fields

NameDatatypeDescription
current_user_can_approvebooleanWhether the currently authenticated user can approve the deployment
environmentobject
reviewersarrayThe people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
wait_timerintegerThe set duration of the wait timer
wait_timer_started_atstringThe time that the wait timer began.

Methods

NameAccessible byRequired ParamsDescription
get_pending_deployments_for_runSELECTowner, repo, run_idGet all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone 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.
review_pending_deployments_for_runEXECowner, repo, run_id, data__comment, data__environment_ids, data__stateApprove or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the repo scope to use this endpoint.