GitHub v3 REST API
  1. repos
GitHub v3 REST API
  • meta
    • GitHub API Root
    • Get GitHub meta information
    • Get Octocat
    • Get all API versions
    • Get the Zen of GitHub
  • apps
    • Get the authenticated app
    • Create a GitHub App from a manifest
    • Get a webhook configuration for an app
    • Update a webhook configuration for an app
    • List deliveries for an app webhook
    • Get a delivery for an app webhook
    • Redeliver a delivery for an app webhook
    • List installations for the authenticated app
    • Delete an installation for the authenticated app
    • Get an installation for the authenticated app
    • Create an installation access token for an app
    • Revoke a grant for an application
    • Unsuspend an app installation
    • Suspend an app installation
    • Delete an app authorization
    • Delete an app token
    • Reset a token
    • Check a token
    • Revoke an authorization for an application
    • Create a scoped access token
    • Check an authorization
    • Reset an authorization
    • Get an app
    • List repositories accessible to the app installation
    • Create a content attachment
    • Revoke an installation access token
    • Get a subscription plan for an account
    • List plans
    • List accounts for a plan
    • Get a subscription plan for an account (stubbed)
    • List plans (stubbed)
    • List accounts for a plan (stubbed)
    • Get an organization installation for the authenticated app
    • Get a repository installation for the authenticated app
    • List app installations accessible to the user access token
    • List repositories accessible to the user access token
    • Remove a repository from an app installation
    • Add a repository to an app installation
    • List subscriptions for the authenticated user
    • List subscriptions for the authenticated user (stubbed)
    • Get a user installation for the authenticated app
  • oauth-authorizations
    • List your grants
    • Delete a grant
    • Get a single grant
    • List your authorizations
    • Create a new authorization
    • Get-or-create an authorization for a specific app
    • Get-or-create an authorization for a specific app and fingerprint
    • Delete an authorization
    • Get a single authorization
    • Update an existing authorization
  • codes-of-conduct
    • Get all codes of conduct
    • Get a code of conduct
    • Get the code of conduct for a repository
  • emojis
    • Get emojis
  • enterprise-admin
    • Get GitHub Actions permissions for an enterprise
    • Set GitHub Actions permissions for an enterprise
    • List selected organizations enabled for GitHub Actions in an enterprise
    • Set selected organizations enabled for GitHub Actions in an enterprise
    • Disable a selected organization for GitHub Actions in an enterprise
    • Enable a selected organization for GitHub Actions in an enterprise
    • Get allowed actions for an enterprise
    • Set allowed actions for an enterprise
    • List self-hosted runner groups for an enterprise
    • Create a self-hosted runner group for an enterprise
    • Delete a self-hosted runner group from an enterprise
    • Get a self-hosted runner group for an enterprise
    • Update a self-hosted runner group for an enterprise
    • List organization access to a self-hosted runner group in an enterprise
    • Set organization access for a self-hosted runner group in an enterprise
    • Remove organization access to a self-hosted runner group in an enterprise
    • Add organization access to a self-hosted runner group in an enterprise
    • List self-hosted runners in a group for an enterprise
    • Set self-hosted runners in a group for an enterprise
    • Remove a self-hosted runner from a group for an enterprise
    • Add a self-hosted runner to a group for an enterprise
    • List self-hosted runners for an enterprise
    • List runner applications for an enterprise
    • Create a registration token for an enterprise
    • Create a remove token for an enterprise
    • Delete a self-hosted runner from an enterprise
    • Get a self-hosted runner for an enterprise
    • List provisioned SCIM groups for an enterprise
    • Provision a SCIM enterprise group and invite users
    • Delete a SCIM group from an enterprise
    • Get SCIM provisioning information for an enterprise group
    • Update an attribute for a SCIM enterprise group
    • Set SCIM information for a provisioned enterprise group
    • List SCIM provisioned identities for an enterprise
    • Provision and invite a SCIM enterprise user
    • Delete a SCIM user from an enterprise
    • Get SCIM provisioning information for an enterprise user
    • Update an attribute for a SCIM enterprise user
    • Set SCIM information for a provisioned enterprise user
  • audit-log
    • Get the audit log for an enterprise
  • billing
    • Get GitHub Actions billing for an enterprise
    • Get GitHub Actions billing for an organization
    • Get GitHub Packages billing for an enterprise
    • Get GitHub Packages billing for an organization
    • Get shared storage billing for an enterprise
    • Get shared storage billing for an organization
    • Get GitHub Actions billing for a user
    • Get GitHub Packages billing for a user
    • Get shared storage billing for a user
  • activity
    • List public events
    • Get feeds
    • List public events for a network of repositories
    • List notifications for the authenticated user
    • Mark notifications as read
    • Get a thread
    • Mark a thread as read
    • Delete a thread subscription
    • Get a thread subscription for the authenticated user
    • Set a thread subscription
    • List public organization events
    • List repository events
    • List repository notifications for the authenticated user
    • Mark repository notifications as read
    • List stargazers
    • List watchers
    • Delete a repository subscription
    • Get a repository subscription
    • Set a repository subscription
    • List repositories starred by the authenticated user
    • Unstar a repository for the authenticated user
    • Check if a repository is starred by the authenticated user
    • Star a repository for the authenticated user
    • List repositories watched by the authenticated user
    • List events for the authenticated user
    • List organization events for the authenticated user
    • List public events for a user
    • List events received by the authenticated user
    • List public events received by a user
    • List repositories starred by a user
    • List repositories watched by a user
  • gists
    • List gists for the authenticated user
    • Create a gist
    • List public gists
    • List starred gists
    • Delete a gist
    • Get a gist
    • Update a gist
    • List gist comments
    • Create a gist comment
    • Delete a gist comment
    • Get a gist comment
    • Update a gist comment
    • List gist commits
    • List gist forks
    • Fork a gist
    • Unstar a gist
    • Check if a gist is starred
    • Star a gist
    • Get a gist revision
    • List gists for a user
  • gitignore
    • Get all gitignore templates
    • Get a gitignore template
  • issues
    • List issues assigned to the authenticated user
    • List organization issues assigned to the authenticated user
    • List assignees
    • Check if a user can be assigned
    • List repository issues
    • Create an issue
    • List issue comments for a repository
    • Delete an issue comment
    • Get an issue comment
    • Update an issue comment
    • List issue events for a repository
    • Get an issue event
    • Get an issue
    • Update an issue
    • Remove assignees from an issue
    • Add assignees to an issue
    • Check if a user can be assigned to a issue
    • List issue comments
    • Create an issue comment
    • List issue events
    • Remove all labels from an issue
    • List labels for an issue
    • Add labels to an issue
    • Set labels for an issue
    • Remove a label from an issue
    • Unlock an issue
    • Lock an issue
    • List timeline events for an issue
    • List labels for a repository
    • Create a label
    • Delete a label
    • Get a label
    • Update a label
    • List milestones
    • Create a milestone
    • Delete a milestone
    • Get a milestone
    • Update a milestone
    • List labels for issues in a milestone
    • List user account issues assigned to the authenticated user
  • licenses
    • Get all commonly used licenses
    • Get a license
    • Get the license for a repository
  • markdown
    • Render a Markdown document
    • Render a Markdown document in raw mode
  • orgs
    • List organizations
    • Get an organization
    • Update an organization
    • Get the audit log for an organization
    • List users blocked by an organization
    • Unblock a user from an organization
    • Check if a user is blocked by an organization
    • Block a user from an organization
    • List failed organization invitations
    • List SAML SSO authorizations for an organization
    • List organization webhooks
    • Remove a SAML SSO authorization for an organization
    • Create an organization webhook
    • Delete an organization webhook
    • Get an organization webhook
    • Update an organization webhook
    • Get a webhook configuration for an organization
    • Update a webhook configuration for an organization
    • List deliveries for an organization webhook
    • Get a webhook delivery for an organization webhook
    • Redeliver a delivery for an organization webhook
    • Ping an organization webhook
    • List app installations for an organization
    • List pending organization invitations
    • Create an organization invitation
    • Cancel an organization invitation
    • List organization invitation teams
    • List organization members
    • Remove an organization member
    • Check organization membership for a user
    • Remove organization membership for a user
    • Get organization membership for a user
    • Set organization membership for a user
    • List outside collaborators for an organization
    • Remove outside collaborator from an organization
    • Convert an organization member to outside collaborator
    • List public organization members
    • Remove public organization membership for the authenticated user
    • Check public organization membership for a user
    • Set public organization membership for the authenticated user
    • List security manager teams
    • Remove a security manager team
    • Add a security manager team
    • Enable or disable a security feature for an organization
    • List organization memberships for the authenticated user
    • Get an organization membership for the authenticated user
    • Update an organization membership for the authenticated user
    • List organizations for the authenticated user
    • List organizations for a user
  • actions
    • Get GitHub Actions cache usage for an organization
    • List repositories with GitHub Actions cache usage for an organization
    • Get GitHub Actions permissions for an organization
    • Set GitHub Actions permissions for an organization
    • List selected repositories enabled for GitHub Actions in an organization
    • Set selected repositories enabled for GitHub Actions in an organization
    • Disable a selected repository for GitHub Actions in an organization
    • Enable a selected repository for GitHub Actions in an organization
    • Get allowed actions and reusable workflows for an organization
    • List self-hosted runner groups for an organization
    • Set allowed actions and reusable workflows for an organization
    • Create a self-hosted runner group for an organization
    • Delete a self-hosted runner group from an organization
    • Get default workflow permissions for an organization
    • Get a self-hosted runner group for an organization
    • Set default workflow permissions for an organization
    • Update a self-hosted runner group for an organization
    • List required workflows
    • List repository access to a self-hosted runner group in an organization
    • Create a required workflow
    • Set repository access for a self-hosted runner group in an organization
    • Delete a required workflow
    • Remove repository access to a self-hosted runner group in an organization
    • Get a required workflow
    • Add repository access to a self-hosted runner group in an organization
    • Update a required workflow
    • List self-hosted runners in a group for an organization
    • List selected repositories for a required workflow
    • Set self-hosted runners in a group for an organization
    • Sets repositories for a required workflow
    • Remove a self-hosted runner from a group for an organization
    • Remove a selected repository from required workflow
    • Add a self-hosted runner to a group for an organization
    • Add a repository to a required workflow
    • List self-hosted runners for an organization
    • List runner applications for an organization
    • Create a registration token for an organization
    • Create a remove token for an organization
    • Delete a self-hosted runner from an organization
    • Get a self-hosted runner for an organization
    • Remove all custom labels from a self-hosted runner for an organization
    • List labels for a self-hosted runner for an organization
    • Add custom labels to a self-hosted runner for an organization
    • Set custom labels for a self-hosted runner for an organization
    • Remove a custom label from a self-hosted runner for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List organization variables
    • Create an organization variable
    • Delete an organization variable
    • Get an organization variable
    • Update an organization variable
    • List selected repositories for an organization variable
    • Set selected repositories for an organization variable
    • Remove selected repository from an organization variable
    • Add selected repository to an organization variable
    • List repository required workflows
    • Get a required workflow entity for a repository
    • Get required workflow usage
    • List artifacts for a repository
    • Delete an artifact
    • Get an artifact
    • Download an artifact
    • Get GitHub Actions cache usage for a repository
    • Delete GitHub Actions caches for a repository (using a cache key)
    • List GitHub Actions caches for a repository
    • Delete a GitHub Actions cache for a repository (using a cache ID)
    • Get a job for a workflow run
    • Download job logs for a workflow run
    • Re-run a job from a workflow run
    • Get the customization template for an OIDC subject claim for a repository
    • Set the customization template for an OIDC subject claim for a repository
    • Get GitHub Actions permissions for a repository
    • Set GitHub Actions permissions for a repository
    • Get the level of access for workflows outside of the repository
    • Set the level of access for workflows outside of the repository
    • Get allowed actions and reusable workflows for a repository
    • Set allowed actions and reusable workflows for a repository
    • Get default workflow permissions for a repository
    • Set default workflow permissions for a repository
    • List workflow runs for a required workflow
    • List self-hosted runners for a repository
    • List runner applications for a repository
    • Create a registration token for a repository
    • Create a remove token for a repository
    • Delete a self-hosted runner from a repository
    • Get a self-hosted runner for a repository
    • Remove all custom labels from a self-hosted runner for a repository
    • List labels for a self-hosted runner for a repository
    • Add custom labels to a self-hosted runner for a repository
    • Set custom labels for a self-hosted runner for a repository
    • Remove a custom label from a self-hosted runner for a repository
    • List workflow runs for a repository
    • Delete a workflow run
    • Get a workflow run
    • Get the review history for a workflow run
    • Approve a workflow run for a fork pull request
    • List workflow run artifacts
    • Get a workflow run attempt
    • List jobs for a workflow run attempt
    • Download workflow run attempt logs
    • Cancel a workflow run
    • List jobs for a workflow run
    • Delete workflow run logs
    • Download workflow run logs
    • Get pending deployments for a workflow run
    • Review pending deployments for a workflow run
    • Re-run a workflow
    • Re-run failed jobs from a workflow run
    • Get workflow run usage
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
    • List repository variables
    • Create a repository variable
    • Delete a repository variable
    • Get a repository variable
    • Update a repository variable
    • List repository workflows
    • Get a workflow
    • Disable a workflow
    • Create a workflow dispatch event
    • Enable a workflow
    • List workflow runs for a workflow
    • Get workflow usage
    • List environment secrets
    • Get an environment public key
    • Delete an environment secret
    • Get an environment secret
    • Create or update an environment secret
    • List environment variables
    • Create an environment variable
    • Delete an environment variable
    • Get an environment variable
    • Update an environment variable
  • interactions
    • Remove interaction restrictions for an organization
    • Get interaction restrictions for an organization
    • Set interaction restrictions for an organization
    • Remove interaction restrictions for a repository
    • Get interaction restrictions for a repository
    • Set interaction restrictions for a repository
    • Remove interaction restrictions from your public repositories
    • Get interaction restrictions for your public repositories
    • Set interaction restrictions for your public repositories
  • migrations
    • List organization migrations
    • Start an organization migration
    • Get an organization migration status
    • Delete an organization migration archive
    • Download an organization migration archive
    • Unlock an organization repository
    • List repositories in an organization migration
    • Cancel an import
    • Get an import status
    • Update an import
    • Start an import
    • Get commit authors
    • Map a commit author
    • Get large files
    • Update Git LFS preference
    • List user migrations
    • Start a user migration
    • Get a user migration status
    • Delete a user migration archive
    • Download a user migration archive
    • Unlock a user repository
    • List repositories for a user migration
  • packages
    • List packages for an organization
    • Delete a package for an organization
    • Get a package for an organization
    • Restore a package for an organization
    • List package versions for a package owned by an organization
    • Delete package version for an organization
    • Get a package version for an organization
    • Restore package version for an organization
    • List packages for the authenticated user's namespace
    • Delete a package for the authenticated user
    • Get a package for the authenticated user
    • Restore a package for the authenticated user
    • List package versions for a package owned by the authenticated user
    • Delete a package version for the authenticated user
    • Get a package version for the authenticated user
    • Restore a package version for the authenticated user
    • List packages for a user
    • Delete a package for a user
    • Get a package for a user
    • Restore a package for a user
    • List package versions for a package owned by a user
    • Delete package version for a user
    • Get a package version for a user
    • Restore package version for a user
  • projects
    • List organization projects
    • Create an organization project
    • Delete a project card
    • Get a project card
    • Update an existing project card
    • Move a project card
    • Delete a project column
    • Get a project column
    • Update an existing project column
    • List project cards
    • Create a project card
    • Move a project column
    • Delete a project
    • Get a project
    • Update a project
    • List project collaborators
    • Remove user as a collaborator
    • Add project collaborator
    • Get project permission for a user
    • List project columns
    • Create a project column
    • List repository projects
    • Create a repository project
    • Create a user project
    • List user projects
  • repos
    • List organization repositories
      GET
    • Create an organization repository
      POST
    • Delete a repository
      DELETE
    • Get a repository
      GET
    • Update a repository
      PATCH
    • List all autolinks of a repository
      GET
    • Create an autolink reference for a repository
      POST
    • Delete an autolink reference from a repository
      DELETE
    • Get an autolink reference of a repository
      GET
    • Disable automated security fixes
      DELETE
    • Enable automated security fixes
      PUT
    • List branches
      GET
    • Get a branch
      GET
    • Delete branch protection
      DELETE
    • Get branch protection
      GET
    • Update branch protection
      PUT
    • Delete admin branch protection
      DELETE
    • Get admin branch protection
      GET
    • Set admin branch protection
      POST
    • Delete pull request review protection
      DELETE
    • Get pull request review protection
      GET
    • Update pull request review protection
      PATCH
    • Delete commit signature protection
      DELETE
    • Get commit signature protection
      GET
    • Create commit signature protection
      POST
    • Remove status check protection
      DELETE
    • Get status checks protection
      GET
    • Update status check protection
      PATCH
    • Remove status check contexts
      DELETE
    • Get all status check contexts
      GET
    • Add status check contexts
      POST
    • Set status check contexts
      PUT
    • Delete access restrictions
      DELETE
    • Get access restrictions
      GET
    • Remove app access restrictions
      DELETE
    • Get apps with access to the protected branch
      GET
    • Add app access restrictions
      POST
    • Set app access restrictions
      PUT
    • Remove team access restrictions
      DELETE
    • Get teams with access to the protected branch
      GET
    • Add team access restrictions
      POST
    • Set team access restrictions
      PUT
    • Remove user access restrictions
      DELETE
    • Get users with access to the protected branch
      GET
    • Add user access restrictions
      POST
    • Set user access restrictions
      PUT
    • Rename a branch
      POST
    • List CODEOWNERS errors
      GET
    • List repository collaborators
      GET
    • Remove a repository collaborator
      DELETE
    • Check if a user is a repository collaborator
      GET
    • Add a repository collaborator
      PUT
    • Get repository permissions for a user
      GET
    • List commit comments for a repository
      GET
    • Delete a commit comment
      DELETE
    • Get a commit comment
      GET
    • Update a commit comment
      PATCH
    • List commits
      GET
    • List branches for HEAD commit
      GET
    • List commit comments
      GET
    • Create a commit comment
      POST
    • List pull requests associated with a commit
      GET
    • Compare two commits
      GET
    • Get a commit
      GET
    • Get the combined status for a specific reference
      GET
    • List commit statuses for a reference
      GET
    • Get community profile metrics
      GET
    • Compare two commits
      GET
    • Delete a file
      DELETE
    • Get repository content
      GET
    • Create or update file contents
      PUT
    • List repository contributors
      GET
    • List deployments
      GET
    • Create a deployment
      POST
    • Delete a deployment
      DELETE
    • Get a deployment
      GET
    • List deployment statuses
      GET
    • Create a deployment status
      POST
    • Get a deployment status
      GET
    • Create a repository dispatch event
      POST
    • List environments
      GET
    • Delete an environment
      DELETE
    • Get an environment
      GET
    • Create or update an environment
      PUT
    • List deployment branch policies
      GET
    • Create a deployment branch policy
      POST
    • Delete a deployment branch policy
      DELETE
    • Get a deployment branch policy
      GET
    • Update a deployment branch policy
      PUT
    • List forks
      GET
    • Create a fork
      POST
    • List repository webhooks
      GET
    • Create a repository webhook
      POST
    • Delete a repository webhook
      DELETE
    • Get a repository webhook
      GET
    • Update a repository webhook
      PATCH
    • Get a webhook configuration for a repository
      GET
    • Update a webhook configuration for a repository
      PATCH
    • List deliveries for a repository webhook
      GET
    • Get a delivery for a repository webhook
      GET
    • Redeliver a delivery for a repository webhook
      POST
    • Ping a repository webhook
      POST
    • Test the push repository webhook
      POST
    • List repository invitations
      GET
    • Delete a repository invitation
      DELETE
    • Update a repository invitation
      PATCH
    • List deploy keys
      GET
    • Create a deploy key
      POST
    • Delete a deploy key
      DELETE
    • Get a deploy key
      GET
    • List repository languages
      GET
    • Disable Git LFS for a repository
      DELETE
    • Enable Git LFS for a repository
      PUT
    • Sync a fork branch with the upstream repository
      POST
    • Merge a branch
      POST
    • Delete a GitHub Pages site
      DELETE
    • Get a GitHub Pages site
      GET
    • Create a GitHub Pages site
      POST
    • Update information about a GitHub Pages site
      PUT
    • List GitHub Pages builds
      GET
    • Request a GitHub Pages build
      POST
    • Get latest Pages build
      GET
    • Get GitHub Pages build
      GET
    • Create a GitHub Pages deployment
      POST
    • Get a DNS health check for GitHub Pages
      GET
    • Get a repository README
      GET
    • Get a repository README for a directory
      GET
    • List releases
      GET
    • Create a release
      POST
    • Delete a release asset
      DELETE
    • Get a release asset
      GET
    • Update a release asset
      PATCH
    • Generate release notes content for a release
      POST
    • Get the latest release
      GET
    • Get a release by tag name
      GET
    • Delete a release
      DELETE
    • Get a release
      GET
    • Update a release
      PATCH
    • List release assets
      GET
    • Upload a release asset
      POST
    • Get the weekly commit activity
      GET
    • Get the last year of commit activity
      GET
    • Get all contributor commit activity
      GET
    • Get the weekly commit count
      GET
    • Get the hourly commit count for each day
      GET
    • Create a commit status
      POST
    • List repository tags
      GET
    • List tag protection states for a repository
      GET
    • Create a tag protection state for a repository
      POST
    • Delete a tag protection state for a repository
      DELETE
    • Download a repository archive (tar)
      GET
    • List repository teams
      GET
    • Get all repository topics
      GET
    • Replace all repository topics
      PUT
    • Get repository clones
      GET
    • Get top referral paths
      GET
    • Get top referral sources
      GET
    • Get page views
      GET
    • Transfer a repository
      POST
    • Disable vulnerability alerts
      DELETE
    • Check if vulnerability alerts are enabled for a repository
      GET
    • Enable vulnerability alerts
      PUT
    • Download a repository archive (zip)
      GET
    • Create a repository using a template
      POST
    • List public repositories
      GET
    • List repositories for the authenticated user
      GET
    • Create a repository for the authenticated user
      POST
    • List repository invitations for the authenticated user
      GET
    • Decline a repository invitation
      DELETE
    • Accept a repository invitation
      PATCH
    • List repositories for a user
      GET
  • teams
    • List IdP groups for an organization
    • List teams
    • Create a team
    • Delete a team
    • Get a team by name
    • Update a team
    • List discussions
    • Create a discussion
    • Delete a discussion
    • Get a discussion
    • Update a discussion
    • List discussion comments
    • Create a discussion comment
    • Delete a discussion comment
    • Get a discussion comment
    • Update a discussion comment
    • List pending team invitations
    • List team members
    • Remove team membership for a user
    • Get team membership for a user
    • Add or update team membership for a user
    • List team projects
    • Remove a project from a team
    • Check team permissions for a project
    • Add or update team project permissions
    • List team repositories
    • Remove a repository from a team
    • Check team permissions for a repository
    • Add or update team repository permissions
    • List child teams
    • List IdP groups for a team
    • Delete a team (Legacy)
    • Get a team (Legacy)
    • Create or update IdP group connections
    • Update a team (Legacy)
    • List discussions (Legacy)
    • Create a discussion (Legacy)
    • Delete a discussion (Legacy)
    • Get a discussion (Legacy)
    • Update a discussion (Legacy)
    • List discussion comments (Legacy)
    • Create a discussion comment (Legacy)
    • Delete a discussion comment (Legacy)
    • Get a discussion comment (Legacy)
    • Update a discussion comment (Legacy)
    • List pending team invitations (Legacy)
    • List team members (Legacy)
    • Remove team member (Legacy)
    • Get team member (Legacy)
    • Add team member (Legacy)
    • Remove team membership for a user (Legacy)
    • Get team membership for a user (Legacy)
    • Add or update team membership for a user (Legacy)
    • List team projects (Legacy)
    • Remove a project from a team (Legacy)
    • Check team permissions for a project (Legacy)
    • Add or update team project permissions (Legacy)
    • List team repositories (Legacy)
    • Remove a repository from a team (Legacy)
    • Check team permissions for a repository (Legacy)
    • Add or update team repository permissions (Legacy)
    • List child teams (Legacy)
    • List teams for the authenticated user
    • List IdP groups for a team (Legacy)
    • Create or update IdP group connections (Legacy)
  • reactions
    • List reactions for a team discussion comment
    • Create reaction for a team discussion comment
    • Delete team discussion comment reaction
    • List reactions for a team discussion
    • Create reaction for a team discussion
    • Delete team discussion reaction
    • Delete a reaction (Legacy)
    • List reactions for a commit comment
    • Create reaction for a commit comment
    • Delete a commit comment reaction
    • List reactions for an issue comment
    • Create reaction for an issue comment
    • Delete an issue comment reaction
    • List reactions for an issue
    • Create reaction for an issue
    • Delete an issue reaction
    • List reactions for a pull request review comment
    • Create reaction for a pull request review comment
    • Delete a pull request comment reaction
    • List reactions for a release
    • Create reaction for a release
    • Delete a release reaction
    • List reactions for a team discussion comment (Legacy)
    • Create reaction for a team discussion comment (Legacy)
    • List reactions for a team discussion (Legacy)
    • Create reaction for a team discussion (Legacy)
  • rate-limit
    • Get rate limit status for the authenticated user
  • checks
    • Create a check run
    • Get a check run
    • Update a check run
    • List check run annotations
    • Rerequest a check run
    • Create a check suite
    • Update repository preferences for check suites
    • Get a check suite
    • List check runs in a check suite
    • Rerequest a check suite
    • List check runs for a Git reference
    • List check suites for a Git reference
  • code-scanning
    • List code scanning alerts for an organization
    • List code scanning alerts for a repository
    • Get a code scanning alert
    • Update a code scanning alert
    • List instances of a code scanning alert
    • List code scanning analyses for a repository
    • Delete a code scanning analysis from a repository
    • Get a code scanning analysis for a repository
    • List CodeQL databases for a repository
    • Get a CodeQL database for a repository
    • Upload an analysis as SARIF data
    • Get information about a SARIF upload
  • git
    • Create a blob
    • Get a blob
    • Create a commit
    • Get a commit
    • List matching references
    • Get a reference
    • Create a reference
    • Delete a reference
    • Update a reference
    • Create a tag object
    • Get a tag
    • Create a tree
    • Get a tree
  • pulls
    • List pull requests
    • Create a pull request
    • List review comments in a repository
    • Delete a review comment for a pull request
    • Get a review comment for a pull request
    • Update a review comment for a pull request
    • Get a pull request
    • Update a pull request
    • List review comments on a pull request
    • Create a review comment for a pull request
    • Create a reply for a review comment
    • List commits on a pull request
    • List pull requests files
    • Check if a pull request has been merged
    • Merge a pull request
    • Remove requested reviewers from a pull request
    • Get all requested reviewers for a pull request
    • Request reviewers for a pull request
    • List reviews for a pull request
    • Create a review for a pull request
    • Delete a pending review for a pull request
    • Get a review for a pull request
    • Update a review for a pull request
    • List comments for a pull request review
    • Dismiss a review for a pull request
    • Submit a review for a pull request
    • Update a pull request branch
  • secret-scanning
    • List secret scanning alerts for an enterprise
    • List secret scanning alerts for an organization
    • List secret scanning alerts for a repository
    • Get a secret scanning alert
    • Update a secret scanning alert
    • List locations for a secret scanning alert
  • scim
    • List SCIM provisioned identities
    • Provision and invite a SCIM user
    • Delete a SCIM user from an organization
    • Get SCIM provisioning information for a user
    • Update an attribute for a SCIM user
    • Update a provisioned organization membership
  • search
    • Search code
    • Search commits
    • Search issues and pull requests
    • Search labels
    • Search repositories
    • Search topics
    • Search users
  • users
    • Get the authenticated user
    • Update the authenticated user
    • List users blocked by the authenticated user
    • Unblock a user
    • Check if a user is blocked by the authenticated user
    • Block a user
    • Set primary email visibility for the authenticated user
    • Delete an email address for the authenticated user
    • List email addresses for the authenticated user
    • Add an email address for the authenticated user
    • List followers of the authenticated user
    • List the people the authenticated user follows
    • Unfollow a user
    • Check if a person is followed by the authenticated user
    • Follow a user
    • List GPG keys for the authenticated user
    • Create a GPG key for the authenticated user
    • Delete a GPG key for the authenticated user
    • Get a GPG key for the authenticated user
    • List public SSH keys for the authenticated user
    • Create a public SSH key for the authenticated user
    • Delete a public SSH key for the authenticated user
    • Get a public SSH key for the authenticated user
    • List public email addresses for the authenticated user
    • List SSH signing keys for the authenticated user
    • Create a SSH signing key for the authenticated user
    • Delete an SSH signing key for the authenticated user
    • Get an SSH signing key for the authenticated user
    • List users
    • Get a user
    • List followers of a user
    • List the people a user follows
    • Check if a user follows another user
    • List GPG keys for a user
    • Get contextual information for a user
    • List public keys for a user
    • List SSH signing keys for a user
  • dependabot
    • List Dependabot alerts for an enterprise
    • List Dependabot alerts for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List Dependabot alerts for a repository
    • Get a Dependabot alert
    • Update a Dependabot alert
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
  • oidc
    • Get the customization template for an OIDC subject claim for an organization
    • Set the customization template for an OIDC subject claim for an organization
  • codespaces
    • List codespaces for the organization
    • Manage access control for organization codespaces
    • Removes users from Codespaces billing for an organization
    • Add users to Codespaces billing for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List codespaces for a user in organization
    • Delete a codespace from the organization
    • Stop a codespace for an organization user
    • List codespaces in a repository for the authenticated user
    • Create a codespace in a repository
    • List devcontainer configurations in a repository for the authenticated user
    • List available machine types for a repository
    • Get default attributes for a codespace
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
    • Create a codespace from a pull request
    • List codespaces for the authenticated user
    • Create a codespace for the authenticated user
    • List secrets for the authenticated user
    • Get public key for the authenticated user
    • Delete a secret for the authenticated user
    • Get a secret for the authenticated user
    • Create or update a secret for the authenticated user
    • List selected repositories for a user secret
    • Set selected repositories for a user secret
    • Remove a selected repository from a user secret
    • Add a selected repository to a user secret
    • Delete a codespace for the authenticated user
    • Get a codespace for the authenticated user
    • Update a codespace for the authenticated user
    • Export a codespace for the authenticated user
    • Get details about a codespace export
    • List machine types for a codespace
    • Create a repository from an unpublished codespace
    • Start a codespace for the authenticated user
    • Stop a codespace for the authenticated user
  • dependency-graph
    • Get a diff of the dependencies between commits
    • Create a snapshot of dependencies for a repository
  1. repos

Get a DNS health check for GitHub Pages

GET
/repos/{owner}/{repo}/pages/health
Gets a health check of the DNS settings for the CNAME record configured for a repository's GitHub Pages.
The first request to this endpoint returns a 202 Accepted status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a 200 OK status with the health check results in the response.
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the repo scope or Pages write permission is required. GitHub Apps must have the administrative:write and pages:write permissions.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.github.com/repos///pages/health'
Response Response Example
200 - Example 1
{
    "alt_domain": {
        "caa_error": "string",
        "dns_resolves": true,
        "enforces_https": true,
        "has_cname_record": true,
        "has_mx_records_present": true,
        "host": "string",
        "https_error": "string",
        "is_a_record": true,
        "is_apex_domain": true,
        "is_cloudflare_ip": true,
        "is_cname_to_fastly": true,
        "is_cname_to_github_user_domain": true,
        "is_cname_to_pages_dot_github_dot_com": true,
        "is_fastly_ip": true,
        "is_https_eligible": true,
        "is_non_github_pages_ip_present": true,
        "is_old_ip_address": true,
        "is_pages_domain": true,
        "is_pointed_to_github_pages_ip": true,
        "is_proxied": true,
        "is_served_by_pages": true,
        "is_valid": true,
        "is_valid_domain": true,
        "nameservers": "string",
        "reason": "string",
        "responds_to_https": true,
        "should_be_a_record": true,
        "uri": "string"
    },
    "domain": {
        "caa_error": "string",
        "dns_resolves": true,
        "enforces_https": true,
        "has_cname_record": true,
        "has_mx_records_present": true,
        "host": "string",
        "https_error": "string",
        "is_a_record": true,
        "is_apex_domain": true,
        "is_cloudflare_ip": true,
        "is_cname_to_fastly": true,
        "is_cname_to_github_user_domain": true,
        "is_cname_to_pages_dot_github_dot_com": true,
        "is_fastly_ip": true,
        "is_https_eligible": true,
        "is_non_github_pages_ip_present": true,
        "is_old_ip_address": true,
        "is_pages_domain": true,
        "is_pointed_to_github_pages_ip": true,
        "is_proxied": true,
        "is_served_by_pages": true,
        "is_valid": true,
        "is_valid_domain": true,
        "nameservers": "string",
        "reason": "string",
        "responds_to_https": true,
        "should_be_a_record": true,
        "uri": "string"
    }
}

Request

Path Params
owner
string 
required
The account owner of the repository. The name is not case sensitive.
repo
string 
required
The name of the repository. The name is not case sensitive.

Responses

🟢200Response
application/json
Body
Pages Health Check Status
alt_domain
object  | null 
optional
caa_error
string  | null 
optional
dns_resolves
boolean 
optional
enforces_https
boolean 
optional
has_cname_record
boolean  | null 
optional
has_mx_records_present
boolean  | null 
optional
host
string 
optional
https_error
string  | null 
optional
is_a_record
boolean  | null 
optional
is_apex_domain
boolean 
optional
is_cloudflare_ip
boolean  | null 
optional
is_cname_to_fastly
boolean  | null 
optional
is_cname_to_github_user_domain
boolean  | null 
optional
is_cname_to_pages_dot_github_dot_com
boolean  | null 
optional
is_fastly_ip
boolean  | null 
optional
is_https_eligible
boolean  | null 
optional
is_non_github_pages_ip_present
boolean  | null 
optional
is_old_ip_address
boolean  | null 
optional
is_pages_domain
boolean 
optional
is_pointed_to_github_pages_ip
boolean  | null 
optional
is_proxied
boolean  | null 
optional
is_served_by_pages
boolean  | null 
optional
is_valid
boolean 
optional
is_valid_domain
boolean 
optional
nameservers
string 
optional
reason
string  | null 
optional
responds_to_https
boolean 
optional
should_be_a_record
boolean  | null 
optional
uri
string 
optional
domain
object 
optional
caa_error
string  | null 
optional
dns_resolves
boolean 
optional
enforces_https
boolean 
optional
has_cname_record
boolean  | null 
optional
has_mx_records_present
boolean  | null 
optional
host
string 
optional
https_error
string  | null 
optional
is_a_record
boolean  | null 
optional
is_apex_domain
boolean 
optional
is_cloudflare_ip
boolean  | null 
optional
is_cname_to_fastly
boolean  | null 
optional
is_cname_to_github_user_domain
boolean  | null 
optional
is_cname_to_pages_dot_github_dot_com
boolean  | null 
optional
is_fastly_ip
boolean  | null 
optional
is_https_eligible
boolean  | null 
optional
is_non_github_pages_ip_present
boolean  | null 
optional
is_old_ip_address
boolean  | null 
optional
is_pages_domain
boolean 
optional
is_pointed_to_github_pages_ip
boolean  | null 
optional
is_proxied
boolean  | null 
optional
is_served_by_pages
boolean  | null 
optional
is_valid
boolean 
optional
is_valid_domain
boolean 
optional
nameservers
string 
optional
reason
string  | null 
optional
responds_to_https
boolean 
optional
should_be_a_record
boolean  | null 
optional
uri
string 
optional
🟢202Empty response
🟠400Custom domains are not available for GitHub Pages
🟠404404
🟠422There isn't a CNAME for this page
Modified at 2023-08-15 02:59:24
Previous
Create a GitHub Pages deployment
Next
Get a repository README
Built with