Get the status of a GitHub Pages deployment

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.

API method documentation

Parameters

Path Parameters

owner

required

string

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

repo

required

string

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

pages_deployment_id

required

One of:

integer

integer

string

string

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

Responses

200

Response

Media type application/json

GitHub Pages deployment status

object

status

The current status of the deployment.

string

Allowed values: 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

Examples

Example default

{
  "status": "succeed"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}