provider actions POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
@utdk/github /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Review pending deployments for a workflow run
Approve 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. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
run_id path required
The unique identifier of the workflow run.
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

actions.reviewPendingDeploymentsForRun
POST/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Approve 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. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

required

The unique identifier of the workflow run.

Input

required

The list of environment ids to approve or reject

required

Whether to approve or reject deployment to the specified environments.

required

A comment to accompany the deployment review

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.actions.reviewPendingDeploymentsForRun()