GitHub: Get pending deployments for a workflow run

← Actions operations · Get started

Operation github.actions_get_pending_deployments_for_run

Provider route: GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsGetPendingDeploymentsForRun"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsGetPendingDeploymentsForRun(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_get_pending_deployments_for_run(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
path.run_id	integer	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Get pending deployments for a workflow run — response body — item

Referenced models: Get pending deployments for a workflow run — response body — item

Schemas

Get pending deployments for a workflow run — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a deployment that is waiting for protection rules to pass
current_user_can_approve	boolean	Required within parent	Whether the currently authenticated user can approve the deployment
environment	object	Required within parent
environment.html_url	string	Optional
environment.id	JSON	Optional
environment.id (anyOf 1)	integer	Alternative	The id of the environment. Format: int64
environment.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
environment.name	string	Optional	The name of the environment.
environment.node_id	string	Optional
environment.url	string	Optional
reviewers	array	Required within parent	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.
reviewers[]	object	Each item
reviewers[].reviewer	JSON	Optional
reviewers[].reviewer (anyOf 1)	Model	Alternative	Expand List users — response body — item
reviewers[].reviewer (anyOf 2)	Model	Alternative	Expand List teams — response body — item
reviewers[].type	string	Optional	The type of reviewer. Known values: User, Team
wait_timer	JSON	Required within parent
wait_timer (anyOf 1)	integer	Alternative	The set duration of the wait timer
wait_timer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
wait_timer_started_at	JSON	Required within parent
wait_timer_started_at (anyOf 1)	string	Alternative	The time that the wait timer began. Format: date-time
wait_timer_started_at (anyOf 2)	null	Alternative

Referenced models: List users — response body — item, List teams — response body — item

List users — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub user.
avatar_url	string	Required within parent	Format: uri
email	JSON	Optional
email (anyOf 1)	string	Alternative
email (anyOf 2)	null	Alternative
events_url	string	Required within parent
followers_url	string	Required within parent	Format: uri
following_url	string	Required within parent
gists_url	string	Required within parent
gravatar_id	JSON	Required within parent
gravatar_id (anyOf 1)	string	Alternative
gravatar_id (anyOf 2)	null	Alternative
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
login	string	Required within parent
name	JSON	Optional
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
node_id	string	Required within parent
organizations_url	string	Required within parent	Format: uri
received_events_url	string	Required within parent	Format: uri
repos_url	string	Required within parent	Format: uri
site_admin	boolean	Required within parent
starred_at	string	Optional
starred_url	string	Required within parent
subscriptions_url	string	Required within parent	Format: uri
type	string	Required within parent
url	string	Required within parent	Format: uri
user_view_type	string	Optional

List teams — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
access_source	string	Optional	How the team's access to the repository was granted. This property is only present when the team is returned in a repository context, such as `GET /repos/{owner}/{repo}/teams`. Known values: direct, organization, enterprise
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
members_url	string	Required within parent
name	string	Required within parent
node_id	string	Required within parent
notification_setting	string	Optional
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parent	Model	Required within parent	Expand Create a team — response body — parent
permission	string	Required within parent
permissions	object	Optional
permissions.admin	boolean	Required within parent
permissions.maintain	boolean	Required within parent
permissions.pull	boolean	Required within parent
permissions.push	boolean	Required within parent
permissions.triage	boolean	Required within parent
privacy	string	Optional
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	Format: uri

Referenced models: Create a team — response body — parent

Create a team — response body — parent

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a team — response body — parent / type: enterprise, organization
$ (anyOf 2)	null	Alternative

Referenced models: Create a team — response body — parent / type: enterprise, organization

Create a team — response body — parent / type: enterprise, organization

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Description of the team
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the team
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ldap_dn	string	Optional	Distinguished Name (DN) that team maps to within LDAP environment
members_url	string	Required within parent
name	string	Required within parent	Name of the team
node_id	string	Required within parent
notification_setting	string	Optional	The notification setting the team has set
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permission	string	Required within parent	Permission that the team will have for its repositories
privacy	string	Optional	The level of privacy this team should have
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	URL for the team Format: uri

Policy, approvals and errors

SDK function policy ID: github.actions_get_pending_deployments_for_run. Catalog operation: actions/get-pending-deployments-for-run. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source