Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.2 MB
repos

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.

get/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}

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

Response

status'deployment_in_progress' | 'syncing_files' | 'finished_file_sync' | 'updating_pages' | 'purging_cdn' | 'deployment_cancelled' | 'deployment_failed' | 'deployment_content_failed' | 'deployment_attempt_error' | 'deployment_lost' | 'succeed'

The current status of the deployment.