Cancel a GitHub Pages deployment
POST
/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel https://api.github.com
Cancels a GitHub Pages deployment.
The authenticated user must have write permissions for the GitHub Pages site.
Parameters
path Path Parameters
| Name | Type |
|---|---|
owner
required
The account owner of the repository. The name is not case sensitive. | string |
repo
required
The name of the repository without the | string |
pages_deployment_id
required
The ID of the Pages deployment. You can also give the commit SHA of the deployment. | string | number |
Responses
204
A header with no content is returned.
unknown
Client Errors
404 application/json
Resource not found
interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}