Octokit Rest API

Accept a repository invitation

octokit.repos.acceptInvitation({
  invitation_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Add app access restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

octokit.repos.addAppAccessRestrictions({
  owner,
  repo,
  branch,
  apps,
});

Parameters

See also: GitHub Developer Guide documentation.

Add a repository collaborator

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

For more information the permission levels, see "Repository permission levels for an organization".

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

Rate limits

To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

octokit.repos.addCollaborator({
  owner,
  repo,
  username,
});

Parameters

See also: GitHub Developer Guide documentation.

Add status check contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.addStatusCheckContexts({
  owner,
  repo,
  branch,
  contexts,
});

Parameters

See also: GitHub Developer Guide documentation.

Add team access restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams.

octokit.repos.addTeamAccessRestrictions({
  owner,
  repo,
  branch,
  teams,
});

Parameters

See also: GitHub Developer Guide documentation.

Add user access restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Grants the specified people push access for this branch.

octokit.repos.addUserAccessRestrictions({
  owner,
  repo,
  branch,
  users,
});

Parameters

See also: GitHub Developer Guide documentation.

Check if a user is a repository collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

octokit.repos.checkCollaborator({
  owner,
  repo,
  username,
});

Parameters

See also: GitHub Developer Guide documentation.

Check if vulnerability alerts are enabled for a repository

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

octokit.repos.checkVulnerabilityAlerts({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Compare two commits

Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.

The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.

The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

Working with large comparisons

The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.

For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.

Signature verification object

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

These are the possible values for reason in the verification object:

octokit.repos.compareCommits({
  owner,
  repo,
  base,
  head,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a commit comment

Create a comment for a commit using its :commit_sha.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.repos.createCommitComment({
  owner,
  repo,
  commit_sha,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.

Create commit signature protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

octokit.repos.createCommitSignatureProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a commit status

Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

octokit.repos.createCommitStatus({
  owner,
  repo,
  sha,
  state,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a deploy key

You can create a read-only deploy key.

octokit.repos.createDeployKey({
  owner,
  repo,
  key,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a deployment

Deployments offer a few configurable parameters with certain defaults.

The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.

The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production.

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.

By default, commit statuses for every submitted context must be in a successstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.

The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.

Users with repo or repo_deployment scopes can create a deployment for a given ref.

Merged branch response

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:

• Auto-merge option is enabled in the repository
• Topic branch does not include the latest changes on the base branch, which is master in the response example
• There are no merge conflicts

If there are no new commits in the base branch, a new request to create a deployment should give a successful response.

Merge conflict response

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't be merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

Failed commit status checks

This error happens when the required_contexts parameter indicates that one or more contexts need to have a successstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

octokit.repos.createDeployment({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a deployment status

Users with push access can create deployment statuses for a given deployment.

GitHub Apps require read & write access to "Deployments" and read-only access to "Repo contents" (for private repos). OAuth Apps require the repo_deployment scope.

octokit.repos.createDeploymentStatus({
  owner,
  repo,
  deployment_id,
  state,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a repository dispatch event

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

This endpoint requires write access to the repository by providing either:

• Personal access tokens with repo scope. For more information, see "Creating a personal access token for the command line" in the GitHub Help documentation.
• GitHub Apps with both metadata:read and contents:read&write permissions.

This input example shows how you can use the client_payload as a test to debug your workflow.

octokit.repos.createDispatchEvent({
  owner,
  repo,
  event_type,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a repository for the authenticated user

Creates a new repository for the authenticated user.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository
• repo scope to create a private repository

octokit.repos.createForAuthenticatedUser({
  name,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a fork

Create a fork for the authenticated user.

Note: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support or GitHub Premium Support.

octokit.repos.createFork({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Create an organization repository

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository
• repo scope to create a private repository

octokit.repos.createInOrg({
  org,
  name,
});

Parameters

See also: GitHub Developer Guide documentation.

Create or update file contents

Creates a new file or replaces an existing file in a repository.

octokit.repos.createOrUpdateFileContents({
        owner,
repo,
path,
message,
content,
committer.name,
committer.email,
author.name,
author.email
      })

Parameters

See also: GitHub Developer Guide documentation.

Create a GitHub Pages site

Configures a GitHub Pages site. For more information, see "About GitHub Pages."

octokit.repos.createPagesSite({
        owner,
repo,
source,
source.branch
      })

Parameters

See also: GitHub Developer Guide documentation.

Create a release

Users with push access to the repository can create a release.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.repos.createRelease({
  owner,
  repo,
  tag_name,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a repository using a template

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

OAuth scope requirements

When using OAuth, authorizations must include:

• public_repo scope or repo scope to create a public repository
• repo scope to create a private repository

octokit.repos.createUsingTemplate({
  template_owner,
  template_repo,
  name,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a repository webhook

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

octokit.repos.createWebhook({
        owner,
repo,
config,
config.url
      })

Parameters

See also: GitHub Developer Guide documentation.

Decline a repository invitation

octokit.repos.declineInvitation({
  invitation_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a repository

Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a 403 Forbidden response.

octokit.repos.delete({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete access restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch.

octokit.repos.deleteAccessRestrictions({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete admin branch protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

octokit.repos.deleteAdminBranchProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete branch protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.deleteBranchProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a commit comment

octokit.repos.deleteCommitComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete commit signature protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

octokit.repos.deleteCommitSignatureProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a deploy key

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

octokit.repos.deleteDeployKey({
  owner,
  repo,
  key_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a deployment

To ensure there can always be an active deployment, you can only delete an inactive deployment. Anyone with repo or repo_deployment scopes can delete an inactive deployment.

To set a deployment as inactive, you must:

• Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
• Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "Create a deployment" and "Create a deployment status."

octokit.repos.deleteDeployment({
  owner,
  repo,
  deployment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a file

Deletes a file in a repository.

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

octokit.repos.deleteFile({
  owner,
  repo,
  path,
  message,
  sha,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a repository invitation

octokit.repos.deleteInvitation({
  owner,
  repo,
  invitation_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a GitHub Pages site

octokit.repos.deletePagesSite({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete pull request review protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.deletePullRequestReviewProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a release

Users with push access to the repository can delete a release.

octokit.repos.deleteRelease({
  owner,
  repo,
  release_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a release asset

octokit.repos.deleteReleaseAsset({
  owner,
  repo,
  asset_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a repository webhook

octokit.repos.deleteWebhook({
  owner,
  repo,
  hook_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Disable automated security fixes

Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes".

octokit.repos.disableAutomatedSecurityFixes({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Disable vulnerability alerts

Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

octokit.repos.disableVulnerabilityAlerts({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Download a repository archive (zip)

Deprecated: This method has been renamed to repos.downloadZipballArchive

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usuallymaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.Note: For private repositories, these links are temporary and expire after five minutes.

octokit.repos.downloadArchive({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Download a repository archive (tar)

Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usuallymaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.Note: For private repositories, these links are temporary and expire after five minutes.

octokit.repos.downloadTarballArchive({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Download a repository archive (zip)

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usuallymaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.Note: For private repositories, these links are temporary and expire after five minutes.

octokit.repos.downloadZipballArchive({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Enable automated security fixes

Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes".

octokit.repos.enableAutomatedSecurityFixes({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Enable vulnerability alerts

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

octokit.repos.enableVulnerabilityAlerts({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a repository

When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

octokit.repos.get({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get access restrictions

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Lists who has access to this protected branch.

Note: Users, apps, and teams restrictions are only available for organization-owned repositories.

octokit.repos.getAccessRestrictions({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get admin branch protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.getAdminBranchProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get all status check contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.getAllStatusCheckContexts({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get all repository topics

octokit.repos.getAllTopics({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get apps with access to the protected branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

octokit.repos.getAppsWithAccessToProtectedBranch({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a branch

octokit.repos.getBranch({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get branch protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.getBranchProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get repository clones

Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

octokit.repos.getClones({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the weekly commit activity

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

octokit.repos.getCodeFrequencyStats({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get repository permissions for a user

Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.

octokit.repos.getCollaboratorPermissionLevel({
  owner,
  repo,
  username,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the combined status for a specific reference

Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

The most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.

Additionally, a combined state is returned. The state is one of:

• failure if any of the contexts report as error or failure
• pending if there are no statuses or a context is pending
• success if the latest status for all contexts is success

octokit.repos.getCombinedStatusForRef({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a commit

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

Signature verification object

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

These are the possible values for reason in the verification object:

octokit.repos.getCommit({
  owner,
  repo,
  ref,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the last year of commit activity

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

octokit.repos.getCommitActivityStats({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a commit comment

octokit.repos.getCommitComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get commit signature protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

Note: You must enable branch protection to require signed commits.

octokit.repos.getCommitSignatureProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get community profile metrics

This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.

The health_percentage score is defined as a percentage of how many of these four documents are present: README, CONTRIBUTING, LICENSE, and CODE_OF_CONDUCT. For example, if all four documents are present, then the health_percentage is 100. If only one is present, then thehealth_percentage is 25.

content_reports_enabled is only returned for organization-owned repositories.

octokit.repos.getCommunityProfileMetrics({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get repository content

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

Files and symlinks support a custom media type for retrieving the raw content or rendered HTML (when supported). All content types support a custom media type to ensure the content is returned in a consistent object format.

Note:

• To get a repository's contents recursively, you can recursively get the tree.
• This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API.
• This API supports files up to 1 megabyte in size.

If the content is a directory

The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the valueshould be "submodule". This behavior exists in API v3 for backwards compatibility purposes. In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values.

octokit.repos.getContent({
  owner,
  repo,
  path,
});

Parameters

See also: GitHub Developer Guide documentation.

Get all contributor commit activity

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

• w - Start of the week, given as a Unix timestamp.
• a - Number of additions
• d - Number of deletions
• c - Number of commits

octokit.repos.getContributorsStats({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a deploy key

octokit.repos.getDeployKey({
  owner,
  repo,
  key_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a deployment

octokit.repos.getDeployment({
  owner,
  repo,
  deployment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a deployment status

Users with pull access can view a deployment status for a deployment:

octokit.repos.getDeploymentStatus({
  owner,
  repo,
  deployment_id,
  status_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get latest Pages build

octokit.repos.getLatestPagesBuild({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the latest release

View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

octokit.repos.getLatestRelease({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a GitHub Pages site

octokit.repos.getPages({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get GitHub Pages build

octokit.repos.getPagesBuild({
  owner,
  repo,
  build_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the weekly commit count

Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

The array order is oldest week (index 0) to most recent week.

octokit.repos.getParticipationStats({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get pull request review protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.getPullRequestReviewProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get the hourly commit count for each day

Each array contains the day number, hour number, and number of commits:

• 0-6: Sunday - Saturday
• 0-23: Hour of day
• Number of commits

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

octokit.repos.getPunchCardStats({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a repository README

Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.

octokit.repos.getReadme({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a release

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

octokit.repos.getRelease({
  owner,
  repo,
  release_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a release asset

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

octokit.repos.getReleaseAsset({
  owner,
  repo,
  asset_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a release by tag name

Get a published release with the specified tag.

octokit.repos.getReleaseByTag({
  owner,
  repo,
  tag,
});

Parameters

See also: GitHub Developer Guide documentation.

Get status checks protection

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

octokit.repos.getStatusChecksProtection({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get teams with access to the protected branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams.

octokit.repos.getTeamsWithAccessToProtectedBranch({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get top referral paths

Get the top 10 popular contents over the last 14 days.

octokit.repos.getTopPaths({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get top referral sources

Get the top 10 referrers over the last 14 days.

octokit.repos.getTopReferrers({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get users with access to the protected branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Lists the people who have push access to this branch.

octokit.repos.getUsersWithAccessToProtectedBranch({
  owner,
  repo,
  branch,
});

Parameters

See also: GitHub Developer Guide documentation.

Get page views

Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

octokit.repos.getViews({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a repository webhook

Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."

octokit.repos.getWebhook({
  owner,
  repo,
  hook_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a webhook configuration for a repository

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use "Get a repository webhook."

Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.

octokit.repos.getWebhookConfigForRepo({
  owner,
  repo,
  hook_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List branches

octokit.repos.listBranches({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

List branches for HEAD commit

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

octokit.repos.listBranchesForHeadCommit({
  owner,
  repo,
  commit_sha,
});

Parameters

See also: GitHub Developer Guide documentation.

List repository collaborators

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

octokit.repos.listCollaborators({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

List commit comments

Use the :commit_sha to specify the commit that will have its comments listed.

octokit.repos.listCommentsForCommit({
  owner,
  repo,
  commit_sha,
});

Parameters

See also: GitHub Developer Guide documentation.

List commit comments for a repository

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

Comments are ordered by ascending ID.

octokit.repos.listCommitCommentsForRepo({
  owner,
  repo,
});

Parameters

See also: GitHub Developer Guide documentation.

List commits

Signature verification object

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

These are the possible values for reason in the verification object:

octokit.repos.listCommits({
  owner,
  repo,
});