Sample - GitHub REST API
GET/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments

Get pending deployments for a workflow run

Get 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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
run_idintegerrequired
The unique identifier of the workflow run.

1 status code
200Response
environmentobjectrequired
wait_timerintegerrequired
The set duration of the wait timer
wait_timer_started_atstringrequired
The time that the wait timer began.
current_user_can_approvebooleanrequired
Whether the currently authenticated user can approve the deployment
reviewersarray<object>required
The 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.