GIgithub
repos

Cancel a GitHub Pages deployment

Cancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site.

post/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel

Request

  • Base URL
    https://api.github.com
  • URL
    https://api.github.com/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel
  • Auth
    none declared

Path parameters

ownerstring required

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

repostring required

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

integer required
OR
string required

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

Response

A header with no content is returned.

Changes

No recorded changes to this operation across all 89 revisions of this API.