Get the status of a GitHub Pages deployment

3 parameters

ownerstringrequired

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

repostringrequired

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

pages_deployment_idintegerrequired

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

2 status codes

200Response

statusstringoptional

The current status of the deployment.

Allowed:deployment_in_progresssyncing_filesfinished_file_syncupdating_pagespurging_cdndeployment_cancelleddeployment_faileddeployment_content_faileddeployment_attempt_errordeployment_lostsucceed

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.deployments.get({
  owner: "octocat",
  repo: "hello-world",
  pagesDeploymentId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "status": "succeed"
}

Request

Response

Errors