provider repos POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel
@utdk/github /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel
Cancel a GitHub Pages deployment
Cancels a GitHub Pages deployment. The authenticated user must have write permissions 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
repos.cancelPagesDeployment
POST/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel
Cancels a GitHub Pages deployment. The authenticated user must have write permissions 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.

Configure credentials above to enable sending.

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

TypeScript

import github from '@utdk/github';

await github.repos.cancelPagesDeployment()