provider repos GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}
@utdk/github /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}
Get the status of a GitHub Pages deployment
Gets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site.
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
pages_deployment_id path required
The ID of the Pages deployment. You can also give the commit SHA of the deployment.

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.

repos.getPagesDeployment
GET/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}
Gets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site.

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 ID of the Pages deployment. You can also give the commit SHA of the deployment.

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.repos.getPagesDeployment()