Get pending deployments for a workflow run

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments

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, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///actions/runs//pending_deployments'

Response Example

[
    {
        "current_user_can_approve": true,
        "environment": {
            "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
            "id": 56780428,
            "name": "staging",
            "node_id": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=",
            "url": "https://api.github.com/repos/github/hello-world/environments/staging"
        },
        "reviewers": [
            {
                "reviewer": {
                    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
                    "email": "string",
                    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
                    "followers_url": "https://api.github.com/users/octocat/followers",
                    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
                    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
                    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
                    "html_url": "https://github.com/octocat",
                    "id": 1,
                    "login": "octocat",
                    "name": "string",
                    "node_id": "MDQ6VXNlcjE=",
                    "organizations_url": "https://api.github.com/users/octocat/orgs",
                    "received_events_url": "https://api.github.com/users/octocat/received_events",
                    "repos_url": "https://api.github.com/users/octocat/repos",
                    "site_admin": true,
                    "starred_at": "\"2020-07-09T00:17:55Z\"",
                    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
                    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
                    "type": "User",
                    "url": "https://api.github.com/users/octocat"
                },
                "type": "User"
            }
        ],
        "wait_timer": 30,
        "wait_timer_started_at": "2020-11-23T22:00:40.000Z"
    }
]

Request

Path Params

owner

string

required

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

repo

string

required

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

run_id

integer

required

The unique identifier of the workflow run.

Responses

🟢200Response

application/json

Body

array of:

current_user_can_approve

boolean

required

Whether the currently authenticated user can approve the deployment

Example:

true

environment

object

required

html_url

string

optional

Example:

https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging

integer

optional

The id of the environment.

Example:

56780428

name

string

optional

The name of the environment.

Example:

staging

node_id

string

optional

Example:

MDExOkVudmlyb25tZW50NTY3ODA0Mjg=

url

string

optional

Example:

https://api.github.com/repos/github/hello-world/environments/staging

reviewers

array [object {2}]

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.

reviewer

optional

type

enum<string>

optional

The type of reviewer.

Allowed values:

UserTeam

Example:

User

wait_timer

integer

required

The set duration of the wait timer

Example:

wait_timer_started_at

string <date-time> | null

required

The time that the wait timer began.

Example:

2020-11-23T22:00:40.000Z

Modified at 2023-08-15 02:59:28

Download workflow run logs

Review pending deployments for a workflow run